https://github.com/getpavo/treeshake
Automatically optimize unused CSS. Drastically improve loading times and file size.
https://github.com/getpavo/treeshake
css css-python django flask jackman optimize stylesheets styling
Last synced: about 2 months ago
JSON representation
Automatically optimize unused CSS. Drastically improve loading times and file size.
- Host: GitHub
- URL: https://github.com/getpavo/treeshake
- Owner: getpavo
- License: mit
- Created: 2021-04-28T14:11:07.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-09T16:41:10.000Z (over 4 years ago)
- Last Synced: 2025-03-08T21:51:32.065Z (10 months ago)
- Topics: css, css-python, django, flask, jackman, optimize, stylesheets, styling
- Language: Cython
- Homepage:
- Size: 620 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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](https://cython.readthedocs.io/) and allows you to get the best performance out of your (potentially) bloated web applications.
## Installation
It is recommended to install treeshake via pip:
```commandline
pip install treeshake
```
## Command Line Support
To quickly use treeshake, call it via command line:
```commandline
shake
python3 -m treeshake
```
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.
```python
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](https://github.com/jackmanapp/treeshake/blob/main/CONTRIBUTING.md) for more information.