Skip to main content

Integrate django with yarnpkg

Project description

Easy way to use yarnpkg with your Django project.

This is a fork of django-bower <https://github.com/nvbn/django-bower> by Vladimir Iakovlev.

Read full documentation on read-the-docs.

Installation

Install django-yarnpkg package:

pip install django-yarnpkg

Add django-bower to INSTALLED_APPS in your settings:

'django_yarnpkg',

Add staticfinder to STATICFILES_FINDERS:

'django_yarnpkg.finders.NodeModulesFinder',

Specify path to components root (you need to use an absolute path):

NODE_MODULES_ROOT = os.path.join(BASE_DIR, 'node_modules')

If you need, you can manually set the path to yarnpkg:

YARN_PATH = '/usr/bin/yarnpkg'

You can see an example settings file in example project.

Usage

Specify YARN_INSTALLED_APPS in settings, like:

YARN_INSTALLED_APPS = (
    'bootstrap@^4.4.1',
    'underscore@^1.6.1',
)

Download yarn packages with the management command:

./manage.py yarn install

Add scripts in the template, like:

{% load static %}
<script type="text/javascript" src='{% static 'jquery/dist/jquery.js' %}'></script>

In production you need to call yarnpkg install before collectstatic:

./manage.py yarn install
./manage.py collectstatic

If you need to pass arguments to yarnpkg, like –flat, use:

./manage.py yarn install -- --flat

You can call yarnpkg commands like info and update with:

./manage.py yarn info backbone
./manage.py yarn update

Python 3 support

django-yarnpkg supports python 3.3+

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-yarnpkg-6.1.2.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

django_yarnpkg-6.1.2-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

Details for the file django-yarnpkg-6.1.2.tar.gz.

File metadata

  • Download URL: django-yarnpkg-6.1.2.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for django-yarnpkg-6.1.2.tar.gz
Algorithm Hash digest
SHA256 3148a73d969019f743a1aac0708cc3dbca1432b963944ee7c6ff248513ac4c17
MD5 b8b99762afa496322f15c46b52ae1c36
BLAKE2b-256 8c7cc4768cfcf8af8fab73dd1dc23e0dc2f50453196f673e887e2b228bf5957c

See more details on using hashes here.

Provenance

File details

Details for the file django_yarnpkg-6.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for django_yarnpkg-6.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2d70ccf1688390f3e5df4bee29e8effd73677d24778285d2f747bc9f4eb94d5b
MD5 161dc4410586a86797c9d97dc255f3a9
BLAKE2b-256 85e6763a073a329289cabca006640ca43e9f25b008a5338ccc1d9e43ea105494

See more details on using hashes here.

Provenance

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