Metadata-Version: 2.1
Name: dataclass-dict
Version: 0.0.1
Summary: Data management system using plain text files like json and yaml.
Home-page: https://github.com/Cerberus1746/PandaCoreData
Author: Leandro (Cerberus1746) Benedet Garcia
Author-email: leandro.benedet.garcia@gmail.com
License: MIT License
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints ; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest-localserver ; extra == 'tests'
Requires-Dist: pytest-pylint ; extra == 'tests'
Requires-Dist: pytest-runner ; extra == 'tests'
Requires-Dist: python-coveralls ; extra == 'tests'
Requires-Dist: mypy ; extra == 'tests'

dataclass_dict [![Build Status](https://travis-ci.org/Cerberus1746/dataclass_dict.svg?branch=master)](https://travis-ci.org/Cerberus1746/dataclass_dict) [![Documentation Status](https://readthedocs.org/projects/dataclass-dict/badge/?version=latest)](https://dataclass-dict.readthedocs.io/en/latest/?badge=latest)
===============
With this package you are able to create a dataclass that works exactly like a dictionary.

# Install
This package **only works with python 3.6 or above** because it uses **dataclasses**. In python 3.6
it will uses the dataclass package from pypi.

To use this package you may run the following command:
```
pip install git+https://github.com/Cerberus1746/dataclass_dict.git
```

# How to Collaborate
If you want to help with the development of this library, I would say that I love you but my
fiancee would get jealous, so I will just say thank you :D

## By throwing money at the screen
- **Patreon**: If you want to help us every month, you can help us by checking our patreon page
  [here](https://www.patreon.com/project_chrysalis)
- **Ko-fi**: Do you like Coffee, I love coffee, if you want to send a tip for a coffee, you can do
  that [here](https://ko-fi.com/project_chrysalis)

## By providing help with coding
First, make sure you have **at least Python 3.6**, git and pip up and running:
```
python -V
pip -V
git --version
```
download this repository with the following command using git:
```
git clone https://github.com/Cerberus1746/dataclass_dict.git
```

And then cd into the directory with:
```
cd dataclass_dict
```

Now, if you want to just run the tests to test your changes, you can run:
```
pip install tox
tox
```
If you want to generate docs, you can install all dependencies with:
```
pip install .[docs]
```

And then generate the docs with the command:
```
python setup.py build_sphinx
```
The docs will be located by default inside the directory `docs/build/html`


