Merge pull request #4 from Kronopt/develop

Develop

Author: Kronopt

.github/workflows/workflow.yml

@@ -85,7 +85,7 @@ jobs:
         skip_existing: true
 
     - name: Publish to PyPI
-      if: github.ref == 'refs/heads/master'
+      if: startsWith(github.ref, 'refs/tags')
       uses: pypa/gh-action-pypi-publish@master
       with:
         password: ${{ secrets.PYPI_TOKEN }}  # defined in Github repository

README.md

@@ -15,12 +15,21 @@ Retrieves xkcd comic data and metadata as python objects.
 Asynchronous ([async](https://docs.python.org/3/library/asyncio.html)) and synchronous implementations.
 
 ## Installation
-At the command line, with `pip`:
+At the command line, with `pip`,
+
+synchronous implementation:
 ```sh
-$ pip install xkcd-wrapper
+$ pip install xkcd-wrapper[sync]
+```
+
+async implementation:
+```sh
+$ pip install xkcd-wrapper[async]
 ```
 
 ## Usage
+
+synchronous:
 ```python
 >>> import xkcd_wrapper
 

docs/history.md

@@ -1,5 +1,9 @@
 # History
 
+### 0.2.1 (11-08-2020)
+* Separate dependencies
+    (you can now use the async implementation without having to install the sync dependencies and vice versa)
+
 ### 0.2.0 (08-08-2020)
 * Async implementation
 

docs/installation.md

@@ -1,5 +1,12 @@
 # Installation
-At the command line, with `pip`:
+At the command line, with `pip`,
+
+synchronous implementation:
 ```sh
-$ pip install xkcd-wrapper
+$ pip install xkcd-wrapper[sync]
+```
+
+async implementation:
+```sh
+$ pip install xkcd-wrapper[async]
 ```

setup.py

@@ -18,7 +18,17 @@
         open('requirements.txt', encoding='utf-8') as requirements_txt:
     README = readme_md.read()
     HISTORY = history_md.read()
-    REQUIREMENTS = [req[:req.find('#')].rstrip() for req in requirements_txt.readlines()]
+
+    REQUIREMENTS = []
+    REQUIREMENTS_EXTRA = {}
+    for req in requirements_txt.readlines():
+        req = req[:req.find('#')].rstrip()  # remove comments
+        if req.startswith("requests"):
+            REQUIREMENTS_EXTRA["requests"] = req
+        elif req.startswith("aiohttp"):
+            REQUIREMENTS_EXTRA["aiohttp"] = req
+        else:
+            REQUIREMENTS.append(req)
 
 setup(
     name='xkcd-wrapper',
@@ -34,6 +44,10 @@
     package_dir={'xkcd_wrapper': 'xkcd_wrapper'},
     include_package_data=True,
     install_requires=REQUIREMENTS,
+    extras_require={
+        "sync":  [REQUIREMENTS_EXTRA["requests"]],
+        "async": [REQUIREMENTS_EXTRA["aiohttp"]],
+    },
     zip_safe=False,
     keywords='xkcd wrapper xkcd-wrapper',
     classifiers=[

xkcd_wrapper/__init__.py

@@ -27,7 +27,7 @@
 __author__ = 'Pedro HC David, https://github.com/Kronopt'
 __credits__ = ['Pedro HC David']
 __license__ = 'GPLv3'
-__version__ = '0.2.0'
+__version__ = '0.2.1'
 
 
 from .client import Client