Metadata-Version: 2.1
Name: classy-json
Version: 3.2.0
Summary: Dot-access for Python dictionaries like JS!
Home-page: https://github.com/Iapetus-11/Classy-JSON
License: MIT
Author: Milo Weinberg
Author-email: iapetus011@gmail.com
Requires-Python: >=3.7.3,<4.0.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Project-URL: Repository, https://github.com/Iapetus-11/Classy-JSON
Description-Content-Type: text/markdown

# Classy-JSON ![Code Quality](https://www.codefactor.io/repository/github/iapetus-11/classy-json/badge) ![PYPI Version](https://img.shields.io/pypi/v/classy-json.svg?color=0FAE6E) ![PYPI Downloads](https://img.shields.io/pypi/dw/classy-json?color=0FAE6E) ![Views](https://api.ghprofile.me/view?username=iapetus-11.classy-json&color=0FAE6E&label=views&style=flat)
*`dict.key` (Dot access) for Python dictionaries*

## How do I use Classy-JSON?
* Classy-JSON can be used nearly identically to the regular built-in json module! [json module docs](https://docs.python.org/3/library/json.html)
* The only differences are that you can now access dictionaries via `dict.key` as well as `dict['key']`, and that the `.copy()` method is now a deep copy.
* What seperates Classy-JSON and its custom data structures from other alternatives? Classy-JSON is both better in its speed and package size, other similiar packages have unecessary code and just aren't as fast as Classy-JSON

## Example Usage
```py
import classyjson as cj

# load data from a json file
with open('tests/test_large.json', 'r') as f:
  data = cj.load(f)

# turn a regular dictionary into a ClassyDict
my_dict = {'a': 'b'}
my_classy_dict = cj.classify(my_dict)
print(my_classy_dict.a)

# or

my_classy_dict = cj.ClassyDict(my_dict)
print(my_classy_dict.a)

# make a new ClassyDict
new_classy_dict = cj.ClassyDict()
new_classy_dict.a = 'b'
```

## Setup / Install
### Using pip:
```
python3 -m pip install classy-json
```
### Manually:
* Clone the repository
```
git clone https://github.com/Iapetus-11/Classy-JSON.git
```
* cd into the directory
```
cd Classy-JSON
```
* Run setup.py
```
python3 setup.py build install
```

## Contribution
* Contributions are welcome! Just submit a pull request!

