Skip to content

Commit

Permalink
fix: Prepare for 0.1.1 release
Browse files Browse the repository at this point in the history
- Update metadata and documentation links
  • Loading branch information
teleprint-me committed Dec 4, 2023
1 parent a36e18b commit 08beb91
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 36 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<figure>
<p align="center">
<img src="assets/logo.png"
<img src="https://raw.githubusercontent.com/teleprint-me/json-py-craft/main/assets/logo.png"
alt="JsonPyCraft Artwork Image"
width="256" height="256">
<figcaption>JsonPyCraft - A Fusion of Python and JSON, symbolizing the toolkit's capability to manage intricate JSON data structures.</figcaption>
Expand All @@ -23,15 +23,15 @@ JsonPyCraft is a specialized Python toolkit designed for efficient and structure

Welcome to the JSONPyCraft documentation! Explore detailed documentation on key aspects of JSONPyCraft:

- **[Core Components](docs/core/README.md):** Learn about custom error handling, the Singleton pattern, core types, and more.
- **[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](docs/json/README.md):** Understand JSON templates, I/O operations, list templates, and map templates.
- **[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](docs/manager/README.md):** Discover the `ConfigurationManager` class for managing configuration data.
- **[Managers](https://github.com/teleprint-me/json-py-craft/tree/main/docs/manager):** Discover the `ConfigurationManager` class for managing configuration data.

- **[PlantUML Diagrams](docs/puml/README.md):** Visual representations of key components.
- **[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](docs/README.md).
For more detailed information, check out the [full documentation index](https://github.com/teleprint-me/json-py-craft/tree/main/docs).

### OpenAI GPT Support

Expand All @@ -55,10 +55,10 @@ virtualenv .venv
source .venv/bin/activate
```

3. Install JsonPyCraft using `pip`:
3. Install JSONPyCraft using PyPI:

```bash
pip install https://github.com/teleprint-me/json-py-craft.git
pip install jsonpycraft
```

### Using poetry:
Expand Down Expand Up @@ -86,7 +86,7 @@ poetry shell
4. Add JsonPyCraft to your project using the following command, specifying the URL to the wheel file:

```bash
poetry add https://github.com/teleprint-me/json-py-craft/releases/download/v0.1.0/jsonpycraft-0.1.0-py3-none-any.whl
poetry add jsonpycraft
```

## Usage
Expand All @@ -111,4 +111,4 @@ For support, feature requests, or contributions, feel free to open an issue or p

## License

- [LICENSE](LICENSE): JsonPyCraft is released under the GNU Affero General Public License.
- [LICENSE](https://github.com/teleprint-me/json-py-craft/blob/main/LICENSE): JsonPyCraft is released under the GNU Affero General Public License.
10 changes: 1 addition & 9 deletions jsonpycraft/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,6 @@
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Project Details:
- Name: jsonpycraft
- Version: 0.1.0
- Description: JsonPyCraft is a specialized Python toolkit designed for efficient and structured JSON management.
- Author: Austin Berrio <aberrio@teleprint.me>
- License: AGPL
- Readme: README.md
"""
from jsonpycraft.core.errors import (
JSONDecodeErrorHandler,
Expand All @@ -47,7 +39,7 @@
from jsonpycraft.manager.configuration import ConfigurationManager

# Additional project details extracted from pyproject.toml
__version__ = "0.1.0"
__version__ = "0.1.1"
__author__ = "Austin Berrio <aberrio@teleprint.me>"
__description__ = "JsonPyCraft is a specialized Python toolkit designed for efficient and structured JSON management."
__license__ = "AGPL"
28 changes: 14 additions & 14 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 8 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
[tool.poetry]
name = "jsonpycraft"
version = "0.1.0"
version = "0.1.1"
description = "JsonPyCraft is a specialized Python toolkit designed for efficient and structured JSON management."
authors = ["Austin Berrio <aberrio@teleprint.me>"]
license = "AGPL"
license = "AGPL-3.0-or-later"
readme = "README.md"
repository = "https://github.com/teleprint-me/jsonpycraft"

[tool.poetry.dependencies]
python = ">=3.11"
Expand All @@ -19,7 +20,11 @@ pytest = "^7.4.3"
build = "^1.0.3"
mkdocs = "^1.5.3"
mkdocstrings = {version = "^0.24.0", extras = ["python"]}
mkdocs-material = "^9.4.11"
mkdocs-material = "^9.4.14"

[tool.poetry.urls]
"Documentation" = "https://github.com/teleprint-me/jsonpycraft/docs"
"Source" = "https://github.com/teleprint-me/jsonpycraft"

[tool.build]
packages = [
Expand Down

0 comments on commit 08beb91

Please sign in to comment.