An app to explore your data through charts based on Highcharts.js
Project description
=============================
django_charts
=============================
.. image:: https://badge.fury.io/py/acdh-django-charts.svg
:target: https://badge.fury.io/py/acdh-django-charts
.. image:: https://travis-ci.org/acdh-oeaw/acdh-django-charts.svg?branch=master
:target: https://travis-ci.org/acdh-oeaw/acdh-django-charts
.. image:: https://codecov.io/gh/acdh-oeaw/acdh-django-charts/branch/master/graph/badge.svg
:target: https://codecov.io/gh/acdh-oeaw/acdh-django-charts
An app to explore your data through charts based on Highcharts.js
Documentation
-------------
The full documentation is at https://acdh-django-charts.readthedocs.io.
Quickstart
----------
Install django_charts::
pip install acdh-django-charts
Add it to your `INSTALLED_APPS`:
.. code-block:: python
INSTALLED_APPS = (
...
'charts',
...
)
Add django_charts's URL patterns:
.. code-block:: python
urlpatterns = [
...
url(r'^charts/', include('charts.urls', namespace='charts')),
...
]
By default the app's templates extend a base template `webpage/base.html`. To ovveride this, just define a `CHARTS_BASE_TEMPLATE` variable on your project's `settings.py` like e.g:
.. code-block:: python
CHARTS_BASE_TEMPLATE = 'base.html'
To link to the application's 'chart-selector-view' you can add something like the snippet below to your e.g. base-template:
.. code-block:: html
<a href="{% url 'charts:chart_selector' %}">Charts</a>
Configuration
----
ToDo...
Build and publish
-----
.. code-block:: console
python setup.py sdist bdist_wheel
twine upload dist/*
Features
--------
* TODO
Running Tests
-------------
Does the code actually work?
::
source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox
Credits
-------
Tools used in rendering this package:
* Cookiecutter_
* `cookiecutter-djangopackage`_
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage
History
-------
0.2.0 (2018-06-01)
++++++++++++++++++
* Base templates can now be configured in settings-param
0.1.0 (2018-06-01)
++++++++++++++++++
* First release on PyPI.
django_charts
=============================
.. image:: https://badge.fury.io/py/acdh-django-charts.svg
:target: https://badge.fury.io/py/acdh-django-charts
.. image:: https://travis-ci.org/acdh-oeaw/acdh-django-charts.svg?branch=master
:target: https://travis-ci.org/acdh-oeaw/acdh-django-charts
.. image:: https://codecov.io/gh/acdh-oeaw/acdh-django-charts/branch/master/graph/badge.svg
:target: https://codecov.io/gh/acdh-oeaw/acdh-django-charts
An app to explore your data through charts based on Highcharts.js
Documentation
-------------
The full documentation is at https://acdh-django-charts.readthedocs.io.
Quickstart
----------
Install django_charts::
pip install acdh-django-charts
Add it to your `INSTALLED_APPS`:
.. code-block:: python
INSTALLED_APPS = (
...
'charts',
...
)
Add django_charts's URL patterns:
.. code-block:: python
urlpatterns = [
...
url(r'^charts/', include('charts.urls', namespace='charts')),
...
]
By default the app's templates extend a base template `webpage/base.html`. To ovveride this, just define a `CHARTS_BASE_TEMPLATE` variable on your project's `settings.py` like e.g:
.. code-block:: python
CHARTS_BASE_TEMPLATE = 'base.html'
To link to the application's 'chart-selector-view' you can add something like the snippet below to your e.g. base-template:
.. code-block:: html
<a href="{% url 'charts:chart_selector' %}">Charts</a>
Configuration
----
ToDo...
Build and publish
-----
.. code-block:: console
python setup.py sdist bdist_wheel
twine upload dist/*
Features
--------
* TODO
Running Tests
-------------
Does the code actually work?
::
source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox
Credits
-------
Tools used in rendering this package:
* Cookiecutter_
* `cookiecutter-djangopackage`_
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage
History
-------
0.2.0 (2018-06-01)
++++++++++++++++++
* Base templates can now be configured in settings-param
0.1.0 (2018-06-01)
++++++++++++++++++
* First release on PyPI.
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
acdh-django-charts-0.2.0.tar.gz
(10.4 kB
view hashes)
Built Distribution
Close
Hashes for acdh_django_charts-0.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 33e1613efde4db3bfea9219cc55f6bc468d2c4db75d73197d3dd3aacc05daeca |
|
MD5 | f152644bfeb4082822e4c762d7f65754 |
|
BLAKE2b-256 | ac56309ec59470ae8081a247996ab087e514295d86522899ba526d029ec345fd |