Merge pull request #4 from claromes/pip

Publish package to PyPI

.gitignore

@@ -1,7 +1,15 @@
+# test
 .pytest_cache/
 fivbvis/__pycache__/
 tests/__pycache__/
 tests/vcr_cassettes/
 example.py
 request.txt
+
+# build
+/dist/
+/build/
+/*.egg-info/
+
+# env
 /venv

README.md

@@ -8,17 +8,19 @@ Responses are formatted using JSON.
 
 ## Installation
 
-PyPI soon.
-
-## Docs
-
-[Objects documentation](docs/DOCS.md)
+```shell
+pip3 install fivbvis
+```
 
 ## Usage
 ```python
->>> from fivbvis import VolleyMatch
->>> vm = VolleyMatch()
->>> print(vm.match(9211))
+from fivbvis import VolleyMatch
+
+vb = VolleyMatch()
+
+print(vb.match(9211))
+```
+```json
 {
    "data":{
         "assistantScorerCountryCode":"None",
@@ -34,13 +36,18 @@ PyPI soon.
    }
 }
 ```
+
+## Docs
+
+[Objects documentation](docs/DOCS.md)
+
 ## Development
 
 $ `git clone git@github.com:claromes/fivbvis.git`
 
 $ `cd fivbvis`
 
-$ `pip install -r requirements.txt`
+$ `pip3 install -r dev-requirements.txt`
 
 ## Requests
 

dev-requirements.txt

@@ -0,0 +1,4 @@
+-r requirements.txt
+
+pytest==7.2.0
+vcrpy==4.2.1

fivbvis/__init__.py

@@ -1,2 +1,6 @@
 from .volley_match import VolleyMatch
-from .article import Article
+from .article import Article
+
+from . import version
+
+__version__ = version.__version__

fivbvis/version.py

@@ -0,0 +1 @@
+__version__ = '0.1.2'

requirements.txt

@@ -1,3 +1 @@
-requests==2.28.1
-pytest==7.2.0
-vcrpy==4.2.1
+requests==2.28.1

setup.py

@@ -0,0 +1,42 @@
+from setuptools import setup, find_packages
+import re
+
+with open('README.md', 'r', encoding='utf-8') as f:
+    long_description = f.read()
+
+with open('requirements.txt', 'r', encoding='utf-8') as f:
+    install_requires = f.read().splitlines()
+
+with open('fivbvis/version.py', 'r', encoding='utf-8') as f:
+    version = re.search(r"^__version__\s*=\s*'(.*)'.*$",
+        f.read(), flags=re.MULTILINE).group(1)
+
+setup(
+    name='fivbvis',
+    version=version,
+    author='claromes',
+    license='GPLv3',
+    description='FIVB VIS Web Service Python Client',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    keywords='api-wrapper fivbvis fivb volleyball beachvolleyball',
+    url='https://github.com/claromes/fivbvis',
+    packages=find_packages(exclude=['docs', 'tests*']),
+    classifiers=[
+        'Development Status :: 3 - Alpha',
+        'Intended Audience :: Science/Research',
+        'Intended Audience :: Education',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3.8',
+        'Topic :: Scientific/Engineering',
+        'Topic :: Scientific/Engineering :: Information Analysis',
+        'Topic :: Software Development',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+        'Topic :: Utilities'
+    ],
+    python_requires='>=3.8',
+    install_requires=install_requires
+)