Skip to content

Commit

Permalink
created new version with working version for create_service and more …
Browse files Browse the repository at this point in the history
…detailed documentation
  • Loading branch information
skallfass committed Oct 22, 2019
1 parent ae22291 commit e1cb5a0
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 36 deletions.
20 changes: 7 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ For more details and usage see: `readthedocs <https://fastapi-serviceutils.readt
Development
-----------

Initialize project
^^^^^^^^^^^^^^^^^^
Getting started
^^^^^^^^^^^^^^^

After cloning the repository, you can initialize your development environment using
After cloning the repository initialize the development environment using:

.. code-block:: bash
Expand All @@ -60,9 +60,6 @@ This will create the dev environment exampleservice/dev. Activate it using:
dephell venv shell --env devs
Start development
^^^^^^^^^^^^^^^^^

**Note:**

Make sure to always activate the environment when you start working on the
Expand All @@ -72,6 +69,8 @@ project in a new terminal using
dephell venv shell --env devs
**ATTENTION:** the environment should also be activated before using ``make``.

Updating dependencies
^^^^^^^^^^^^^^^^^^^^^

Expand Down Expand Up @@ -106,23 +105,18 @@ Documentation
The project's developer documentation is written using Sphinx.

The documentation sources can be found in the docs subdirectory.
They are written using restructuredText.

The API-documentation is auto-generated from the docstrings of modules,
classes, and functions.
We're using the Google docstring standard.

To generate the documentation, run
To generate the documentation, run:

.. code-block:: bash
make docs
The generated HTML files will be in the ``docs/_build`` directory.

There is also a swagger-documentation to be used for users of the service.

The apidoc can be found at ``/apidoc/index.html``.
The output for generated HTML files is in the ``docs/_build`` directory.

Tests
^^^^^
Expand Down
2 changes: 1 addition & 1 deletion fastapi_serviceutils/__init__.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
"""Contain utils for the service based on fastapi."""
__version__ = '0.2.1'
__version__ = '0.3.0'
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "fastapi_serviceutils"
version = "0.2.1"
version = "0.3.0"
license = "MIT"
description = "Utils for fastapi based services."
authors = [
Expand Down
25 changes: 4 additions & 21 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
setup(
long_description=readme,
name='fastapi_serviceutils',
version='0.2.1',
version='0.3.0',
description='Utils for fastapi based services.',
python_requires='==3.*,>=3.7.0',
project_urls={
Expand All @@ -43,28 +43,11 @@
},
packages=[
'fastapi_serviceutils', 'fastapi_serviceutils.base',
'fastapi_serviceutils.cli',
'fastapi_serviceutils.cli.template.{{cookiecutter.service_name}}.app',
'fastapi_serviceutils.cli.template.{{cookiecutter.service_name}}.app.endpoints',
'fastapi_serviceutils.cli.template.{{cookiecutter.service_name}}.tests',
'fastapi_serviceutils.default_endpoints', 'fastapi_serviceutils.docs',
'fastapi_serviceutils.external_resources',
'fastapi_serviceutils.cli', 'fastapi_serviceutils.default_endpoints',
'fastapi_serviceutils.docs', 'fastapi_serviceutils.external_resources',
'fastapi_serviceutils.middlewares'
],
package_data={
'fastapi_serviceutils.cli': [
'template/*.json', 'template/{{cookiecutter.service_name}}/*.cfg',
'template/{{cookiecutter.service_name}}/*.md',
'template/{{cookiecutter.service_name}}/*.toml',
'template/{{cookiecutter.service_name}}/*.txt',
'template/{{cookiecutter.service_name}}/*.yaml',
'template/{{cookiecutter.service_name}}/*.yml',
'template/{{cookiecutter.service_name}}/docs/*.rst'
],
'fastapi_serviceutils.cli.template.{{cookiecutter.service_name}}.app': [
'*.yml'
]
},
package_data={},
install_requires=[
'aiofiles==0.*,>=0.4.0', 'cookiecutter==1.*,>=1.6.0',
'email-validator==1.*,>=1.0.4', 'fastapi==0.*,>=0.42.0',
Expand Down

0 comments on commit e1cb5a0

Please sign in to comment.