Merge pull request #8 from krasoffski/docfixes

Update README file to rst format for pypi.python.org registry.

Author: avarabyeu

MANIFEST.in

@@ -1,2 +1,2 @@
 include MANIFEST.in
-include *.md
+include README.rst CONTRIBUTING.rst

README.md

@@ -0,0 +1,93 @@
+===================
+agent-python-pytest
+===================
+
+
+**Important:** this is draft version under development.
+
+Pytest plugin for reporting test results of Pytest to the 'Reportal Portal'.
+
+Usage
+-----
+
+Installation
+~~~~~~~~~~~~
+
+To install pytest plugin execute next command in a terminal:
+
+.. code-block:: bash
+
+    pip install pytest-reportportal
+
+
+Configuration
+~~~~~~~~~~~~~
+
+Prepare the config file :code:`pytest.ini` in root directory of tests or specify
+any one using pytest command line option:
+
+.. code-block:: bash
+
+    py.test -c config.cfg
+
+
+The :code:`pytest.ini` file should have next mandatory fields:
+
+- :code:`rp_uuid` - number could be found in the User profile section
+- :code:`rp_project` - name of project in Report Potal
+- :code:`rp_endpoint` - address of Report Portal Server
+
+Example of :code:`pytest.ini`:
+
+.. code-block:: text
+
+    [pytest]
+    rp_uuid = fb586627-32be-47dd-93c1-678873458a5f
+    rp_endpoint = http://192.168.1.10:8080
+    rp_project = user_personal
+    rp_launch_tags = 'PyTest' 'Smoke'
+
+Also launch tags could be added, but this parapmeter is not
+mandatory :code:`rp_launch_tags = 'PyTest' 'Report_Portal'`.
+
+
+Logging
+~~~~~~~
+
+For logging of the test item flow to Report Portal, please, use the python
+logging handler privided by plugin like bellow:
+
+.. code-block:: python
+
+    # Import Report Portal handler in the test module.
+    from pytest_reportportal import RPlogHandler
+    # Get logger.
+    logger = logging.getLogger()
+    # Create hanler, set log level add it to the logger.
+    rp_handler = RPlogHandler()
+    rp_handler.setLevel(logging.INFO)
+    logger.addHandler(rp_handler)
+    # In this case only INFO messages will be sent to the Report Portal.
+    def test_one(self):
+        logger.info("Case1. Step1")
+        x = "this"
+        logger.info("Case1. Step2")
+        assert 'h' in x
+
+
+Launching
+~~~~~~~~~
+
+To run test with Report Portal you need to specify neme of :code:`launch`:
+
+.. code-block:: bash
+
+    py.test ./tests --rp-launch AnyLaunchName
+
+
+Copyright Notice
+----------------
+
+Licensed under the GPLv3_ license (see the LICENSE file).
+
+.. _GPLv3:  https://www.gnu.org/licenses/quick-guide-gplv3.html

README.rst

@@ -1,2 +1,2 @@
 [metadata]
-description-file = README.md
+description-file = README.rst

setup.cfg

@@ -16,7 +16,7 @@ def read_file(fname):
     name="pytest-reportportal",
     version=version,
     description="Agent for Reproting results of tests to the Report Portal server",
-    long_description=read_file("README.md") + "\n\n",
+    long_description=read_file("README.rst") + "\n\n",
     author="Pavel Papou",
     author_email="[email protected]",
     url="https://github.com/reportportal/agent-python-pytest",