abarorm is a lightweight and easy-to-use Object-Relational Mapping (ORM) library for SQLite & PostgreSQL and MySQL databases in Python. It aims to provide a simple and intuitive interface for managing database models and interactions.
Project description
abarorm
abarorm is a lightweight and easy-to-use Object-Relational Mapping (ORM) library for SQLite, MySQL, and PostgreSQL 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 - New in v2.0.0: Added support for PostgreSQL databases
- New in v2.0.0: Ordering by fields on
all()
method
Installation
You can install abarorm from PyPI using pip:
pip install abarorm
For MySQL support, you also need to install mysql-connector-python
:
pip install mysql-connector-python
For PostgreSQL support, you need to install psycopg2-binary
:
pip install psycopg2-binary
Basic Usage
Here’s a quick overview of how to use abarorm to define models and interact with an SQLite or MySQL database.
Documentation
For detailed documentation, examples, and advanced usage, please visit the official abarorm documentation website.
Version 2.0.0 Notes
PostgreSQL Support: abarorm now supports PostgreSQL databases in addition to SQLite and MySQL.
Automatic Table Management: Tables are created or updated automatically based on model definitions without manual intervention.
Important for Developers: 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.
License
This project is licensed under the Apache-2.0 License - see the LICENSE file for details.
Acknowledgements
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 psycopg2-binary: The PostgreSQL adapter used for connecting to PostgreSQL databases
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.