reactant 0.4.0

Generate code for models, views, and urls based on Python type annotations.

Generate code for models, views, and urls based on Python type annotations. Powered by pydantic. Influenced by SQLModel.

reactant aims to give usable and sensible code defaults. It does not enforce a particular application structure. Instead, it follows the default/minimal/common structure of the supported frameworks, and the developer has the freedom of changing it (if necessary) to fit it to their application. Contributions are warmly welcomed if you believe a particular structure is widely used and can benefit from code generation.

Supported Frameworks

reactant currently generates code for the following:

Django REST (in Django's default project structure i.e. by apps)

• models
• views (class-based API views, filename=views_class.py)
• views (function-based API views, filename=views_func.py)
• serializers
• urls (from class-based API views, filename=urls_class.py)
• urls (from function-based API views, filename=urls_func.py)

Flask

• models (Flask-SQLAlchemy)

SQLAlchemy

• models in Declarative Mapping

Peewee

• models

Installation

$ pip install reactant

NOTE: reactant isn't shipped with the supported frameworks. You MUST install django, sqlalchemy, peewee, or flask separately (be it in a virtual environment or globally).

Get Started

Create reactant models by inheriting from Reactant subclasses: DjangoORM, SQLAlchemyORM, PeeweeORM. The example below uses DjangoORM. Your choice will determine what code and files will be generated.

# generate.py

from typing import Optional
from reactant import DjangoORM, Field, generate
from datetime import date


class RocketEngine(DjangoORM):
    name: str = Field(max_length=32, title="engine_name")
    manufacturer: Optional[str]
    power_cycle: Optional[str] = "gas-generator"
    thrust_weight_ratio: Optional[int] = None


class LaunchVehicle(DjangoORM):
    name: str = Field(max_length=32)
    country: str = Field("USA", max_length=32)
    status: str
    total_launches: Optional[int]
    first_flight: Optional[date]
    engine: str = Field(foreign_key="RocketEngine")

# Don't forget this block.
if __name__ == "__main__":
    generate()

Don't forget generate(). Run the code.

Tip: You can control what code and files will be generated by passing keyword arguments to generate(). Read the The generate() function section below for the details.

$ reactant generate.py

Running generate.py
Found 2 Django reactants.
Django models.py finished rendering.
Django serializers.py finished rendering.
Django views_class.py finished rendering.
Django urls_class.py finished rendering.
Django views_func.py finished rendering.
Django urls_func.py finished rendering.
Success! Please check "reactant_products/django" directory.

BOOM! With just the above code, the models, views, serializers, and urls (the products, for Django atleast) are generated. See images of the code below.

Sample Code Generated

Django REST

The generate() function

The generate() function can accept keyword arguments to control the behavior of generating code and files. Read below to learn what each supported framework accepts.

Django REST

By default, both function-based and class-based views are generated. To switch OFF either of the two, pass class_based=False or function_based=False.

Development

The project uses Poetry to package and manage dependencies.

(venv)$ poetry install

Run tests.

pytest

License

MIT License. For more information and legal terms, see the LICENSE file.