A simple package that enables livereload and tailwindcss for flask templates.
Project description
Flask live tailwindcss
A simple package for adding a dev server to your flask app that automatically compiles the tailwindcss of the templates on file save and triggers a browser reload to sync the changes on the fly.
Installation
# using poetry
poetry add --group=dev flask-livetw
# using pip
pip install flask-livetw
Initialization
To start using this package, simply go to your project root folder, run the following command and follow along the steps.
# using poetry
poetry shell
flask-livetw init
# using pip
"activate your virtual environment like you normally do"
flask-livetw init
Note 1: To skip requirements check use the
-Y
or--yes
flag.Note 2: To use default values for the initialization use the
-D
or--default
flag.
Default values
FLASK_ROOT = "src"
STATIC_FOLDER = "src/static"
TEMPLATE_FOLDER = "src/templates"
TEMPLATE_GLOB = "src/templates/**/*.html"
ROOT_LAYOUT_FILE = "src/templates/layout.html"
LIVE_RELOAD_FILE = "src/static/.dev/live_reload.js"
GLOBALCSS_FILE = "src/static/.dev/global.css"
TAILWIND_FILE = "src/static/.dev/tailwind.css"
MINIFIED_TAILWIND_FILE = "src/static/tailwind_min.css"
UPDATE_GITIGNORE = False
Example as file system tree:
project_root
├── src
│ ├── static
│ │ ├── .dev
│ │ │ ├── global.css
│ │ │ ├── live_reload.js
│ │ │ └── tailwind.css
│ │ ├── tailwind_min.css
│ │ ...
│ └── templates
│ ├── layout.html
│ ...
├── .gitignore
├── pyproject.toml
...
Commands
In order to use the commands, you need to activate your virtual environment first.
# using poetry
poetry shell
# using pip
"activate your virtual environment like you normally do"
Each command has its own help page, you can use the -h
or --help
flag to see the available options.
dev
flask-livetw dev
By default the command starts:
- a flask server in debug mode
- a live reload websocket server
- a tailwindcss in watch mode
build
Builds the tailwindcss of the templates as a single css file.
flask-livetw build
By default the builded tailwindcss file will be minified.
local-install
flask-livetw local-install
This command creates a local script that mimics the flask-livetw
command and installs the necessary dependencies.
After the installation, you can use the dev
and build
commands as follows:
./dev.py dev
./dev.py build
Contributing
Contributions are welcome, feel free to submit a pull request or an issue.
Packages used
License
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_livetw-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b85eb41a6b0afeff301060e34aff94044530a6831546819e77af6b2f59e19fe |
|
MD5 | fb663bd864dfc06de139015570c8e4fc |
|
BLAKE2b-256 | 358c47ef7a999985cb099b829eed3ddbbb23329efcd85aee6cd67c9ec506155d |