https://github.com/teleprint-me/json-py-craft
JsonPyCraft is a specialized Python toolkit designed for efficient and structured JSON management.
https://github.com/teleprint-me/json-py-craft
api json python
Last synced: 29 days ago
JSON representation
JsonPyCraft is a specialized Python toolkit designed for efficient and structured JSON management.
- Host: GitHub
- URL: https://github.com/teleprint-me/json-py-craft
- Owner: teleprint-me
- License: agpl-3.0
- Created: 2023-11-18T01:02:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-07T22:42:40.000Z (about 1 month ago)
- Last Synced: 2025-04-07T23:29:04.666Z (about 1 month ago)
- Topics: api, json, python
- Language: Python
- Homepage:
- Size: 2.83 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JSONPyCraft
JsonPyCraft - A Fusion of Python and JSON, symbolizing the toolkit's capability to manage intricate JSON data structures.
## Description
JsonPyCraft is a specialized Python toolkit designed for efficient and structured JSON management. This toolkit offers a range of functionalities from basic JSON file handling to advanced operations, making it ideal for developers looking to manage JSON data in Python applications with precision and ease.
## Features
- Robust JSON file handling (load, save, backup).
- Advanced JSON structure manipulation (mapping and list templates).
- Nested JSON data management.
- Pythonic, easy-to-use interface with detailed documentation.
## JSONPyCraft Documentation
Welcome to the JSONPyCraft documentation! Explore detailed documentation on key aspects of JSONPyCraft:
- **[Core Components](https://github.com/teleprint-me/json-py-craft/tree/main/docs/core):** Learn about custom error handling, the Singleton pattern, core types, and more.
- **[JSON Templates](https://github.com/teleprint-me/json-py-craft/tree/main/docs/json):** Understand JSON templates, I/O operations, list templates, and map templates.
- **[Managers](https://github.com/teleprint-me/json-py-craft/tree/main/docs/manager):** Discover the `ConfigurationManager` class for managing configuration data.
- **[PlantUML Diagrams](https://github.com/teleprint-me/json-py-craft/tree/main/docs/puml):** Visual representations of key components.
For more detailed information, check out the [full documentation index](https://github.com/teleprint-me/json-py-craft/tree/main/docs).
### OpenAI GPT Support
JsonPyCraft supports integration with OpenAI GPT if you have an OpenAI Plus subscription. You can chat with [JSONPyCraft](https://chat.openai.com/g/g-ECxYHAufF-jsonpycraft) for more information.
## Installation
You can install JsonPyCraft using either `pip` or `poetry`. Follow the instructions below based on your preferred method.
### Using pip:
1. Create a virtual environment (optional but recommended for isolation):
```bash
virtualenv .venv
```
2. Activate the virtual environment:
```bash
source .venv/bin/activate
```
3. Install JSONPyCraft using PyPI:
```bash
pip install jsonpycraft
```
### Using poetry:
1. Initialize a new Poetry project. If you haven't already installed Poetry, you can do so with `pip`:
```bash
pip install poetry
```
2. Navigate to your project directory and run:
```bash
poetry init
```
Follow the prompts and add any necessary packages to your project.
3. Activate the Poetry shell:
```bash
poetry shell
```
4. Add JsonPyCraft to your project using the following command, specifying the URL to the wheel file:
```bash
poetry add jsonpycraft
```
## Usage
Here's a quick start guide to using JsonPyCraft:
```python
from jsonpycraft import JSONMapTemplate, JSONListTemplate
# Example of using JSONMapTemplate
map_template = JSONMapTemplate('map_data.json')
map_template.create('key', 'value')
# Example of using JSONListTemplate
list_template = JSONListTemplate('list_data.json')
list_template.append({'id': 1, 'name': 'JsonPyCraft'})
```
## Contributing, Support, and Contact
For support, feature requests, or contributions, feel free to open an issue or pull request.
## License
- [LICENSE](https://github.com/teleprint-me/json-py-craft/blob/main/LICENSE): JsonPyCraft is released under the GNU Affero General Public License.