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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f28b722475bc57d7abdd9e530e1581810f0c296660f705a3e3465ab4b231b42 |
|
MD5 | 6325a43e487a9dee7ffbc1b7b7b1259a |
|
BLAKE2b-256 | c01b3a718d1fd4b6d8c3306a44ac6b5281d876817ac8befe1447ef4c5ab1f678 |
Hashes for flask_createproject-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c9ea02afdd4c4dfbdf20aae3c3615c2ceb0d3bb4cd2e8822456f5a3899ebbd4e |
|
MD5 | 8455cf19f67fbe3619588c4c8e9392d9 |
|
BLAKE2b-256 | a7c935c7a0766df6443a07e8e4a317bf45454df030ad7c954fb8d7b01e6d459c |