added additional documentation

README.md

@@ -1,8 +1,23 @@
-![coverage](doc/_static/coverage.svg)
+![coverage](https://github.com/skallfass/fastapi_serviceutils/blob/master/docs/_static/coverage.svg)
+[![PyPI version fury.io](https://badge.fury.io/py/fastapi-serviceutils.svg)](https://pypi.python.org/pypi/fastapi-serviceutils/)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/fastapi-serviceutils.svg)](https://pypi.python.org/pypi/fastapi-serviceutils/)
+[![Documentation Status](https://readthedocs.org/projects/fastapi-serviceutils/badge/?version=latest)](http://fastapi-serviceutils.readthedocs.io/?badge=latest)
+![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)
+![Powered by Dephell](https://github.com/dephell/dephell/blob/master/assets/badge.svg)
 
 
 ## Installation
 
+```bash
+    pip install fastapi-serviceutils
+```
+
+
+## Usage
+
+For more details and usage see: [readthedocs](https://fastapi-serviceutils.readthedocs.io/en/latest/)
+
+
 ## Development
 
 
@@ -20,7 +35,7 @@ This will create the dev environment exampleservice/dev. Activate it using:
 ```
 
 
-## Start development
+### Start development
 
 **Note:**
 
@@ -31,7 +46,7 @@ project in a new terminal using
 ```
 
 
-## Updating dependencies
+### Updating dependencies
 
 After each change in dependencies defined at `pyproject.toml` run the
 following to ensure the environment-definition and lock-file are up to date:
@@ -40,23 +55,23 @@ following to ensure the environment-definition and lock-file are up to date:
 ```
 
 
-## Checking with linters and checkers
+### Checking with linters and checkers
 
 To run all pre-commit-hooks manually run:
 ```bash
     make check
 ```
 
 
-## Info about project-state
+### Info about project-state
 
 To show summary about project run:
 ```bash
     make info
 ```
 
 
-## Documentation
+### Documentation
 
 The project's developer documentation is written using Sphinx.
 
@@ -79,7 +94,7 @@ There is also a swagger-documentation to be used for users of the service.
 The apidoc can be found at ``/apidoc/index.html``.
 
 
-## Tests
+### Tests
 
 For testing we use `pytest`, for details see
 [Pytest Docs](http://doc.pytest.org/en/latest/).

README.rst

@@ -1,13 +1,47 @@
 
 
-.. image:: doc/_static/coverage.svg
-   :target: doc/_static/coverage.svg
+.. image:: https://github.com/skallfass/fastapi_serviceutils/blob/master/docs/_static/coverage.svg
+   :target: https://github.com/skallfass/fastapi_serviceutils/blob/master/docs/_static/coverage.svg
    :alt: coverage
 
 
+.. image:: https://badge.fury.io/py/fastapi-serviceutils.svg
+   :target: https://pypi.python.org/pypi/fastapi-serviceutils/
+   :alt: PyPI version fury.io
+
+
+.. image:: https://img.shields.io/pypi/pyversions/fastapi-serviceutils.svg
+   :target: https://pypi.python.org/pypi/fastapi-serviceutils/
+   :alt: PyPI pyversions
+
+
+.. image:: https://readthedocs.org/projects/fastapi-serviceutils/badge/?version=latest
+   :target: http://fastapi-serviceutils.readthedocs.io/?badge=latest
+   :alt: Documentation Status
+
+
+.. image:: https://img.shields.io/badge/License-MIT-blue.svg
+   :target: https://img.shields.io/badge/License-MIT-blue.svg
+   :alt: MIT License
+
+
+.. image:: https://github.com/dephell/dephell/blob/master/assets/badge.svg
+   :target: https://github.com/dephell/dephell/blob/master/assets/badge.svg
+   :alt: Powered by Dephell
+
+
 Installation
 ------------
 
+.. code-block:: bash
+
+       pip install fastapi-serviceutils
+
+Usage
+-----
+
+For more details and usage see: `readthedocs <https://fastapi-serviceutils.readthedocs.io/en/latest/>`_
+
 Development
 -----------
 
@@ -27,7 +61,7 @@ This will create the dev environment exampleservice/dev. Activate it using:
        dephell venv shell --env devs
 
 Start development
------------------
+^^^^^^^^^^^^^^^^^
 
 **Note:**
 
@@ -39,7 +73,7 @@ project in a new terminal using
        dephell venv shell --env devs
 
 Updating dependencies
----------------------
+^^^^^^^^^^^^^^^^^^^^^
 
 After each change in dependencies defined at ``pyproject.toml`` run the
 following to ensure the environment-definition and lock-file are up to date:
@@ -49,7 +83,7 @@ following to ensure the environment-definition and lock-file are up to date:
        make update
 
 Checking with linters and checkers
-----------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 To run all pre-commit-hooks manually run:
 
@@ -58,7 +92,7 @@ To run all pre-commit-hooks manually run:
        make check
 
 Info about project-state
-------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^
 
 To show summary about project run:
 
@@ -67,7 +101,7 @@ To show summary about project run:
        make info
 
 Documentation
--------------
+^^^^^^^^^^^^^
 
 The project's developer documentation is written using Sphinx.
 
@@ -91,7 +125,7 @@ There is also a swagger-documentation to be used for users of the service.
 The apidoc can be found at ``/apidoc/index.html``.
 
 Tests
------
+^^^^^
 
 For testing we use ``pytest``\ , for details see
 `Pytest Docs <http://doc.pytest.org/en/latest/>`_.

docs/usage.rst

@@ -7,4 +7,3 @@ Usage
    service_structure.rst
    helpers.rst
    deployment.rst
-

fastapi_serviceutils/__init__.py

@@ -1,2 +1,2 @@
 """Contain utils for the service based on fastapi."""
-__version__ = '0.2.0'
+__version__ = '0.2.1'

pyproject.toml

@@ -1,13 +1,21 @@
 [tool.poetry]
 name = "fastapi_serviceutils"
-version = "0.2.0"
+version = "0.2.1"
+license = "MIT"
 description = "Utils for fastapi based services."
 authors = [
   "Simon Kallfass <skallfass@ouroboros.info>",
 ]
 readme = "README.md"
 include = ['README.md', 'fastapi_serviceutils/cli/template']
 repository = "https://github.com/skallfass/fastapi_serviceutils"
+homepage = "https://fastapi-serviceutils.readthedocs.io/en/latest/"
+keywords = ["python", "fastapi"]
+classifiers = [
+    "Operating System :: Unix",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.7"
+]
 
 [tool.poetry.dependencies]
 aiofiles = "^0.4"

setup.py

@@ -21,14 +21,21 @@
 setup(
     long_description=readme,
     name='fastapi_serviceutils',
-    version='0.2.0',
+    version='0.2.1',
     description='Utils for fastapi based services.',
     python_requires='==3.*,>=3.7.0',
     project_urls={
+        'homepage': 'https://fastapi-serviceutils.readthedocs.io/en/latest/',
         'repository': 'https://github.com/skallfass/fastapi_serviceutils'
     },
     author='Simon Kallfass',
     author_email='skallfass@ouroboros.info',
+    license='MIT',
+    keywords='python fastapi',
+    classifiers=[
+        'Operating System :: Unix', 'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python :: 3.7'
+    ],
     entry_points={
         'console_scripts': [
             'create_service = fastapi_serviceutils.cli.create_service:main'
@@ -44,9 +51,6 @@
         'fastapi_serviceutils.middlewares'
     ],
     package_data={
-        'fastapi_serviceutils.cli.template.{{cookiecutter.service_name}}.app': [
-            '*.yml'
-        ],
         'fastapi_serviceutils': [
             'cli/template/*.json',
             'cli/template/{{cookiecutter.service_name}}/*.cfg',
@@ -56,6 +60,9 @@
             'cli/template/{{cookiecutter.service_name}}/*.yaml',
             'cli/template/{{cookiecutter.service_name}}/*.yml',
             'cli/template/{{cookiecutter.service_name}}/docs/*.rst'
+        ],
+        'fastapi_serviceutils.cli.template.{{cookiecutter.service_name}}.app': [
+            '*.yml'
         ]
     },
     install_requires=[
@@ -66,7 +73,7 @@
         'ujson==1.*,>=1.35.0', 'uvicorn==0.*,>=0.9.0'
     ],
     extras_require={
-        'dev': [
+        'devs': [
             'autoflake==1.*,>=1.3.0', 'coverage==4.*,>=4.5.0',
             'coverage-badge==1.*,>=1.0.0', 'flake8==3.*,>=3.7.0',
             'ipython==7.*,>=7.8.0', 'isort==4.*,>=4.3.0', 'jedi==0.*,>=0.14.0',
@@ -77,7 +84,7 @@
             'sphinx-autodoc-typehints>=1.6', 'sphinx-rtd-theme>=0.4.3',
             'yapf==0.*,>=0.27.0'
         ],
-        'devs': [
+        'dev': [
             'autoflake==1.*,>=1.3.0', 'coverage==4.*,>=4.5.0',
             'coverage-badge==1.*,>=1.0.0', 'flake8==3.*,>=3.7.0',
             'ipython==7.*,>=7.8.0', 'isort==4.*,>=4.3.0', 'jedi==0.*,>=0.14.0',