peewee Documentation Release 1.0.0

# Peewee Documentation Summary (Version 1.0.0) ## Overview Peewee is a lightweight Object-Relational Mapping (ORM) library written in Python. It provides a simple abstraction layer over SQL and supports various database systems, including SQLite, PostgreSQL, and MySQL. While it does not natively support automatic schema migrations, it offers helper functions for database operations and integrates seamlessly with frameworks like Flask. --- ## Key Features ### 1. **Database Integration** - **SQLite**: Uses `SqliteDatabase` with optional thread-local connections for multi-threaded applications. - **PostgreSQL**: Uses `PostgresqlDatabase` with support for advanced features like hstore and full-text search. - **MySQL**: Uses `MySQLDatabase` with standard SQL operations. ### 2. **Querying API** - Peewee supports chainable query construction, allowing complex SQL queries to be built incrementally. - Example queries: - Select active users: `User.select().where(User.active == True).count()` - Filter tweets by editors: `Tweet.select().where(Q(user__is_staff=True) | Q(user__is_superuser=True))` - Join and filter operations: `Tweet.select().join(User).where((Tweet.pub_date >= today) & (User.active == True))` ### 3. **Model Definitions** - Models are defined declaratively, similar to Django's ORM. - Example models include: - `User`: Stores username, password, email, and creation date. - `Relationship`: Represents a "follow" relationship between users. - `Message`: Stores message content, creation date, and the posting user. ### 4. **Field Types** Peewee supports various field types with database-specific implementations: - **CharField**: Stores strings with specified lengths. - **TextField**: Stores long text. - **DateTimeField**: Stores timestamps. - **IntegerField**: Stores integers. - **BooleanField**: Stores True/False values. - **ForeignKeyField**: Establishes relationships between models. ### 5. **Database Configuration** - Models can specify a custom database using the `Meta` class. - Example: ```python class CustomModel(peewee.Model): class Meta: database = custom_db ``` ### 6. **Flask Integration** - Peewee ships with an example Flask web app that demonstrates integration with an admin interface and RESTful API. - Requirements can be installed using `pip install -r requirements.txt`. --- ## Installation - **Using pip**: `pip install peewee` - **Using Git**: Clone the repository and install using `python setup.py install`. - **Testing**: Run the test suite with `python setup.py test`. --- ## Example App - The example app demonstrates Peewee's functionality with a Twitter-clone-like application. - Running the app: ```bash cd example/ pip install -r requirements.txt python run_example.py ``` --- ## Conclusion Peewee is designed to be simple and flexible, making it ideal for small to medium-sized projects. Its lightweight design and support for multiple database systems make it a versatile choice for developers. For more advanced use cases, extensions like `flask-peewee` can be used for Flask integration.