Merge branch 'bugfix_in_dependencies'

skallfass · Oct 24, 2019 · a717234 · a717234
2 parents e1cb5a0 + eb4156d
commit a717234
Show file tree

Hide file tree

Showing 23 changed files with 378 additions and 140 deletions.
diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,4 @@ htmlcov/
 .pytest_cache/
 dist/
 *.egg-info/
+log
diff --git a/docs/_static/coverage.svg b/docs/_static/coverage.svg
diff --git a/docs/_static/example_config.yml b/docs/_static/example_config.yml
@@ -7,7 +7,6 @@ service:
     readme: 'README.md'
     allowed_hosts:
         - '*'
-    use_prometheus: true
     use_default_endpoints:
         - alive
         - config

diff --git a/docs/api/fastapi_serviceutils.base.rst b/docs/api/fastapi_serviceutils.base.rst
@@ -0,0 +1,35 @@
+fastapi\_serviceutils.base package
+==================================
+
+.. automodule:: fastapi_serviceutils.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+fastapi\_serviceutils.base.errors module
+----------------------------------------
+
+.. automodule:: fastapi_serviceutils.base.errors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+fastapi\_serviceutils.base.logger module
+----------------------------------------
+
+.. automodule:: fastapi_serviceutils.base.logger
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+fastapi\_serviceutils.base.service\_config module
+-------------------------------------------------
+
+.. automodule:: fastapi_serviceutils.base.service_config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/api/fastapi_serviceutils.cli.rst b/docs/api/fastapi_serviceutils.cli.rst
@@ -0,0 +1,19 @@
+fastapi\_serviceutils.cli package
+=================================
+
+.. automodule:: fastapi_serviceutils.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+fastapi\_serviceutils.cli.create\_service module
+------------------------------------------------
+
+.. automodule:: fastapi_serviceutils.cli.create_service
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/api/fastapi_serviceutils.default_endpoints.rst b/docs/api/fastapi_serviceutils.default_endpoints.rst
@@ -0,0 +1,35 @@
+fastapi\_serviceutils.default\_endpoints package
+================================================
+
+.. automodule:: fastapi_serviceutils.default_endpoints
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+fastapi\_serviceutils.default\_endpoints.alive module
+-----------------------------------------------------
+
+.. automodule:: fastapi_serviceutils.default_endpoints.alive
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+fastapi\_serviceutils.default\_endpoints.config module
+------------------------------------------------------
+
+.. automodule:: fastapi_serviceutils.default_endpoints.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+fastapi\_serviceutils.default\_endpoints.models module
+------------------------------------------------------
+
+.. automodule:: fastapi_serviceutils.default_endpoints.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/api/fastapi_serviceutils.docs.rst b/docs/api/fastapi_serviceutils.docs.rst
@@ -0,0 +1,19 @@
+fastapi\_serviceutils.docs package
+==================================
+
+.. automodule:: fastapi_serviceutils.docs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+fastapi\_serviceutils.docs.apidoc module
+----------------------------------------
+
+.. automodule:: fastapi_serviceutils.docs.apidoc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/api/fastapi_serviceutils.external_resources.rst b/docs/api/fastapi_serviceutils.external_resources.rst
@@ -0,0 +1,19 @@
+fastapi\_serviceutils.external\_resources package
+=================================================
+
+.. automodule:: fastapi_serviceutils.external_resources
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+fastapi\_serviceutils.external\_resources.external\_services module
+-------------------------------------------------------------------
+
+.. automodule:: fastapi_serviceutils.external_resources.external_services
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/api/fastapi_serviceutils.middlewares.rst b/docs/api/fastapi_serviceutils.middlewares.rst
@@ -0,0 +1,7 @@
+fastapi\_serviceutils.middlewares package
+=========================================
+
+.. automodule:: fastapi_serviceutils.middlewares
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/fastapi_serviceutils.rst b/docs/api/fastapi_serviceutils.rst
@@ -0,0 +1,31 @@
+fastapi\_serviceutils package
+=============================
+
+.. automodule:: fastapi_serviceutils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+   fastapi_serviceutils.base
+   fastapi_serviceutils.cli
+   fastapi_serviceutils.default_endpoints
+   fastapi_serviceutils.docs
+   fastapi_serviceutils.external_resources
+   fastapi_serviceutils.middlewares
+
+Submodules
+----------
+
+fastapi\_serviceutils.service module
+------------------------------------
+
+.. automodule:: fastapi_serviceutils.service
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/api/modules.rst b/docs/api/modules.rst
@@ -0,0 +1,7 @@
+fastapi_serviceutils
+====================
+
+.. toctree::
+   :maxdepth: 4
+
+   fastapi_serviceutils
diff --git a/docs/create_service_help.txt b/docs/create_service_help.txt
@@ -1,5 +1,5 @@
 usage: create_service [-h] -n SERVICE_NAME -p SERVICE_PORT -a AUTHOR -e
-                      AUTHOR_EMAIL [-prom] -ep ENDPOINT -o OUTPUT_DIR
+                      AUTHOR_EMAIL -ep ENDPOINT -o OUTPUT_DIR
 
 create new service based on fastapi using fastapi_serviceutils.
 
@@ -15,8 +15,6 @@ optional arguments:
                         the name of the author of the service.
   -e AUTHOR_EMAIL, --author_email AUTHOR_EMAIL
                         the email of the author of the service.
