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
You start by typing
flask-createproject
Which will result in an interactive prompt that asks you a couple of questions and create the project
with proper values for the setup.py
file.
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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 825e2cc736c3120151eae90ead09bb59c6c7e13e263e5629d06a179183b0f5d6 |
|
MD5 | 4f95ed20613a31bb833634438baa5667 |
|
BLAKE2b-256 | 7db033b77db4d74b4b9172f4ea70014a793c919b598b0af9d2ed7ecabdcecc9b |
Hashes for flask_createproject-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 181e822a6532a1b3df9294077063429f61a9eb5f6a2e3d92f92e296bb7d6e50a |
|
MD5 | 47e7fbeb1c16ccb95655319d1ad39c9b |
|
BLAKE2b-256 | c2d84785e56a7d0f2f07546ca3676ec5008626336779c9ff3d1c06676026a5b2 |