Metadata-Version: 2.1
Name: coca-tools
Version: 0.2.0
Summary: 
Author: NhanDD
Author-email: hp.duongducnhan@gmail.com
Requires-Python: >=3.11,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: bump2version (>=1.0.1,<2.0.0)
Requires-Dist: celery (>=5.2.7,<6.0.0)
Requires-Dist: cookiecutter (>=2.1.1,<3.0.0)
Requires-Dist: django (>=4.2,<5.0)
Requires-Dist: djangorestframework (>=3.14.0,<4.0.0)
Requires-Dist: fastapi (>=0.95.1,<0.96.0)
Requires-Dist: mkdocs (>=1.4.2,<2.0.0)
Requires-Dist: mkdocs-autorefs (>=0.4.1,<0.5.0)
Requires-Dist: mkdocs-glightbox (>=0.3.2,<0.4.0)
Requires-Dist: mkdocs-material (>=9.1.6,<10.0.0)
Requires-Dist: mkdocs-monorepo-plugin (>=1.0.4,<2.0.0)
Requires-Dist: mkdocstrings (>=0.21.2,<0.22.0)
Requires-Dist: mypy (>=1.2.0,<2.0.0)
Requires-Dist: pre-commit (>=3.2.2,<4.0.0)
Requires-Dist: psutil (>=5.9.4,<6.0.0)
Requires-Dist: pydantic[dotenv] (>=1.10.7,<2.0.0)
Requires-Dist: pylint[spelling] (>=2.17.2,<3.0.0)
Requires-Dist: pytest (>=7.3.1,<8.0.0)
Requires-Dist: pytest-asyncio (>=0.21.0,<0.22.0)
Requires-Dist: uvloop (>=0.17.0,<0.18.0)
Description-Content-Type: text/markdown

# Attention
- First things to do when clone this monorepo , require python version >= 3.11 and < 4.0
    ```
    $ make init
    ```
- Open vs-code by "Open workspace from file" -> select "backend.code-workspace"
- Before working with any services
    ```
    # go to service source directory

    $ poetry install
    ```


# Create docs guides
- detail instruction to setup mkdocs
    ```
    https://realpython.com/python-project-documentation-with-mkdocs/
    ```
- for monorepo
    ```
    https://github.com/backstage/mkdocs-monorepo-plugin
    ```
- install packages
    ```
    $ poetry add mkdocs "mkdocstrings[python]" mkdocs-material mkdocs-autorefs mkdocs-monorepo-plugin

    run command bellow to init mkdocs for project
    $ poetry run mkdocs new .
    ```
- with vscode install "docstring" extension
- Run docs server
    ```
    $ make mkdocs-serve
    ```

