Convert your Angular built index.html file to Django Template syntax
Project description
ng2django
This is a simple Python tool that will convert an HTML file built by Angular2+ to Django Template Language. This way static files can be made available to an Agnular app that is served up with a Django project.
The script basically does two things:
- Adds a
{% load static %}
tag to the top of the file - Changes the value of
href
andsrc
attributes oflink
andscript
tags to{% static "<path-to-the-file>" %}
Dependencies
The script uses Beutifulsoup4. You can install it by running pip install -r requirements.txt
.
Install
Just run $ pip install ng2django
Usage
Build your Angular app and place the files in <Django-project-root>/<app>/static/<optional-subdirectory>/
.
The script takes two positional arguments:
source
: The path to the HTML file you want to convert.dest
: Where you want the Django Template file saved.
Then you can run
$ ng2django <Django-project-root>/<app>/static/index.html <Django-project-root>/<app>/templates/index.html
if you are storing your files directly in your Django app's static
and templates
directories (not recommended), or
$ ng2django <Django-project-root>/<app>/static/<optional-subdirectory>/index.html <Django-project-root>/<app>/templates/<optional-subdirectory>/index.html -s <optional-subdirectory>
if you are using some subdirectory of those paths.
Optional Arguments
Short | Long | Description |
---|---|---|
-s <subdir> |
--subdir <subdir> |
Include the subpath under <Django-app>/static/ where your static files are stored. |
-n | --nodelete | Do not delete the source file after converting. |
-p | --pretty | Create a dest file that is more human readable. |
Recommended Setup and Usage
In you Angular project open your package.json
file. Under scripts
, change build
to
ng build --prod --output-path <Your-django-project-root>/<Django-App>/static/ng
.
Add a postbuild
key under script
and set the value to
ng2django <Your-django-project-root>/<Django-App>/static/ng/index.html <Your-django-project-root>/<Django-App>/templates/ng/index.html -s ng
.
Run npm run build
and your Angular JS and CSS files will be saved to your Django app's static directory. Then, this script will run and convert your HTML file and save it in your Django app's templates directory.
Contributing
Contributions are welcome - submit an issue/pull request.
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
Built Distribution
File details
Details for the file ng2django-0.1.4.tar.gz
.
File metadata
- Download URL: ng2django-0.1.4.tar.gz
- Upload date:
- Size: 3.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d974c162b6ec950d18a082fa2c0129e84a89d821d27aa69dfa2f46c786cfe52b |
|
MD5 | e754b43606cbb25ee4b0dbbf260ef9fa |
|
BLAKE2b-256 | 13bf3c7c24ab0984c31ace8d27e991d7b015366a153a8243acfaeb8a833a09c9 |
File details
Details for the file ng2django-0.1.4-py3-none-any.whl
.
File metadata
- Download URL: ng2django-0.1.4-py3-none-any.whl
- Upload date:
- Size: 4.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e6dd01f501f4a653659013eb2e8d53fedf7f870c5df2ef81746d30d985a9ec61 |
|
MD5 | 85890eaef37d065d618ef48a4eb830a2 |
|
BLAKE2b-256 | 024ea901e91b00f04a2d7931478995e22e95b4368971d16c72bb1a0144ce81d1 |