Skip to main content

Drop-in replacement for staticfiles which handles asset processing.

Project description

Django Assetfiles
=================

Django Assetfiles is a drop-in replacement for staticfiles which handles asset processing.


Installation
------------

1. Install package from PyPi:

``` sh
$ pip install django-assetfiles
```

2. Replace `'django.contrib.staticfiles'` in `INSTALLED_APPS` with `'assetfiles'`:

``` python
INSTALLED_APPS = (
# ...
# 'django.contrib.staticfiles',
'assetfiles',
)
```

3. That's it! Assetfiles will default to your [Staticfiles settings](https://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/).


Usage
-----

1. Add an asset file that should be processed:

``` scss
// static/css/main.scss
$color: red;

body {
color: $color;
}
```

2. Add a link to the processed CSS file in your template (you can use standard Staticfiles conventions):

``` html+django
{% load staticfiles %}
<link href="{% static 'css/main.css' %}" rel="stylesheet">
```

Assetfiles will automatically serve up the processed version of `main.scss` at the static url of `/static/css/main.css`.

4. To serve assets in development, either use `runserver` as normal or add the following to your `urls.py`:

``` python
from assetfiles.urls import assetfiles_urlpatterns

# ... the rest of your URLconf goes here ...

urlpatterns += assetfiles_urlpatterns()
```

5. For deployment, run `collectstatic` as usual and Assetfiles will process and copy over the assets:

``` sh
$ python manage.py collectstatic
$ cat public/css/main.css
body {
color: red; }
```


Copyright
---------

Copyright (c) 2012 [LocalMed, Inc.](http://localmed.com). See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-assetfiles-0.8.0.tar.gz (17.3 kB view details)

Uploaded Source

File details

Details for the file django-assetfiles-0.8.0.tar.gz.

File metadata

File hashes

Hashes for django-assetfiles-0.8.0.tar.gz
Algorithm Hash digest
SHA256 b70337b9d6c4fae053e256f7fb3f03527d3aa4e6f5365518ea24951edbd53d8e
MD5 7f436f14d1d6b77d2fb8e0aa863a2f0a
BLAKE2b-256 70dd07a6411aa3d4861f199e279806662258367b13afd5000419a731332b3e8d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page