Remove unused css in Python projects with C-powered tree shaking.
Project description
Treeshake
Ever used a CSS framework and cried about all the overhead it caused? Ever wrote so much CSS that you were no longer aware what parts of it were actually used? Fear no more. Just use treeshake before deployment and all of your troubles will melt away.
Dead code elimination
Tree shaking is a concept mostly used in ECMAScript languages like Dart, JavaScript and Typescript that helps to eliminate unused code. Optimizing your code in a single bundle.
This project aims to bring the power of tree shaking for css to your Python projects. This small library is written in Cython and allows you to get the best performance out of your (potentially) bloated web applications.
Installation
It is recommended to install treeshake via pip:
pip install treeshake
Command Line Support
To quickly use treeshake, call it via command line:
shake <css dir> <html dir>
python3 -m treeshake <css dir> <html directory>
If you wish to see an interactive prompt, just use shake or python3 -m treeshake. The current support is only for a single directory.
To see help, please run: shake -h.
Quick example
The following piece of codes recursively adds all css files from /styles/ and all html files from /html and compares the contents. Where possible, it will eliminate styling.
The new file is written to the /out/ output directory.
from treeshake import Shaker
treeshaker = Shaker()
treeshaker.discover_add_stylesheets('./styles/', True)
treeshaker.discover_add_html('./html/', True)
treeshaker.optimize('./out')
Contributing
Any contribution to this project is very welcome. Please open an issue when you are dealing with a problem or want to discuss a feature. All contributions are handled by pull requests.
Please refer to CONTRIBUTING.md for more information.
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 treeshake-0.2.4.tar.gz.
File metadata
- Download URL: treeshake-0.2.4.tar.gz
- Upload date:
- Size: 94.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 88e173e23c39ea3de67939932c1b18ac7517104ff70a7392db8d788a12b8c4e5 |
|
| MD5 | 7044fbf6dcf25e4107a060333423098f |
|
| BLAKE2b-256 | 465877bd9227c6381ed182e9dedd3fae08f9488da1efc574c2ed84dafb5fcc21 |
File details
Details for the file treeshake-0.2.4-cp39-cp39-macosx_11_0_x86_64.whl.
File metadata
- Download URL: treeshake-0.2.4-cp39-cp39-macosx_11_0_x86_64.whl
- Upload date:
- Size: 106.2 kB
- Tags: CPython 3.9, macOS 11.0+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f1e6281daeb3a3dfcd5559f803aac9a0b7e1897c36ac51bc63485a5992a527da |
|
| MD5 | 5c720f74ff1e2a3e0e895c64adfac341 |
|
| BLAKE2b-256 | 1935f6c73dfa1a0746ec2ef5a1872b1a3011d452e3f120b5b20895b1442f2ddd |
