No project description provided
Project description
Flask Project Template
A full feature Flask project template.
See also
- Python-Project-Template for a lean, low dependency Python app.
- FastAPI-Project-Template The base to start an openapi project featuring: SQLModel, Typer, FastAPI, JWT Token Auth, Interactive Shell, Management Commands.
HOW TO USE THIS TEMPLATE
DO NOT FORK this is meant to be used from Use this template feature.
- Click on Use this template
- Give a name to your project
(e.g.my_awesome_project
recommendation is to use all lowercase and underscores separation for repo names.) - Wait until the first run of CI finishes
(Github Actions will process the template and commit to your new repo) - If you want codecov Reports and Automatic Release to PyPI
On the new repositorysettings->secrets
add yourPIPY_API_TOKEN
andCODECOV_TOKEN
(get the tokens on respective websites) - Read the file CONTRIBUTING.md
- Then clone your new project and happy coding!
NOTE: WAIT until first CI run on github actions before cloning your new project.
What is included on this template?
- 🍾 A full feature Flask application with CLI, API, Admin interface, web UI and modular configuration.
- 📦 A basic setup.py file to provide installation, packaging and distribution for your project.
Template uses setuptools because it's the de-facto standard for Python packages, you can runmake switch-to-poetry
later if you want. - 🤖 A Makefile with the most useful commands to install, test, lint, format and release your project.
- 📃 Documentation structure using mkdocs
- 💬 Auto generation of change log using gitchangelog to keep a HISTORY.md file automatically based on your commit history on every release.
- 🐋 A simple Containerfile to build a container image for your project.
Containerfile
is a more open standard for building container images than Dockerfile, you can use buildah or docker with this file. - 🧪 Testing structure using pytest
- ✅ Code linting using flake8
- 📊 Code coverage reports using codecov
- 🛳️ Automatic release to PyPI using twine and github actions.
- 🎯 Entry points to execute your program using
python -m <open_download_manager>
or$ open_download_manager
with basic CLI argument parsing. - 🔄 Continuous integration using Github Actions with jobs to lint, test and release your project on Linux, Mac and Windows environments.
Curious about architectural decisions on this template? read ABOUT_THIS_TEMPLATE.md
If you want to contribute to this template please open an issue or fork and send a PULL REQUEST.
open_download_manager Flask Application
Awesome open_download_manager created by cmmeyer1800
Installation
From source:
git clone https://github.com/cmmeyer1800/open_download_manager open_download_manager
cd open_download_manager
make install
From pypi:
pip install open_download_manager
Executing
This application has a CLI interface that extends the Flask CLI.
Just run:
$ open_download_manager
or
$ python -m open_download_manager
To see the help message and usage instructions.
First run
open_download_manager create-db # run once
open_download_manager populate-db # run once (optional)
open_download_manager add-user -u admin -p 1234 # ads a user
open_download_manager run
Go to:
- Website: http://localhost:5000
- Admin: http://localhost:5000/admin/
- user: admin, senha: 1234
- API GET:
Note: You can also use
flask run
to run the application.
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 open_download_manager-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a9f248498ef862c73e2a7368a80ea3f792b1aa70e7b8672009db76e4c9a4f62d |
|
MD5 | 85e00ea5eba08e1eaa572cd31a8afee4 |
|
BLAKE2b-256 | 4e6dc5f6b5d4a46a0a6698f34a900b864290bb81d23197b3af5bac75d985e7d1 |
Hashes for open_download_manager-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe52c0abfaecec96498b36bf25dbbd161f222e16f56092b626ba6fb9ff22a136 |
|
MD5 | c216d3323810429d5fb21d3e29bbdfa2 |
|
BLAKE2b-256 | 49a9a2ff1fd42a552620ab81e16042353c3fa459e0ebfef1b17147661589f43b |