restfulpy

A tool-chain for creating restful web applications.

Goals:

• Automatically transform the SqlAlchemy models and queries into JSON with standard naming(camelCase).
• Http form validation based on SqlAlchemy models.
• Scaffolding: restfulpy scaffold -h

Branching

A new branching model is applied to this repository, which consists of a master branch and release branches.

Master branch

The master branch is an integration branch where bug fixes/features are gathered for compiling and functional testing.

Release branch

The release branch is where releases are maintained and hot fixes (with names like release/v2.x.x) are added. Please ensure that all your production-related work are tracked with the release branches.

With this new model, we can push out bug fixes more quickly and achieve simpler maintenance.

Install

PyPI

pip install restfulpy

Development

pip install -e .
pip install -r requirements-dev.txt

Run tests to ensure everything is ok:

pytest

Command line interface

restfulpy -h

Autocompletion

restfulpy autocompletion install

Scaffolding

restfulpy scaffold \
    --template full 
    --directory path/to/target \
    project1 \
    [email protected]

Follow the path/to/target/README.md to know how to use the newly created project.

Single file template

If you have generated your application by --template singlefile option, you can run it by:

nanohttp path/to/application/project1.py

Or you can make your application executable by following command:

chmod +x path/to/application/project1.py

Now run your application by:

path/to/application/project1.py