Skip to content

Commit 08beb91

Browse files
committed
fix: Prepare for 0.1.1 release
- Update metadata and documentation links
1 parent a36e18b commit 08beb91

File tree

4 files changed

+33
-36
lines changed

4 files changed

+33
-36
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

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

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

26-
- **[Core Components](docs/core/README.md):** Learn about custom error handling, the Singleton pattern, core types, and more.
26+
- **[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.
2727

28-
- **[JSON Templates](docs/json/README.md):** Understand JSON templates, I/O operations, list templates, and map templates.
28+
- **[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.
2929

30-
- **[Managers](docs/manager/README.md):** Discover the `ConfigurationManager` class for managing configuration data.
30+
- **[Managers](https://github.com/teleprint-me/json-py-craft/tree/main/docs/manager):** Discover the `ConfigurationManager` class for managing configuration data.
3131

32-
- **[PlantUML Diagrams](docs/puml/README.md):** Visual representations of key components.
32+
- **[PlantUML Diagrams](https://github.com/teleprint-me/json-py-craft/tree/main/docs/puml):** Visual representations of key components.
3333

34-
For more detailed information, check out the [full documentation index](docs/README.md).
34+
For more detailed information, check out the [full documentation index](https://github.com/teleprint-me/json-py-craft/tree/main/docs).
3535

3636
### OpenAI GPT Support
3737

@@ -55,10 +55,10 @@ virtualenv .venv
5555
source .venv/bin/activate
5656
```
5757

58-
3. Install JsonPyCraft using `pip`:
58+
3. Install JSONPyCraft using PyPI:
5959

6060
```bash
61-
pip install https://github.com/teleprint-me/json-py-craft.git
61+
pip install jsonpycraft
6262
```
6363

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

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

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

112112
## License
113113

114-
- [LICENSE](LICENSE): JsonPyCraft is released under the GNU Affero General Public License.
114+
- [LICENSE](https://github.com/teleprint-me/json-py-craft/blob/main/LICENSE): JsonPyCraft is released under the GNU Affero General Public License.

jsonpycraft/__init__.py

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,6 @@
1616
1717
You should have received a copy of the GNU Affero General Public License
1818
along with this program. If not, see <https://www.gnu.org/licenses/>.
19-
20-
Project Details:
21-
- Name: jsonpycraft
22-
- Version: 0.1.0
23-
- Description: JsonPyCraft is a specialized Python toolkit designed for efficient and structured JSON management.
24-
- Author: Austin Berrio <aberrio@teleprint.me>
25-
- License: AGPL
26-
- Readme: README.md
2719
"""
2820
from jsonpycraft.core.errors import (
2921
JSONDecodeErrorHandler,
@@ -47,7 +39,7 @@
4739
from jsonpycraft.manager.configuration import ConfigurationManager
4840

4941
# Additional project details extracted from pyproject.toml
50-
__version__ = "0.1.0"
42+
__version__ = "0.1.1"
5143
__author__ = "Austin Berrio <aberrio@teleprint.me>"
5244
__description__ = "JsonPyCraft is a specialized Python toolkit designed for efficient and structured JSON management."
5345
__license__ = "AGPL"

poetry.lock

Lines changed: 14 additions & 14 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

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

910
[tool.poetry.dependencies]
1011
python = ">=3.11"
@@ -19,7 +20,11 @@ pytest = "^7.4.3"
1920
build = "^1.0.3"
2021
mkdocs = "^1.5.3"
2122
mkdocstrings = {version = "^0.24.0", extras = ["python"]}
22-
mkdocs-material = "^9.4.11"
23+
mkdocs-material = "^9.4.14"
24+
25+
[tool.poetry.urls]
26+
"Documentation" = "https://github.com/teleprint-me/jsonpycraft/docs"
27+
"Source" = "https://github.com/teleprint-me/jsonpycraft"
2328

2429
[tool.build]
2530
packages = [

0 commit comments

Comments
 (0)