Merge pull request #3 from HideyoshiNakazone/adds-readme

Adds README, LICENSE and Changes Build to SDIST

.github/workflows/build.yml

@@ -59,8 +59,8 @@ jobs:
       - name: Set up Python
         run: uv python install
 
-      - name: Build
+      - name: Build source distribution
-        run: uv build
+        run: uv build --sdist
 
       - name: Publish
         run: uv publish -t ${{ secrets.PYPI_TOKEN }}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Vitor Hideyoshi
+
+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.

README.md

@@ -0,0 +1,170 @@
+# Jambo - JSON Schema to Pydantic Converter
+
+**Jambo** is a Python package that automatically converts [JSON Schema](https://json-schema.org/) definitions into [Pydantic](https://docs.pydantic.dev/) models. 
+It's designed to streamline schema validation and enforce type safety using Pydantic's powerful validation features.
+
+Created to simplifying the process of dynamically generating Pydantic models for AI frameworks like [LangChain](https://www.langchain.com/), [CrewAI](https://www.crewai.com/), and others.
+
+---
+
+## ✨ Features
+
+- ✅ Convert JSON Schema into Pydantic models dynamically
+- 🔒 Supports validation for strings, integers, floats, booleans, arrays, and nested objects
+- ⚙️ Enforces constraints like `minLength`, `maxLength`, `pattern`, `minimum`, `maximum`, `uniqueItems`, and more
+- 📦 Zero config — just pass your schema and get a model
+
+---
+
+## 📦 Installation
+
+```bash
+pip install jambo
+```
+
+---
+
+## 🚀 Usage
+
+```python
+from jambo.schema_converter import SchemaConverter
+
+schema = {
+    "title": "Person",
+    "type": "object",
+    "properties": {
+        "name": {"type": "string"},
+        "age": {"type": "integer"},
+    },
+    "required": ["name"],
+}
+
+Person = SchemaConverter.build(schema)
+
+obj = Person(name="Alice", age=30)
+print(obj)
+```
+
+---
+
+## ✅ Example Validations
+
+### Strings with constraints
+
+```python
+schema = {
+    "title": "EmailExample",
+    "type": "object",
+    "properties": {
+        "email": {
+            "type": "string",
+            "minLength": 5,
+            "maxLength": 50,
+            "pattern": r"^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$",
+        },
+    },
+    "required": ["email"],
+}
+
+Model = SchemaConverter.build(schema)
+obj = Model(email="user@example.com")
+print(obj)
+```
+
+### Integers with bounds
+
+```python
+schema = {
+    "title": "AgeExample",
+    "type": "object",
+    "properties": {
+        "age": {"type": "integer", "minimum": 0, "maximum": 120}
+    },
+    "required": ["age"],
+}
+
+Model = SchemaConverter.build(schema)
+obj = Model(age=25)
+print(obj)
+```
+
+### Nested Objects
+
+```python
+schema = {
+    "title": "NestedObjectExample",
+    "type": "object",
+    "properties": {
+        "address": {
+            "type": "object",
+            "properties": {
+                "street": {"type": "string"},
+                "city": {"type": "string"},
+            },
+            "required": ["street", "city"],
+        }
+    },
+    "required": ["address"],
+}
+
+Model = SchemaConverter.build(schema)
+obj = Model(address={"street": "Main St", "city": "Gotham"})
+print(obj)
+```
+
+---
+
+## 🧪 Running Tests
+
+To run the test suite:
+
+```bash
+poe tests
+```
+
+Or manually:
+
+```bash
+python -m unittest discover -s tests -v
+```
+
+---
+
+## 🛠 Development Setup
+
+To set up the project locally:
+
+1. Clone the repository
+2. Install [uv](https://github.com/astral-sh/uv) (if not already installed)
+3. Install dependencies:
+
+```bash
+uv sync
+```
+
+4. Set up git hooks:
+
+```bash
+poe create-hooks
+```
+
+---
+
+## 📌 Roadmap / TODO
+
+- [ ] Support for `enum` and `const`
+- [ ] Support for `anyOf`, `allOf`, `oneOf`
+- [ ] Schema ref (`$ref`) resolution
+- [ ] Better error reporting for unsupported schema types
+
+---
+
+## 🤝 Contributing
+
+PRs are welcome! This project uses MIT for licensing, so feel free to fork and modify as you see fit.
+
+---
+
+## 🧾 License
+
+MIT License.

pyproject.toml

@@ -3,6 +3,7 @@ name = "jambo"
 dynamic = ["version"]
 description = "Add your description here"
 requires-python = ">=3.10,<4.0"
+readme = "README.md"
 
 # Project Dependencies
 dependencies = [