Metadata-Version: 2.1
Name: hojo
Version: 0.1.0
Summary: Hojo: An ORM built on top of SQL Alchemy
License: MIT
Author: Rafael Izidoro
Author-email: izidoro.me@gmail.com
Requires-Python: >=3.11,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: SQLAlchemy (>=2.0.23,<3.0.0)
Requires-Dist: alembic (>=1.13.0,<2.0.0)
Requires-Dist: marshmallow (>=3.20.1,<4.0.0)
Requires-Dist: marshmallow-dataclass[enum,union] (>=8.6.0,<9.0.0)
Requires-Dist: pg8000 (>=1.30.3,<2.0.0)
Requires-Dist: pluralizer (>=1.2.0,<2.0.0)
Requires-Dist: stringcase (>=1.2.0,<2.0.0)
Requires-Dist: uuid6 (>=2023.5.2,<2024.0.0)
Description-Content-Type: text/markdown

# Hojo - An Opinionated ORM on Top of SQL Alchemy

Hojo is a library that simplifies the usage of SQL Alchemy, providing an interface that is familiar to Django users. While it is not an exact replication of the Django ORM API, it strives to be reminiscent of it, making it easier for Django developers to work with SQL Alchemy.

**Please note that this library is currently in Alpha version and is not yet ready for production use.**

## Installation

You can install Hojo using pip:

```bash
pip install hojo
```

## Basic Usage
Here's a basic example of how to use Hojo:


```python
from hojo import BaseModel, dataclass

@dataclass
class Soldier(BaseModel):
    name: str
    weapon: str

# Create a Soldier instance
hero = Soldier(name='Cloud', weapon='Buster Sword') 

# Insert the hero into the 'soldiers' table
Soldier.objects.create(hero)

# Retrieve a Soldier with the name 'Cloud' from the 'soldiers' table
cloud = Soldier.objects.filter(name='Cloud')

```
    
