Flask-based app for managing IPTV sources
Minimum required version of python: 3.8
When you cloned project for the first time and want to start developing (or just play around) you have to do the following actions to deploy the project:
# create the file `.env` with configuration (don't forget edit database URI)
# (you can use `.env.example` as a starting point)
cp .env.example .env
# initialize environment, database, execute tests and run the app
make init && ./cli db upgrade && make test lint run
# now you can access the app by following address:
# http://<ip_address_of_your_server>:8000/
Full list of commands to deploy the project for development
# create the file `.env` with configuration
# (you can use `.env.example` as a starting point)
cp .env.example .env
# configure the virtual environment
python3 -m venv .venv
# activate the virtual environment
source .venv/bin/activate
# install the required packages
pip install -r requirements.txt
# run database migrations
./cli db upgrade
# install npm-packages
npm install
# build the frontend
npm run build
# make the cli-manager executable
chmod +x ./cli
# run backend via development server
./cli run --host=0.0.0.0 --port=8000
# now you can access the app by following address:
# http://<ip_address_of_your_server>:8000/
The project have Makefile with shortcuts to execute some routine and everyday commands. Here is the list of these commands with short description:
# creates .venv, installs backend & frontend dependencies and does other initialization
make init
# removes .venv, logs, node_modules, pycache and other files
make clean
# executes basic (critial) code linging and run tests
make test
# executes full code linting
make lint
# runs the development server
make run
# sometimes there is handy to execute some commands together:
# - re-deploy the project: `make clean init`
# - run all checks: `make lint test`
# also you can alway run `make all` to see all available shortcuts
There are available some cli-commands to interact with. For example, you can run server for development like this:
./cli run --host=0.0.0.0 --port=8000
This command will run server provided by Flask on port 8000
and the application will be available by address http://192.168.1.2:8000
if your host machine has ip address 192.168.1.2. But don't use this server
in production!
NOTE: before using ./cli directly, you should make it executable (chmod +x ./cli).
Otherwise use this way: python ./cli
Other CLI-commands are described below by groups.
CLI-commands related to testing
# run all tests with detailed information
./cli test:run
# run all tests quietly
./cli test:run -q
# run only modular tests
./cli test:run --modular-only
# run only those tests which are testing web-pages
./cli test:run --web-only
# show code coverage
./cli test:coverage
# list all fixtures
./cli test:fixtures
# list all markers
./cli test:markers
# run code linting
./cli test:lint
# run only critical code linting
./cli test:lint --critical
CLI-commands for interacting with database
# initializing of migrations repository
./cli db init
# run all migrations that have not ran yet
./cli db upgrade
# show sql-code which is going to be executed
./cli db upgrade --sql
# migrate to specific mugration
./cli db upgrade <REVISION_HASH>
# create new migration-file with name
./cli db revision -m "Some new migration"
# revert to previous version
./cli db downgrade
# revert all migrations
./cli db downgrade base
# show list of migrations that already ran
# If flag `-i` specified - indicates what revision is current
./cli db history [-i]
# show detailed list of migrations
./cli db show
Only following packages have been installed manually.
Other packages described in requirements.txt have been added as dependencies of these packages.
Flask
pytest
coverage
python-dotenv
flake8
Flask-SQLAlchemy
Flask-Migrate
PyMySql
Flask-Restful