Skip to content

Commit

Permalink
automation some actions
Browse files Browse the repository at this point in the history
  • Loading branch information
@ProdByGodfather
ProdByGodfather committed Aug 19, 2024
1 parent 712391f commit c5246d7
Show file tree
Hide file tree
Showing 10 changed files with 201 additions and 380 deletions.
4 changes: 3 additions & 1 deletion .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@ venv
__pycache__
example.db
build
dist
dist
/dist
/build
189 changes: 15 additions & 174 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# abarorm


| ![abarorm Logo](abarorm/abarorm.png) | **abarorm** is a lightweight and easy-to-use Object-Relational Mapping (ORM) library for SQLite databases in Python. It aims to provide a simple and intuitive interface for managing database models and interactions. |
| ![abarorm Logo](https://prodbygodfather.github.io/abarorm/images/logo.png) | **abarorm** is a lightweight and easy-to-use Object-Relational Mapping (ORM) library for both SQLite and MySQL databases in Python. It provides a simple and intuitive interface for managing database models and interactions. |
|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

## Features

- Define models using Python classes
- Automatically handle database schema creation and management
- Support for basic CRUD operations
- Foreign key relationships
- Custom field types with validation and constraints
- **New in v1.0.0**: Automatic table creation and updates without needing explicit `create_table()` calls

## Installation

Expand All @@ -18,188 +19,28 @@ You can install **abarorm** from PyPI using pip:
```bash
pip install abarorm
```

For MySQL support, you also need to install `mysql-connector-python`:

```bash
```python
pip install mysql-connector-python
```

## Basic Usage
Here’s a quick overview of how to use **abarorm** to define models and interact with an SQLite database.

## Field Types
In **abarorm**, fields define the types of data stored in your database models. You can use built-in field types to specify the kind of data each attribute should hold. Here are the available field types and their usage:

1. **CharField**
- **Description:** Represents a text field with a maximum length.
- **Parameters:**
- `max_length` : The maximum number of characters allowed.
- `unique` : If True, the field must contain unique values across the table.
- `null` : If True, the field can contain NULL values.
- `default` : The default value if none is provided.
- **Example:**
```python
title = CharField(max_length=100, unique=True)
```
2. **DateTimeField**
- **Description:** Represents a date and time value.
- **Parameters:**
- `auto_now` : If True, the field will be automatically set to the current date and time whenever the record is updated.
- **Example:**
```python
create_time = DateTimeField(auto_now=True)
```
3. **ForeignKey**
- **Description:** Represents a many-to-one relationship between models.
- **Parameters:**
- `to` : The model that this field points to.
- `on_delete` : Defines the behavior when the referenced record is deleted. Common options include:
- `CASCADE` : Automatically delete records that reference the deleted record.
- `SET NULL` : Set the field to NULL when the referenced record is deleted.
- `PROTECT` : Prevent deletion of the referenced record by raising an error.
- `SET_DEFAULT` : Set the field to a default value when the referenced record is deleted.
- `DO_NOTHING` : Do nothing and leave the field unchanged.
- **Example:**
```python
category = ForeignKey(Category, on_delete='CASCADE')
```
4. **BooleanField**
- **Description:** Represents a Boolean value (`True` or `False`).
- **Parameters:**
- `default` : The default value for the field if none is provided.
- `null` : if `True`, the field can contain `NULL` values.
- **Example:**
```python
is_active = BooleanField(default=True)
```
5. **IntegerField**
- **Description:** Represents an integer value.
- **Parameters:**
- `default` : The default value for the field if none is provided.
- `null` : If True, the field can contain NULL values.
- **Example:**
```py
age = IntegerField(default=0)
```

## Defining Models
Create a new Python file (e.g., `models.py`) and define your models by inheriting from `SQLiteModel` for SQLite or `MySQLModel` for MySQL. Update your database configuration accordingly.


**Example for SQLite:**
```python
from abarorm import SQLiteModel
from abarorm.fields import CharField, DateTimeField, ForeignKey

DATABASE_CONFIG = {
'sqlite': {
'db_name': 'example.db', # Name of the SQLite database file
}
}

class Category(SQLiteModel):
table_name = 'categories'
title = CharField(max_length=200, unique=True)
def __init__(self, **kwargs):
# Initialize the Category model with database configuration
super().__init__(db_config=DATABASE_CONFIG['sqlite'], **kwargs)

class Post(SQLiteModel):
table_name = 'posts'
title = CharField(max_length=100, unique=True)
create_time = DateTimeField(auto_now=True)
category = ForeignKey(Category)
def __init__(self, **kwargs):
# Initialize the Category model with database configuration
super().__init__(db_config=DATABASE_CONFIG['sqlite'], **kwargs)
```
**Example for MySQL:**
```python
from abarorm import MySQLModel
from abarorm.fields import CharField, DateTimeField, ForeignKey

DATABASE_CONFIG = {
'mysql': {
'host': 'localhost',
'user': 'your_user',
'password': 'your_password',
'db_name': 'example_db', # MySQL database name
}
}

class Category(MySQLModel):
table_name = 'categories'
title = CharField(max_length=200, unique=True)
Here’s a quick overview of how to use **abarorm** to define models and interact with an SQLite or MySQL database.

def __init__(self, **kwargs):
super().__init__(db_config=DATABASE_CONFIG['mysql'], **kwargs)

class Post(MySQLModel):
table_name = 'posts'
title = CharField(max_length=100, unique=True)
create_time = DateTimeField(auto_now=True)
category = ForeignKey(Category)
## Documentation
For detailed documentation, examples, and advanced usage, please visit the [official abarorm documentation website](https://prodbygodfather.github.io/abarorm/).

def __init__(self, **kwargs):
super().__init__(db_config=DATABASE_CONFIG['mysql'], **kwargs)
```

## Creating Tables
Create the tables in the database by calling the `create_table` method on your model classes:

```python
if __name__ == "__main__":
Category.create_table()
Post.create_table()
```
## Adding Data
You can add new records to the database using the `create` method:
```python
# Adding a new category
Category.create(title='Movies')

# Adding a new post
category = Category.get(id=1) # Fetch the category with ID 1
if category:
Post.create(title='Godfather', category=category.id)
```
## Querying Data
Retrieve all records or filter records based on criteria:

```python
# Retrieve all posts
all_posts = Post.all()
print("All Posts:", [(post.title, post.category) for post in all_posts])

# Retrieve a specific post
post_data = Post.get(id=1)
if post_data:
print("Post with ID 1:", post_data.title, post_data.category)

# Filter posts by category
filtered_posts = Post.filter(category=category.id)
print("Filtered Posts:", [(post.title, post.category) for post in filtered_posts])
```
## Updating Records
Update existing records with the `update` method:
```python
Update existing records with the update method:
```
## Deleting Records
Delete records using the `delete` method:
```python
Post.delete(1)
```
## Version 1.0.0 Notes
**Automatic Table Management:** Tables are now automatically created or updated based on model definitions without manual intervention.
**Important for Developers:** During development, when adding new fields to models, they will default to `NULL`. It's recommended to recreate the database schema after development is complete to ensure fields have appropriate constraints and default values.

## Contributing
Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on [github](https://github.com/prodbygodfather/abarorm).
Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on GitHub.

## License
This project is licensed under the MIT License - see the [License](https://github.com/ProdByGodfather/abarorm/blob/main/LICENSE) file for details.
This project is licensed under the Apache-2.0 [License](https://github.com/ProdByGodfather/abarorm/blob/main/LICENSE) - see the LICENSE file for details.

## Acknowledgements

- **Python**: The language used for this project
- **SQLite**: The database used for this project
- **setuptools**: The tool used for packaging and distributing the library
**Python:** The language used for this project
**SQLite & MySQL:** The databases supported by this project
**setuptools:** The tool used for packaging and distributing the library
Loading

0 comments on commit c5246d7

Please sign in to comment.