-  -prom, --use_prometheus
-                        expose metrics for prometheus-usage.
   -ep ENDPOINT, --endpoint ENDPOINT
                         the name of the endpoint for the service to create.
                         ATTENTION: only lower ascii-letters, "_" and digits

diff --git a/docs/doc_requirements.txt b/docs/doc_requirements.txt
@@ -1,30 +1,22 @@
-aiofiles==0.*,>=0.4.0
-autoflake==1.*,>=1.3.0
-cookiecutter==1.*,>=1.6.0
-coverage==4.*,>=4.5.0
-coverage-badge==1.*,>=1.0.0
-email-validator==1.*,>=1.0.4
-fastapi==0.*,>=0.42.0
-flake8==3.*,>=3.7.0
-ipython==7.*,>=7.8.0
-isort==4.*,>=4.3.0
-jedi==0.*,>=0.14.0
-loguru==0.*,>=0.3.0
-neovim==0.*,>=0.3.1
+autoflake>=1.3
+cookiecutter>=1.6
+coverage-badge>=1
+fastapi[all]>=0.42
+flake8>=3.7
+ipython>=7.8
+isort>=4.3
+jedi>=0.14
+loguru>=0.3
+neovim>=0.3.1
 pre-commit>=1.18.3
-pudb==2019.*,>=2019.1.0
-pygments==2.*,>=2.4.0
-pytest==5.*,>=5.0.0
+pudb>=2019.1
+pygments>=2.4
+pytest>=5
 pytest-asyncio>=0.10
 pytest-cov>=2
-pytest-xdist==1.*,>=1.30.0
-pyyaml==5.*,>=5.1.0
-requests==2.*,>=2.22.0
+pytest-xdist>=1.30
 sphinx>=2
 sphinx-autodoc-typehints>=1.6
 sphinx-rtd-theme>=0.4.3
-starlette-prometheus==0.*,>=0.3.0
-toolz==0.*,>=0.10.0
-ujson==1.*,>=1.35.0
-uvicorn==0.*,>=0.9.0
-yapf==0.*,>=0.27.0
+toolz>=0.10
+yapf>=0.27
diff --git a/docs/makefile_help.txt b/docs/makefile_help.txt
@@ -1,5 +1,5 @@
 make[1]: Entering directory '/home/skallfass/devl/services/fastapi/fastapi_serviceutils'
-Helpers for development inside services based on fastapi using fastapi_serviceutils.
+Helpers for development of fastapi_serviceutils.
 
   Usage:
 
@@ -9,7 +9,6 @@ Helpers for development inside services based on fastapi using fastapi_serviceut
 
     check      Run all checks defined in .pre-commit-config.yaml.
     clean      Clean the working directory from temporary files and caches.
-    docker     Create docker-image for project.
     docs       Create sphinx documentation for the project.
     finalize   Finalize the main env.
     help       Show the help prompt.

diff --git a/fastapi_serviceutils/__init__.py b/fastapi_serviceutils/__init__.py
@@ -1,2 +1,2 @@
 """Contain utils for the service based on fastapi."""
-__version__ = '0.3.0'
+__version__ = '1.0.0'
diff --git a/fastapi_serviceutils/base/service_config.py b/fastapi_serviceutils/base/service_config.py
@@ -38,7 +38,6 @@ class ServiceConfig(BaseModel):
     apidoc_dir: str
     readme: str
     allowed_hosts: List[str]
-    use_prometheus: bool
     use_default_endpoints: List[str]
 
 

diff --git a/fastapi_serviceutils/cli/create_service.py b/fastapi_serviceutils/cli/create_service.py
@@ -69,13 +69,6 @@ def build_arguments() -> Namespace:
         required=True,
         help='the email of the author of the service.'
     )
-    parser.add_argument(
-        '-prom',
-        '--use_prometheus',
-        action='store_true',
-        default=True,
-        help='expose metrics for prometheus-usage.'
-    )
     parser.add_argument(
         '-ep',
         '--endpoint',
@@ -107,7 +100,6 @@ def main():
             'service_port': params.service_port,
             'author': params.author,
             'author_email': params.author_email,
-            'use_prometheus': params.use_prometheus,
             'endpoint': params.endpoint
         }
     }

diff --git a/fastapi_serviceutils/middlewares/prometheus.py b/fastapi_serviceutils/middlewares/prometheus.py
diff --git a/fastapi_serviceutils/service.py b/fastapi_serviceutils/service.py
@@ -15,7 +15,6 @@
 from fastapi_serviceutils.base import update_config
 from fastapi_serviceutils.default_endpoints import add_default_endpoints
 from fastapi_serviceutils.docs import mount_apidoc
-from fastapi_serviceutils.middlewares import prometheus
 
 Endpoints = List[Dict[str, Union[APIRouter, str]]]
 
@@ -60,11 +59,6 @@ def include_endpoints_and_middlewares_to_app(
             allowed_hosts=app.config.service.allowed_hosts
         )
 
-    # add exposing of metrics for prometheus monitoring
-    if app.config.service.use_prometheus:
-        app.add_middleware(prometheus.PrometheusMiddleware)
-        app.add_route('/metrics/', prometheus.metrics)
-
     # add custom exception handler to log exceptions
     if 'log_exception' in enable_middlewares:
         app.exception_handler(Exception)(errors.log_exception_handler)