Skip to content

Latest commit

 

History

History
114 lines (73 loc) · 3.59 KB

README.md

File metadata and controls

114 lines (73 loc) · 3.59 KB
Raw

JSONPyCraft

JsonPyCraft Artwork Image

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: Learn about custom error handling, the Singleton pattern, core types, and more.

  • JSON Templates: Understand JSON templates, I/O operations, list templates, and map templates.

  • Managers: Discover the ConfigurationManager class for managing configuration data.

  • PlantUML Diagrams: Visual representations of key components.

For more detailed information, check out the full documentation index.

OpenAI GPT Support

JsonPyCraft supports integration with OpenAI GPT if you have an OpenAI Plus subscription. You can chat with 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):
virtualenv .venv
  1. Activate the virtual environment:
source .venv/bin/activate
  1. Install JSONPyCraft using PyPI:
pip install jsonpycraft

Using poetry:

  1. Initialize a new Poetry project. If you haven't already installed Poetry, you can do so with pip:
pip install poetry
  1. Navigate to your project directory and run:
poetry init

Follow the prompts and add any necessary packages to your project.

  1. Activate the Poetry shell:
poetry shell
  1. Add JsonPyCraft to your project using the following command, specifying the URL to the wheel file:
poetry add jsonpycraft

Usage

Here's a quick start guide to using JsonPyCraft:

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: JsonPyCraft is released under the GNU Affero General Public License.