Metadata-Version: 1.1
Name: django-tailwind
Version: 0.1.1
Summary: Tailwind CSS Framework for Django projects
Home-page: https://github.com/timonweb/django-tailwind
Author: Tim Kamanin
Author-email: tim@timonweb.com
License: The MIT License (MIT)
Description: # The integration of Tailwind CSS framework with Django a.k.a. Django + Tailwind = ❤
        
        ## Quick start
        
        1. Install the python package django-tailwind from pip
        
           `pip install django-tailwind`
        
           Alternatively, you can download or clone this repo and run `pip install -e .`.
        
        2. Add `tailwind` to INSTALLED_APPS in **settings.py**
        
        3. Create a tailwind-compatible Django-app, I like to call it `theme`:
        
           `python manage.py tailwind init theme`
        
        4. Add your newly created `theme` app to INSTALLED_APPS in **settings.py**
        
        5. In settings.py, register tailwind app by adding the following string:
        
           `TAILWIND_APP_NAME = 'theme'`
        
        6. Run a command to install all necessary dependencies for tailwind css:
        
           `python manage.py tailwind install`
        
        7. Now, go and start tailwind in dev mode:
        
           `python manage.py tailwind start`
        
        8. Django Tailwind comes with a simple `base.html` template that can be found under 
           `yourtailwindappname/templates/base.html`. You can always extend it or delete it if you
           have own layout.
        
        9. If you're not using `base.html` template provided with Django Tailwind, add `styles.min.css` to your own `base.html` template file:
        
           ```html
           <link
             rel="stylesheet"
             href="{% static 'css/styles.min.css' %}"
             type="text/css"
           />
           ```
        
        10. You should now be able to use Tailwind CSS classes in your html.
        
        11. To build a production version of CSS run:
        
            `python manage.py tailwind build`.
        
        ## NPM executable path configuration
        
        Sometimes (especially on Windows), Python executable can't find `NPM` installed in the system.
        In this case, you need to set `NPM` executable path in settings.py file manually:
        
        ```python
        NPM_BIN_PATH = '/usr/local/bin/npm'
        ``` 
            
        Please note that `NPM` path of your system may be different. Try to run `which npm` in your
        command line to get the path.
        
        ## Bugs and suggestions
        
        If you have found a bug, please use the issue tracker on GitHub.
        
        [https://github.com/timonweb/django-tailwind/issues](https://github.com/timonweb/django-tailwind/issues)
        
        2019 (c) [Tim Kamanin - A Full Stack Django Developer](https://timonweb.com)
        
Keywords: django-tailwind
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
