Readme (#64)

add readme and long description for pypi

Author: sseliverstov

.github/ISSUE_TEMPLATE.md

@@ -33,9 +33,8 @@
 #### Please tell us about your environment:
 
 - Allure version:        2.1.0
-- Test framework:        [email protected]
-- Allure adaptor:        [email protected]
-- Generate report using: [email protected]
+- Test framework:        [email protected]
+- Allure adaptor:        [email protected]
 
 #### Other information 
 

README.md

@@ -0,0 +1,23 @@
+# Allure Python Integrations
+
+The repository contains adaptors for python-based test frameworks.
+Documentation is available [online](https://docs.qameta.io/allure/2.0/), also you can get help at
+[gitter chanel](https://gitter.im/allure-framework/allure-core)
+
+
+## Pytest
+Allure [pytest](http://pytest.org) integration. It's developed as pytest plugin and distributed via
+[pypi](https://pypi.python.org/pypi/allure-pytest)
+
+
+## Behave
+Allure [behave](http://pythonhosted.org/behave/) integration. Just external formatter that produce test results in
+allure2 format. This package is available on [pypi](https://pypi.python.org/pypi/allure-behave)
+
+
+## Allure python commons
+Common engine for all modules. It is useful for make integration with your homemade frameworks.
+
+
+## Allure python testing
+Just pack of hamcrest matchers for validation result in allure2 json format.

allure-behave/README.rst

@@ -0,0 +1,18 @@
+Allure Behave Formatter
+=======================
+
+- `Source <https://github.com/allure-framework/allure-python>`_
+
+- `Documentation <https://docs.qameta.io/allure/2.0/>`_
+
+- `Gitter <https://gitter.im/allure-framework/allure-core>`_
+
+
+Installation and Usage
+======================
+
+.. code:: bash
+
+    $ pip install allure-behave
+    $ behave -f allure_behave.formatter:AllureFormatter -o %allure_result_folder% ./features
+    $ allure serve %allure_result_folder%

allure-behave/setup.py

@@ -1,3 +1,4 @@
+import os
 from setuptools import setup
 
 PACKAGE = "allure-behave"
@@ -17,6 +18,10 @@
 ]
 
 
+def read(fname):
+    return open(os.path.join(os.path.dirname(__file__), fname)).read()
+
+
 def main():
     setup(
         name=PACKAGE,
@@ -28,6 +33,7 @@ def main():
         license="Apache-2.0",
         classifiers=classifiers,
         keywords="allure reporting behave",
+        long_description=read('README.rst'),
         packages=["allure_behave"],
         package_dir={"allure_behave": "src"},
         install_requires=install_requires

allure-pytest/README.md

@@ -0,0 +1,18 @@
+Allure Pytest Plugin
+====================
+
+- `Source <https://github.com/allure-framework/allure-python>`_
+
+- `Documentation <https://docs.qameta.io/allure/2.0/>`_
+
+- `Gitter <https://gitter.im/allure-framework/allure-core>`_
+
+
+Installation and Usage
+======================
+
+.. code:: bash
+
+    $ pip install allure-pytest
+    $ py.test --alluredir=%allure_result_folder% ./tests
+    $ allure serve %allure_result_folder%

allure-pytest/README.rst

@@ -1,3 +1,4 @@
+import os
 from setuptools import setup
 
 PACKAGE = "allure-pytest"
@@ -18,6 +19,10 @@
 ]
 
 
+def read(fname):
+    return open(os.path.join(os.path.dirname(__file__), fname)).read()
+
+
 def main():
     setup(
         name=PACKAGE,
@@ -29,6 +34,7 @@ def main():
         license="Apache-2.0",
         classifiers=classifiers,
         keywords="allure reporting pytest",
+        long_description=read('README.rst'),
         packages=["allure_pytest"],
         package_dir={"allure_pytest": "src"},
         entry_points={"pytest11": ["allure_pytest = allure_pytest.plugin"]},