https://github.com/u2d-ai/msastoragedict

msaStorageDict - Dict with a backend storage Optimized for use with FastAPI/Pydantic.
https://github.com/u2d-ai/msastoragedict

fastapi microservices mkdocs python

Last synced: 2 months ago
JSON representation

msaStorageDict - Dict with a backend storage Optimized for use with FastAPI/Pydantic.

• Host: GitHub
• URL: https://github.com/u2d-ai/msastoragedict
• Owner: u2d-ai
• License: mit
• Created: 2022-09-22T12:57:13.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-09-24T10:49:42.000Z (over 2 years ago)
• Last Synced: 2024-10-11T21:41:53.588Z (3 months ago)
• Topics: fastapi, microservices, mkdocs, python
• Language: Python
• Homepage:
• Size: 318 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  



------



    msaStorageDict - Dict with a backend storage




    Optimized for use with FastAPI/Pydantic.




  

      

  

  

      

  



------

**Documentation**: MSA Storage Dict Documentation (https://msastoragedict.u2d.ai/)

------

## Features

- **Dict with Storage Backend**: Use Dict's with backend storage like redis.

## License Agreement

- `msaStorageDict`Based on `MIT` open source and free to use, it is free for commercial use, but please show/list the copyright information about msaStorageDict somewhere.

## How to create the documentation

We use mkdocs and mkdocsstring. The code reference and nav entry get's created virtually by the triggered python script /docs/gen_ref_pages.py while ``mkdocs`` ``serve`` or ``build`` is executed.

### Requirements Install for the PDF creation option:

PDF Export is using mainly weasyprint, if you get some errors here pls. check there documentation. Installation is part of the msaStorageDict, so this should be fine.

We can now test and view our documentation using:

    mkdocs serve

Build static Site:

    mkdocs build

## Build and Publish

  

Build:  

    python setup.py sdist

Publish to pypi:

    twine upload dist/*