configure to prepare for PyPI release

Author: BurnzZ

.codecov.yml

@@ -0,0 +1,6 @@
+comment:
+  layout: "header, diff, tree"
+
+coverage:
+  status:
+    project: false

.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: publish
+
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      if: startsWith(github.ref, 'refs/tags')
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

.gitignore

@@ -0,0 +1,9 @@
+.coverage
+.mypy_cache/
+.tox/
+dist/
+htmlcov/
+coverage.xml
+docs/_build
+*.egg-info/
+__pycache__/

CHANGES.rst

@@ -0,0 +1,7 @@
+Changes
+=======
+
+0.1.0 (2022-02-03)
+------------------
+
+* Initial release

README.md

@@ -0,0 +1,71 @@
+===============
+scrapy-zyte-api
+===============
+
+.. image:: https://img.shields.io/pypi/v/scrapy-zyte-api.svg
+   :target: https://pypi.python.org/pypi/scrapy-zyte-api
+   :alt: PyPI Version
+
+.. image:: https://img.shields.io/pypi/pyversions/scrapy-zyte-api.svg
+   :target: https://pypi.python.org/pypi/scrapy-zyte-api
+   :alt: Supported Python Versions
+
+.. image:: https://github.com/scrapy-plugins/scrapy-zyte-api/actions/workflows/test.yml/badge.svg
+   :target: https://github.com/scrapy-plugins/scrapy-zyte-api/actions/workflows/test.yml
+   :alt: Automated tests
+
+.. image:: https://codecov.io/github/scrapinghub/scrapy-zyte-api/coverage.svg?branch=master
+   :target: https://codecov.io/gh/scrapinghub/scrapy-zyte-api
+   :alt: Coverage report
+
+Installation
+------------
+
+.. code-block::
+
+    pip install scrapy-zyte-api
+
+This package requires Python 3.7+.
+
+How to configure
+----------------
+
+Replace the default ``http`` and ``https`` in Scrapy's
+`DOWNLOAD_HANDLERS <https://docs.scrapy.org/en/latest/topics/settings.html>`_.
+
+.. code-block:: python
+
+    DOWNLOAD_HANDLERS = {
+        "http": "scrapy_zyte_api.handler.ScrapyZyteAPIDownloadHandler",
+        "https": "scrapy_zyte_api.handler.ScrapyZyteAPIDownloadHandler"
+    }
+
+Also, make sure to `install the asyncio-based Twisted reactor
+<https://docs.scrapy.org/en/latest/topics/asyncio.html#installing-the-asyncio-reactor)>`_ :
+
+.. code-block:: python
+
+    TWISTED_REACTOR = "twisted.internet.asyncioreactor.AsyncioSelectorReactor"
+
+How to use
+----------
+
+Set the ``zyte_api`` `Request.meta
+<https://docs.scrapy.org/en/latest/topics/request-response.html#scrapy.http.Request.meta>`_
+key to download a request using Zyte API. Full list of parameters is provided in the
+`Zyte API Specification <https://docs.zyte.com/zyte-api/openapi.html#zyte-openapi-spec>`_.
+
+.. code-block:: python
+
+    yield scrapy.Request(
+        "http://books.toscrape.com/",
+        callback=self.parse,
+        meta={
+            "zyte_api": {
+                "browserHtml": True,
+                "geolocation": "US",
+                "javascript": True,
+                "echoData": {"something": True}
+            }
+        }
+    )

README.rst

@@ -4,8 +4,8 @@
     name="scrapy-zyte-api",
     version="0.0.0",
     description="Client library to process URLs through Zyte API",
-    long_description=open("README.md").read(),
-    long_description_content_type="text/markdown",
+    long_description=open("README.rst").read(),
+    long_description_content_type="text/x-rst",
     author="Zyte Group Ltd",
     author_email="[email protected]",
     url="https://github.com/scrapy-plugins/scrapy-zyte-api",

setup.py

@@ -11,7 +11,8 @@ commands =
     -r {toxinidir}/tests/requirements.txt
     py.test \
     --cov-report=html:coverage-html \
-    --cov-report= --cov=scrapy_zyte_api \
+    --cov-report=xml \
+    --cov=scrapy_zyte_api \
     --junitxml=test-results/junit.xml \
     {posargs:scrapy_zyte_api tests}