v0.12.1

This release introduces a significant improvement to the project's documentation by migrating from the basic README-based documentation to a more robust and visually appealing setup using Material for MkDocs. This change enhances the overall user experience by providing a structured, easy-to-navigate, and professionally styled documentation site.

---

Added

• Material for MkDocs Documentation:
  • Replaced the old README-based documentation with a new site built using Material for MkDocs.
  • Added a clear navigation structure to help users easily find information and examples.
  • Included detailed documentation sections covering installation, usage, and complex features like filtering with Q objects.
  • Set up GitHub Actions for automatic deployment of the documentation site.

Refactoring

• Documentation Overhaul:
  • Removed most of the old documentation from the README and streamlined it to point to the new, comprehensive documentation site.
  • Enhanced formatting, readability, and structure across all documentation files using markdown extensions specific to MkDocs.

Features and Roadmap

• Define table schema using Pydantic models
• Basic CRUD operations
  • Save data to the database
  • Read data from the database
  • Update data in the database
  • Delete data from the database
• Relationships between tables
  • One-to-many
    • Create a tables with a foreign key
    • Save data with a foreign key
    • Read data with a foreign key
    • Update data with a foreign key
    • Delete data with a foreign key
      • Cascade
      • Set null
      • Restrict
      • Set default
      • No action
  • One-to-one
  • Many-to-many
• Unique constraints
• Remove table
• Read all data from the database
• Filter data and retrieve multiple records
  • Equal
  • Not equal
  • Greater than
  • Greater than or equal
  • Less than
  • Less than or equal
  • Like (Pattern matching with % and _)
  • Not like (Pattern matching with % and _)
  • In (List of values)
  • Not in (List of values)
  • Between (Two values)
  • Not between (Two values)
  • Q objects to combine filters (AND, OR, NOT)
• Protect against SQL injection
• Order by
• Limit and offset
• Update table schema
  • Add new column
  • Rename column
  • Drop column
• Custom primary key
• Functions
  • Aggregate functions
  • String functions
  • Date and time functions
  • Mathematical functions
  • Control flow functions
• Bulk operations (save, update, delete)
• Migrations

Full Changelog: v0.12.0...v0.12.1