fix: linting issues (#8)

README.md

@@ -1,30 +1,36 @@
 
 # pytest-adf
 
-*ALPHA RELEASE*
+This is an *ALPHA RELEASE*
 
 pytest-adf is a [pytest](https://docs.pytest.org/en/stable/) plugin for writing Azure Data Factory integration tests. It is light-wrapper around the [Azure Data Factory Python SDK](https://azure.github.io/azure-sdk-for-python/ref/Data-Factory.html?highlight=datafactory).
 
 [![Build Status](https://dev.azure.com/devlacepub/pytest-adf/_apis/build/status/ci-cd?branchName=master)](https://dev.azure.com/devlacepub/pytest-adf/_build/latest?definitionId=10&branchName=master)
 
 ## Requirements
+
 You will need the following:
+
 - Python 3+
 
 ## Installation
+
 To install pytest-adf:
+
 ```python
 pip install pytest-adf
 ```
 
 ## Usage
 
 Here is a simple usage of the `adf_pipeline_run` fixture.
+
 ```python
 def test_pipeline_succeeded(adf_pipeline_run):
     this_run = adf_pipeline_run("my_pipeline", run_inputs={})
     assert this_run.status == "Succeeded"
 ```
+
 The `adf_pipeline_run` fixture provides a factory function that triggers a pipeline run when called. It will then block and poll the pipeline run till completion* before returning. Pipeline run completion is defined by the following status: "Succeeded", "TimedOut", "Failed", "Cancelled".
 
 For an example of how to use this in an overall Modern Data Warehouse solution as part of an automated Azure DevOps Release Pipeline, see [here](https://github.com/Azure-Samples/modern-data-warehouse-dataops/blob/master/e2e_samples/parking_sensors/tests/integrationtests) and [here](https://github.com/Azure-Samples/modern-data-warehouse-dataops/blob/master/e2e_samples/parking_sensors/devops/templates/jobs/integration-tests-job.yml). This is part of a [larger demo solution](https://github.com/Azure-Samples/modern-data-warehouse-dataops/tree/master/e2e_samples/parking_sensors) showcasing DataOps as applied to the Modern Data Warehouse architecture.
@@ -35,7 +41,8 @@ For additional usage information, see [caching pipeline runs](#Caching-pipeline-
 
 You need to provide pytest-adf with the necessary configuration to connect to your Azure Data Factory. You can provide it via Environment Variables or as pytest command line variables. Command line variables take precedence over Environment Variables.
 
-### Environment Variables:
+### Environment Variables
+
 - **AZ_SERVICE_PRINCIPAL_ID** - Azure AD Service Principal with rights to trigger a run in Data Factory (ei. Data Factory Contributor), if not provided the test will use AZ-Cli authentication
 - **AZ_SERVICE_PRINCIPAL_SECRET** - Password of Service Principal
 - **AZ_SERVICE_PRINCIPAL_TENANT_ID** - Azure AD Tenant ID of Service Principal
@@ -47,7 +54,9 @@ You need to provide pytest-adf with the necessary configuration to connect to yo
 For more information on how to create an Azure AD service principal, see [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal).
 
 ### pytest command-line
+
 Alternatively, you can pass these like so:
+
 ```
 pytest
     --sp_id=my_sp_id \
@@ -66,6 +75,7 @@ Because ADF pipelines can be expensive to run, the `adf_pipeline_run` fixture al
 To force a rerun with the same pipeline_name and cached_run_name, use `rerun=True`.
 
 For example:
+
 ```python
 # Call adf_pipeline_run specifying cached_run_name variable.
 this_first_run = adf_pipeline_run(pipeline_name="pipeline_foo", run_inputs={}, cached_run_name="run_bar")
@@ -82,7 +92,6 @@ this_first_run != this_third_run  # False
 
 ```
 
-
 ## Contributing
 
 This project welcomes contributions and suggestions.  Most contributions require you to agree to a
@@ -95,4 +104,4 @@ provided by the bot. You will only need to do this once across all repos using o
 
 This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
 For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
-contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

setup.py

@@ -23,7 +23,7 @@ def read(fname):
     license='MIT',
     url='https://github.com/devlace/pytest-adf',
     description='Pytest plugin for writing Azure Data Factory integration tests',
-    # long_description=read('README.rst'),
+    long_description=read('README.rst'),
     packages=find_packages(where="src"),
     package_dir={"": "src"},
     python_requires='>=3.5',