Metadata-Version: 2.3
Name: vividict
Version: 0.1.1
Summary: Package containing the Vividict class. Allows for nested dictionaries.
Project-URL: Homepage, https://stockscrapers.com
Project-URL: Repository, https://github.com/StockScrapers/vividict
Project-URL: Bug Tracker, https://github.com/StockScrapers/vividict/issues
Project-URL: Changelog, https://github.com/me/vividict/blob/master/CHANGELOG.md
Author-email: Charbel Marche <charbelmarche33@gmail.com>
Maintainer-email: Charbel Marche <charbelmarche33@gmail.com>
License: MIT License
        
        Copyright (c) 2024 StockScrapers
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: nested dictionary,vividict
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# Home of the ViviDict Package
This package contains the Vividict class which can be used to create nested dictionaries in python.
### By: Charbel Marche
---
### Meta Data
* Title:    ViviDict Package
* Author:   Charbel Antoine Marche
* Date:     July 10, 2024 
* Language: Python
* Comment:  This package contains a simple vividict class that is adapted from various stackoverflow answers.
            It enables the creation of nested dictionaries, which is necessary across many stockscrapers projects.  
* URL:      https://github.com/StockScrapers/vividict
---
## Table of Contents
* [Installation](#installation)
* [Usage](#usage)
* [More From Us](#more-from-us)

## Installation
You can install this package locally using the following command in your terminal.
s
```bash
pip install vividict
```

This should install the latest vividict version to your environment.

## Usage
Once the package is installed, you can import the Vividict class into your python project as such:
```python
from vividict import Vividict
```

Then you can initialize your vividict object with the below code.
```python
vivi = Vividict()
```

From then on out you can use the 'vivi' variable (or the respectively named variable) to create a nested dictionary.
```python
vivi[outerkey][innerkey] = value
```

## More From Us
* Website: https://stockscrapers.com
* Financial Statement API: https://rapidapi.com/charbelmarche33-m9pHgx2tG/api/stock-financial-statement-retriever-from-sec
* On PyPi: https://pypi.org/user/charbelmarche33/
