No project description provided
Project description
Django Templater
Create Django templates from HTML files
Description
Django Templater is a command line tool that will help you to convert your HTML templates to Django templates.
Installation
> pip install django-templater
How does it work?
This project will create a new Django project and copy all HTML files to the Django templates directory. It will also create a new Django app and copy all HTML files to the Django templates directory.
To create a new Django project, you need to specify the main block name. The main block name is the name of the block that will be used in the base HTML file. The main block name is required.
For example:
Base HTML file
<!-- ./templates/base.html -->
<html lang="en">
<head>
<title>My Website</title>
</head>
<body>
<div class="header" id="main_block">
<h1>My Website</h1>
<p>Welcome to my website</p>
</div>
</body>
</html>
Home HTML file
<!-- ./templates/home.html -->
<html lang="en">
<head>
<title>My Website</title>
</head>
<body>
<div class="header" id="main_block">
<h1>User Home</h1>
<p>Welcome to the user home page</p>
<img src="assets/images/logo.png" alt="Logo">
</div>
</body>
</html>
On the above example, the main block name is main_block. So, when you create a new Django project, the main block name will be used as the name of the block in the base HTML file.
Quick Start
Let say you have an HTML templates in ./templates directory.
- Django master page will be:
./templates/base.html - Django home page will be:
./templates/home.html,./templates/users.htmlor./templates/home/setting.html - HTML main block we want to use is:
main_block
We want to create a Django project in ./myproject directory and we want to use ./templates directory as Django templates directory, and the output will be in ./myproject directory.
> dt -b main_block ./templates/base.html -t ./templates/* -o ./myproject
This command will generate the following files:
<!-- ./output/base.html -->
<html lang="en">
<head>
<title>My Website</title>
</head>
<body>
<div class="header" id="main_block">
{% block main_block %}{% endblock %}
</div>
</body>
</html>
<!-- ./output/home.html -->
{% extends "base.html" %}
{% load static %}
{% block main_block %}
<h1>User Home</h1>
<p>Welcome to the user home page</p>
<img src="{% static 'assets/images/logo.png' %}" alt="Logo">
{% endblock %}
Advanced Usage
Static Files
By default this project will copy all static files to the Django static directory. The static directory we'll be static in your output directory. You can change the static directory by using -s or --static option.
> dt -b main_block -m ./templates/base.html -o ./myproject -s assets ./templates/*
Downloading Remote Files
You can also download remote assets automatically. If your HTML files contains remote assets, this project will download the remote assets and copy them to the static directory.
> dt -b main_block -m ./templates/base.html -D -o ./myproject ./templates/*
Remote templates
You can also use remote templates. This project will download the remote templates and copy them to the templates directory.
> dt -b main_block -m https://example.com/base.html -o ./myproject ./templates/*
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the terms of the MIT license.
Release history Release notifications | RSS feed
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
Hashes for django_templater-0.1.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5fd1960fcb252430ea6527b971d2b52fd60fb9216eb7a99b8ce173517324798a |
|
| MD5 | d97232d975fc11b7a644e2944e63503b |
|
| BLAKE2b-256 | dbc3730940078ea8080167b69c50967e0ba02a44b0efca0274a7f3e0e87b67ef |
