Skip to main content

THIS PACKAGE IS NOT MAINTAINED.

Please use django-static-precompiler

Django CoffeeScript

Django CoffeeScript provides template tags to compile CoffeeScript into JavaScript from templates. It works with both inline code and extenal files.

Installation

  1. Add "coffeescript" to INSTALLED_APPS setting.

  2. Make sure that you have coffee executable installed. See CoffeeScript official site for details.

  3. Optionally, you can specify the full path to coffee executable with COFFEESCRIPT_EXECUTABLE setting. By default it’s set to coffee.

  4. In case you use Django’s staticfiles contrib app you have to add django-coffeescript’s file finder to the STATICFILES_FINDERS setting, for example :

STATICFILES_FINDERS = (
    'django.contrib.staticfiles.finders.FileSystemFinder',
    'django.contrib.staticfiles.finders.AppDirectoriesFinder',
    # other finders..
    'coffeescript.finders.CoffeescriptFinder',
)

Example Usage

Inline

{% load coffeescript %}

<script type="text/javascript">
  {% inlinecoffeescript %}
    console.log "Hello, World!"
  {% endinlinecoffeescript %}
</script>

renders to

  <script type="text/javascript">
    (function() {
  console.log("Hello, World!");
}).call(this);

  </script>

External file

{% load coffeescript %}

<script type="text/javascript"
        src="{{ STATIC_URL}}{% coffeescript "path/to/script.coffee" %}">
</script>

renders to

<script type="text/javascript"
        src="/media/COFFEESCRIPT_CACHE/path/to/script-91ce1f66f583.js">
</script>

Note that by default compiled files are saved into COFFEESCRIPT_CACHE folder under your STATIC_ROOT (or MEDIA_ROOT if you have no STATIC_ROOT in your settings). You can change this folder name with COFFEESCRIPT_ROOT and COFFEESCRIPT_OUTPUT_DIR settings.

Settings

COFFEESCRIPT_EXECUTABLE

Path to CoffeeScript compiler executable. Default: "coffee".

COFFEESCRIPT_ROOT

Controls the absolute file path that compiled files will be written to. Default: STATIC_ROOT.

COFFEESCRIPT_OUTPUT_DIR

Controls the directory inside COFFEESCRIPT_ROOT that compiled files will be written to. Default: "COFFEESCRIPT_CACHE".

COFFEESCRIPT_USE_CACHE

Whether to use cache for inline scripts. Default: True.

COFFEESCRIPT_CACHE_TIMEOUT

Cache timeout for inline scripts (in seconds). Default: 30 days.

COFFEESCRIPT_MTIME_DELAY

Cache timeout for reading the modification time of external scripts (in seconds). Default: 10 seconds.

Changes

0.7.2

  • Use hashlib instead of django.utils.hashcompat which is deprecated in Django 1.5

0.7.1

  • Always create a compiled file, even if no output was received from compiler

0.7

  • Add COFFEESCRIPT_ROOT setting

  • Add staticfiles finder to serve compiled files in dev mode

0.6

  • Switch to staticfiles.finders when looking up the files in DEBUG mode.

0.5.1

  • Add support for STATICFILES_DIRS with prefixes

0.5

  • When in DEBUG mode lookup coffee scripts in all STATICFILES_DIRS

0.4

  • Log coffeescript compilation errors

  • Fixed bug with paths on Windows (by syabro)

0.3

  • Use STATIC_ROOT / STATIC_URL settings when possible instead of MEDIA_ROOT / MEDIA_URL (by Roman Vorushin)

0.2.1

  • Add CHANGES.rst to MANIFEST.in

0.2

  • Automatically remove old files from COFFEESCRIPT_CACHE

  • Add basic unit tests

0.1

  • Initial release

Metadata

Release files for django-coffeescript 0.7.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-coffeescript 0.7.2
File Size Uploaded Provenance
django-coffeescript-0.7.2.tar.gz 7.3 kB Without provenance Details

Release files / django-coffeescript-0.7.2.tar.gz

Download URL django-coffeescript-0.7.2.tar.gz
Size 7.3 kB
Tags Source
SHA-256 checksum
How to use checksums
cd56722f2fc6e9214fb3288c91716024aafac6ee695944bc0e915e05d1192947
BLAKE2b-256 checksum
How to use checksums
4158e0362896647ceef491a67a7b690d309cedbc861edffe35a3e8603108e8c8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for django-coffeescript 0.7.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page