Propeller support for Django projects
Project description
Propeller for Django2
====================
Write Django as usual, and let ``django2-propeller`` make template output into code based on Google's Material Design Standards & Bootstrap.
[![Build Status](https://travis-ci.com/RaddishIoW/django2-propeller.svg?branch=stable)](https://travis-ci.com/RaddishIoW/django2-propeller)
[![Documentation Status](https://readthedocs.org/projects/django2-propeller/badge/?version=latest)](https://django2-propeller.readthedocs.io/en/latest/?badge=latest)
[![Coverage Status](https://coveralls.io/repos/github/RaddishIoW/django2-propeller/badge.svg?branch=stable)](https://coveralls.io/github/RaddishIoW/django2-propeller?branch=stable)
[![Updates](https://pyup.io/repos/github/RaddishIoW/django2-propeller/shield.svg)](https://pyup.io/repos/github/RaddishIoW/django2-propeller/)
[![Python 3](https://pyup.io/repos/github/RaddishIoW/django2-propeller/python-3-shield.svg)](https://pyup.io/repos/github/RaddishIoW/django2-propeller/)
Requirements
------------
- Python 3.3, 3.4, 3.5, or 3.6
- Django >= 2.0
Installation
------------
1. Install using pip:
```
pip install django2-propeller
```
2. Add to INSTALLED_APPS in your ``settings.py``:
```
'django2_propeller',
```
3. In your templates, load the ``django2_propeller`` library and use the ``propeller_*`` tags:
Example template
----------------
```
{% load propeller %}
{# Display a form #}
<form action="/url/to/submit/" method="post" class="form">
{% csrf_token %}
{% propeller_form form %}
{% buttons %}
<button type="submit" class="btn btn-primary">
{% propeller_icon "star" %} Submit
</button>
{% endbuttons %}
</form>
```
Documentation
-------------
The full documentation is at https://django2-propeller.readthedocs.io/en/latest/
Demo application
----------------
The demo application provides a number of useful examples.
clone the repo:
$ git clone https://github.com/RaddishIoW/django2-propeller.git
cd into the cloned directory:
$ cd django2-propeller
run the testserver:
$ python manage.py runserver
open your browser and browse to:
http://127.0.0.1:8000
Bugs and suggestions
--------------------
If you have found a bug or if you have a request for additional functionality, please use the issue tracker on GitHub.
https://github.com/RaddishIoW/django2-propeller/issues
Further Information
-------------------
Propeller: http://propeller.in/
Bootstrap: http://getbootstrap.com/
Google Material Design: https://material.io/
License
-------
You can use this under MIT License. See [LICENSE](LICENSE) file for details.
Author
------
Originally developed and maintained by [Thorsten Fröhlich](https://github.com/tfroehlich82),
based on the idea of [django-bootstrap3](https://github.com/dyve/django-bootstrap3) from [Dylan Verheul](https://github.com/dyve).
This package is updated by [Adam Radestock](https://github.com/RaddishIoW) to work with Django 2
====================
Write Django as usual, and let ``django2-propeller`` make template output into code based on Google's Material Design Standards & Bootstrap.
[![Build Status](https://travis-ci.com/RaddishIoW/django2-propeller.svg?branch=stable)](https://travis-ci.com/RaddishIoW/django2-propeller)
[![Documentation Status](https://readthedocs.org/projects/django2-propeller/badge/?version=latest)](https://django2-propeller.readthedocs.io/en/latest/?badge=latest)
[![Coverage Status](https://coveralls.io/repos/github/RaddishIoW/django2-propeller/badge.svg?branch=stable)](https://coveralls.io/github/RaddishIoW/django2-propeller?branch=stable)
[![Updates](https://pyup.io/repos/github/RaddishIoW/django2-propeller/shield.svg)](https://pyup.io/repos/github/RaddishIoW/django2-propeller/)
[![Python 3](https://pyup.io/repos/github/RaddishIoW/django2-propeller/python-3-shield.svg)](https://pyup.io/repos/github/RaddishIoW/django2-propeller/)
Requirements
------------
- Python 3.3, 3.4, 3.5, or 3.6
- Django >= 2.0
Installation
------------
1. Install using pip:
```
pip install django2-propeller
```
2. Add to INSTALLED_APPS in your ``settings.py``:
```
'django2_propeller',
```
3. In your templates, load the ``django2_propeller`` library and use the ``propeller_*`` tags:
Example template
----------------
```
{% load propeller %}
{# Display a form #}
<form action="/url/to/submit/" method="post" class="form">
{% csrf_token %}
{% propeller_form form %}
{% buttons %}
<button type="submit" class="btn btn-primary">
{% propeller_icon "star" %} Submit
</button>
{% endbuttons %}
</form>
```
Documentation
-------------
The full documentation is at https://django2-propeller.readthedocs.io/en/latest/
Demo application
----------------
The demo application provides a number of useful examples.
clone the repo:
$ git clone https://github.com/RaddishIoW/django2-propeller.git
cd into the cloned directory:
$ cd django2-propeller
run the testserver:
$ python manage.py runserver
open your browser and browse to:
http://127.0.0.1:8000
Bugs and suggestions
--------------------
If you have found a bug or if you have a request for additional functionality, please use the issue tracker on GitHub.
https://github.com/RaddishIoW/django2-propeller/issues
Further Information
-------------------
Propeller: http://propeller.in/
Bootstrap: http://getbootstrap.com/
Google Material Design: https://material.io/
License
-------
You can use this under MIT License. See [LICENSE](LICENSE) file for details.
Author
------
Originally developed and maintained by [Thorsten Fröhlich](https://github.com/tfroehlich82),
based on the idea of [django-bootstrap3](https://github.com/dyve/django-bootstrap3) from [Dylan Verheul](https://github.com/dyve).
This package is updated by [Adam Radestock](https://github.com/RaddishIoW) to work with Django 2
Project details
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
django2-propeller-2.0.1.tar.gz
(668.7 kB
view hashes)
Built Distribution
Close
Hashes for django2_propeller-2.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 450cc8137f56b251ea035d97e2df37360c807ff1b1e4ab58e8ebe31ce84561b2 |
|
MD5 | 1db430e76e5139da0bf32dae7ebae9ce |
|
BLAKE2b-256 | 759f617554cc589bb67bbfb3cca0c741ffd66310aed1fe1557cf8d12f4651c51 |