Metadata-Version: 2.1
Name: msaStorageDict
Version: 0.0.3
Summary: Dict with a Storage Backend like redis or Zookeeper
Home-page: https://github.com/swelcker/msaStorageDict
Download-URL: http://pypi.python.org/pypi/msaStorageDict
Author: Stefan Welcker
Author-email: stefan@u2d.ai
License: MIT
Project-URL: Documentation, http://msaStorageDict.u2d.ai/
Project-URL: Source, https://github.com/swelcker/msaStorageDict
Project-URL: Tracker, https://github.com/swelcker/msaStorageDict/issues
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: FastAPI
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Database
Classifier: Topic :: Database :: Front-Ends
Classifier: Topic :: Documentation
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Server
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
License-File: LICENCE

<p align="center">
  <img src="http://logos.u2d.ai/msaStorageDict_logo.png?raw=true" alt="MSA StorageDict image"/>
</p>

------
<p align="center">
    <em>msaStorageDict - Dict with a backend storage</em>
<br>
    Optimized for use with FastAPI/Pydantic.
<br>
  <a href="https://pypi.org/project/msaStorageDict" target="_blank">
      <img src="https://img.shields.io/pypi/v/msaStorageDict?color=%2334D058&label=pypi%20package" alt="Package version">
  </a>
  <a href="https://pypi.org/project/msaStorageDict" target="_blank">
      <img src="https://img.shields.io/pypi/pyversions/msaStorageDict.svg?color=%2334D058" alt="Supported Python versions">
  </a>
</p>

------

**Documentation**: <a href="https://msastoragedict.u2d.ai/" target="_blank">MSA Storage Dict Documentation (https://msastoragedict.u2d.ai/)</a>

------

## 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/*
