| Name | django-tailwind-cli JSON |
| Version |
2.3.0
JSON |
| download |
| home_page | None |
| Summary | Django and Tailwind integration based on the prebuilt Tailwind CSS CLI. |
| upload_time | 2023-08-11 20:51:48 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
css
django
tailwind
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# django-tailwind-cli
[](https://pypi.org/project/django-tailwind-cli/)
[](https://github.com/psf/black)
[](https://github.com/pypa/hatch)
This library provides an integration of [Tailwind CSS](https://tailwindcss.com) for Django that is using on the precompiled versions of the [Tailwind CSS CLI](https://tailwindcss.com/blog/standalone-cli).
The goal of this library is to provided the simplest possible Tailwind integration for your Django project. It took its inspiration from the [Tailwind integration for Phoenix](https://github.com/phoenixframework/tailwind) which completely skips the neccesity of a node installation.
## Installation
1. Install the library.
```shell
python -m pip install django-tailwind-cli
```
2. Add `django_tailwind_cli` to `INSTALLED_APPS` in `settings.py`.
```python
INSTALLED_APPS = [
# other Django apps
"django_tailwind_cli",
]
```
3. Configure the `STATICFILES_DIRS` parameter in your `settings.py` if not already configured.
```python
STATICFILES_DIRS = [BASE_DIR / "assets"]
```
4. Add template code.
```htmldjango
{% load tailwind_cli %}
...
<head>
...
{% tailwind_css %}
...
</head>
```
5. Start the debug server.
```shell
python manage.py tailwind runserver
```
Enjoy!
## Features
- Simplest possible integration.
- Management commands:
- To start the Tailwind CLI in watch mode during development.
- To build the production grade CSS file for your project.
- To start a debug server along with the Tailwind CLI in watch mode in a single session.
- Necessary configuration to adapt the library to your project, when the defaults don't fit you.
- A template tag to include the Tailwind CSS file in your project.
- A base template for your project.
- A sane tailwind.config.js that activates all the official plugins and includes a simple HTMX plugin.
## Requirements
Python 3.8 or newer with Django >= 3.2.
## Documentation
The documentation can be found at [https://django-tailwind-cli.andrich.me/](https://django-tailwind-cli.andrich.me/)
## Contributing
If you want to contribute to this project, checkout the [development guide](https://django-tailwind-cli.andrich.me/development/) for details to get your dev environment up and running.
## License
This software is licensed under [MIT license](https://github.com/oliverandrich/django-tailwind-cli/blob/main/LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "django-tailwind-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "css,django,tailwind",
"author": null,
"author_email": "Oliver Andrich <oliver@andrich.me>",
"download_url": "https://files.pythonhosted.org/packages/2a/da/404b5ecbf1fc5a35a13ad0a0437089da7997797332fcf96338f3c201743a/django_tailwind_cli-2.3.0.tar.gz",
"platform": null,
"description": "# django-tailwind-cli\n\n\n[](https://pypi.org/project/django-tailwind-cli/)\n[](https://github.com/psf/black)\n\n[](https://github.com/pypa/hatch)\n\nThis library provides an integration of [Tailwind CSS](https://tailwindcss.com) for Django that is using on the precompiled versions of the [Tailwind CSS CLI](https://tailwindcss.com/blog/standalone-cli).\n\nThe goal of this library is to provided the simplest possible Tailwind integration for your Django project. It took its inspiration from the [Tailwind integration for Phoenix](https://github.com/phoenixframework/tailwind) which completely skips the neccesity of a node installation.\n\n## Installation\n\n1. Install the library.\n\n ```shell\n python -m pip install django-tailwind-cli\n ```\n\n2. Add `django_tailwind_cli` to `INSTALLED_APPS` in `settings.py`.\n\n ```python\n INSTALLED_APPS = [\n # other Django apps\n \"django_tailwind_cli\",\n ]\n ```\n\n3. Configure the `STATICFILES_DIRS` parameter in your `settings.py` if not already configured.\n\n ```python\n STATICFILES_DIRS = [BASE_DIR / \"assets\"]\n ```\n\n4. Add template code.\n\n ```htmldjango\n {% load tailwind_cli %}\n ...\n <head>\n ...\n {% tailwind_css %}\n ...\n </head>\n ```\n\n5. Start the debug server.\n\n ```shell\n python manage.py tailwind runserver\n ```\n\nEnjoy!\n\n## Features\n\n- Simplest possible integration.\n- Management commands:\n - To start the Tailwind CLI in watch mode during development.\n - To build the production grade CSS file for your project.\n - To start a debug server along with the Tailwind CLI in watch mode in a single session.\n- Necessary configuration to adapt the library to your project, when the defaults don't fit you.\n- A template tag to include the Tailwind CSS file in your project.\n- A base template for your project.\n- A sane tailwind.config.js that activates all the official plugins and includes a simple HTMX plugin.\n\n## Requirements\n\nPython 3.8 or newer with Django >= 3.2.\n\n## Documentation\n\nThe documentation can be found at [https://django-tailwind-cli.andrich.me/](https://django-tailwind-cli.andrich.me/)\n\n## Contributing\n\nIf you want to contribute to this project, checkout the [development guide](https://django-tailwind-cli.andrich.me/development/) for details to get your dev environment up and running.\n\n## License\n\nThis software is licensed under [MIT license](https://github.com/oliverandrich/django-tailwind-cli/blob/main/LICENSE).\n",
"bugtrack_url": null,
"license": null,
"summary": "Django and Tailwind integration based on the prebuilt Tailwind CSS CLI.",
"version": "2.3.0",
"project_urls": {
"Documentation": "https://django-tailwind-cli.andrich.me/",
"Issues": "https://github.com/oliverandrich/django-tailwind-cli/issues",
"Source": "https://github.com/oliverandrich/django-tailwind-cli"
},
"split_keywords": [
"css",
"django",
"tailwind"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b7d89a73e511890027ae41060bee86ca407273ebd0c7731fbb696b0eea772517",
"md5": "142c4f3eaea9eca861a90e8fa81a9864",
"sha256": "d511410c59e4b6a1288b887ed2e516e5b7a72839ef419c2e1880a3744bf322e7"
},
"downloads": -1,
"filename": "django_tailwind_cli-2.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "142c4f3eaea9eca861a90e8fa81a9864",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9990,
"upload_time": "2023-08-11T20:51:49",
"upload_time_iso_8601": "2023-08-11T20:51:49.960443Z",
"url": "https://files.pythonhosted.org/packages/b7/d8/9a73e511890027ae41060bee86ca407273ebd0c7731fbb696b0eea772517/django_tailwind_cli-2.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2ada404b5ecbf1fc5a35a13ad0a0437089da7997797332fcf96338f3c201743a",
"md5": "9dc5134883ba258ede0038fb233321f9",
"sha256": "676d4afef8489aeb33a03eee22ec8bc320afa15d3fc6ee8ae66f3b4beb9de3c7"
},
"downloads": -1,
"filename": "django_tailwind_cli-2.3.0.tar.gz",
"has_sig": false,
"md5_digest": "9dc5134883ba258ede0038fb233321f9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 19688,
"upload_time": "2023-08-11T20:51:48",
"upload_time_iso_8601": "2023-08-11T20:51:48.509939Z",
"url": "https://files.pythonhosted.org/packages/2a/da/404b5ecbf1fc5a35a13ad0a0437089da7997797332fcf96338f3c201743a/django_tailwind_cli-2.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-11 20:51:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "oliverandrich",
"github_project": "django-tailwind-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "django-tailwind-cli"
}
