Easily use tailwind css with Flask projects
Project description
Flask-Tailwind-Manager
Flask-Tailwind-Manager provides a simple interface to use TailwindCSS with your Flask project. It will let you hide it in a folder called .tailwind so you dont have to see any node_modules or any other javascript. Even tho you DO need npm and npx to be available on your machine.
🚧 This package is under heavy development..
Installation
Install the extension with pip:
pip install flask-tailwind-manager
Configuration
This are some of the settings available. All of the configurations are optional, and in most cases it should work without any configuration.
| Config | Description | Type | Default |
|---|---|---|---|
| TAILWIND_CWD | CWD for node_modules. | str | .tailwind |
| TAILWIND_OUTPUT_PATH | CSS file output path inside app static. | str | css/style.css |
| TAILWIND_NPM_BIN_PATH | Npm binary path. | str | npm |
| TAILWIND_NPX_BIN_PATH | Npx binary path. | str | npx |
| TAILWIND_TEMPLATE_FOLDER | Name of the templates folder. | str | templates |
Usage
Once installed Flask-TailwindCSS is easy to use. Let's walk through setting up a basic application. Also please note that this is a very basic guide: we will be taking shortcuts here that you should never take in a real application.
To begin we'll set up a Flask app:
from flask import Flask
from flask_tailwind import TailwindCSS
app = Flask(__name__)
tailwind = TailwindCSS()
tailwind.init_app(app)
Using the CLI tool.
Once you completed the extension configuration, you can access the Flask-TailwindCSS CLI tool. There is 4 useful commands you will use.
- Installing Node and TailwindCSS basic configuration. By default this extension will generate a
tailwind.config.jsgeneric file, ready to use. If you need to futher customize you will need to edit this file accordingly.
flask tailwind init
-
Once installed all modules will be found on
.tailwindfolder (or CWD you define). The default configuration will look for changes at{APP_NAME}/**/{TEMPLATES_FOLDER}/*{.html,.jinja,.j2}. You can always modifytailwind.config.jsfile in order to customize it. -
To start watching files and changes. use the
startcommand as follows.
flask tailwind start
- Almost every time you are using you will install plugins like Preline, Flowbite, daysiUI, etc... For this cases you can use the
npxornpmcommands. In the following example we will install the PrelineUI plugin as follows.
flask tailwind npm i preline
- After the installation you will have to configure it manually.
This will ensure the plugins are installed in the correct CWD.
Load resources
Once the extension is set up, this will make available the tailwind_css function into the templates context so you could load the generated css like this.
<head>
{{ tailwind_css() }}
</head>
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
File details
Details for the file flask_tailwind_manager-0.0.11.tar.gz.
File metadata
- Download URL: flask_tailwind_manager-0.0.11.tar.gz
- Upload date:
- Size: 10.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e0eec0db056af94f5f5e7bafa3e8c6fe2e143bff987efa34923c8cc4c4386648 |
|
| MD5 | 7fb53652ab75e2f36876efa91b3a7134 |
|
| BLAKE2b-256 | 94b7fbb0b92d476e05bc94936f218e502987ed139af851b8e38bfcf3a77b6783 |
File details
Details for the file flask_tailwind_manager-0.0.11-py3-none-any.whl.
File metadata
- Download URL: flask_tailwind_manager-0.0.11-py3-none-any.whl
- Upload date:
- Size: 9.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 31fa0694d3d82cc9ccc833a03f38e2d69f69663212bb044ff89c3f47d20a9b79 |
|
| MD5 | 7f0a97328750a4ba3c019adbff41fee2 |
|
| BLAKE2b-256 | 996599ec8f8b1f576a56a201897afac35d7a1b743c4f72402dd704089601fb4e |
