A utility program to bootstrap flask projects
Project description
About
flask-createproject
is a tool that bootstraps a new Flask project
by creating the bare-minimum structure for a production ready project.
It is inspired by the django-admin startproject
tool.
Running the tool prompts you for
- The project's name.
- The project's main app.
- The author's name and email.
- The project's description.
This is then used to create the project structure along with the necessary
setup.py
for packaging your application.
Installation
pip install flask-createproject
Usage
flask-createproject
Development
pip-tools
is used for tracking the requirements and creating the development and release enviroments.
The requirements are kept in requirements.in
and requirements-dev.in
and compiled into requirements.txt
and requirements-dev.txt
that could be later installed to the env.
A couple of useful make
targets are defined.
Creating the development environment.
python3.9 -m venv .venv
source .venv/bin/activate
make install-requirements-dev
Adding a new requirement
- add a new entry to the
requirements.in
orrequirements-dev.in
file (or both !) - run the command
make compile-requirements
Running the tests.
- Pytest is used and the configurations are defined in
setup.cfg
. - You can run the tests by running the command
pytest
Contribution
Please feel free to open Pull Requests/ issues as needed :-)
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.
Source Distribution
Built Distribution
Hashes for flask-createproject-0.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8ff878547065db042dac6226c7f15767bc575d41b1178f2c232e532d1865bcd |
|
MD5 | b0c193f48d3113663251230c2cfc93ae |
|
BLAKE2b-256 | e31e481cc422d8c549743663a60e4cf81699ac01eb84cac41d954ce13dc92ab0 |
Hashes for flask_createproject-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1af0f7c1d7399cceaef298690b6d0dca76ac3310f01c9731ebb3dc8acf1a6b87 |
|
MD5 | ac051358c0962cb9fb74571acad3d739 |
|
BLAKE2b-256 | ae6ed52c2e1784945d2058b8a3b6ec7426a21cb5822df292f71835a77e89fd6c |