django-freshly

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 10 Open GitHub ↗

Forces clients to reload static contents. (.js, .css, img)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Django Freshly
====================

**A Django application that enables your server to remotely trigger a client-side asset reload**

[![status-image]][status-link]
[![version-image]][version-link]
[![coverage-image]][coverage-link]
[![download-image]][download-link]

Overview
====================

A simple trigger of client-side asset reload.

How to install
====================

1. easy_install django-freshly
    2. pip install django-freshly
    3. git clone http://github.com/un33k/django-freshly
        a. cd django-freshly
        b. run python setup.py
    4. wget https://github.com/un33k/django-freshly/zipball/master
        a. unzip the downloaded file
        b. cd into django-freshly-* directory
        c. run python setup.py

How to use (production)
====================
Install `django-freshly` using one of the methods outlined in the `How to install` section.

```python
    # Add `freshly` to your `INSTALLED_APP`.

# Add `freshly.middleware.assets.AssetVersioningMiddleware` to your `MIDDLEWARE_CLASSES`.
    # Note: ensure the middleware is the last item in your `MIDDLEWARE_CLASSES`.

# Optional: overwrite the extensions list as per your requirements.
    FRESHLY_ASSETS_EXTENTIONS = [
        'jpg', 'jpeg', 'gif', 'css', 'png', 'js', 'ico', 'txt'
    ]

# Add `FRESHLY_ASSETS_VERSION` to your setting file.

FRESHLY_ASSETS_VERSION = '001'

# OR

FRESHLY_ASSETS_VERSION = 'v001'

# Up the version and restart Django to force clients to reload your website assets.
   ```

How to use (development):
=================
Add `FRESHLY_ASSETS_ALWAYS_FRESH` to your settings file.

```python
    # Set it to True to force a fresh copy of your assets on to the browsers.

# Note: Do not use in production.
    FRESHLY_ASSETS_ALWAYS_FRESH = True

# OR

FRESHLY_ASSETS_ALWAYS_FRESH = DEBUG
   ```

Performance:
=================
The application is a perfect tool for the front-end designers during development.

Running the tests
====================

To run the tests against the current environment:

python manage.py test

License
====================

Released under a ([BSD](LICENSE.md)) license.

Version
====================
X.Y.Z Version

`MAJOR` version -- when you make incompatible API changes,
    `MINOR` version -- when you add functionality in a backwards-compatible manner, and
    `PATCH` version -- when you make backwards-compatible bug fixes.

[status-image]: https://secure.travis-ci.org/un33k/django-freshly.png?branch=master
[status-link]: http://travis-ci.org/un33k/django-freshly?branch=master

[version-image]: https://img.shields.io/pypi/v/django-freshly.svg
[version-link]: https://pypi.python.org/pypi/django-freshly

[coverage-image]: https://coveralls.io/repos/un33k/django-freshly/badge.svg
[coverage-link]: https://coveralls.io/r/un33k/django-freshly

[download-image]: https://img.shields.io/pypi/dm/django-freshly.svg
[download-link]: https://pypi.python.org/pypi/django-freshly

django-freshly

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README