Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/acdh-oeaw/acdh-django-charts

A django app to explore your data through charts based on Highcharts.js

https://github.com/acdh-oeaw/acdh-django-charts

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 3 committers (33.3%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.7%) to scientific vocabulary

Keywords

acdh-django-packages django
Last synced: 6 months ago · JSON representation

Repository

A django app to explore your data through charts based on Highcharts.js

Basic Info
  • Host: GitHub
  • Owner: acdh-oeaw
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 41 KB
Statistics
  • Stars: 3
  • Watchers: 5
  • Forks: 0
  • Open Issues: 1
  • Releases: 0
Topics
acdh-django-packages django
Created over 7 years ago · Last pushed almost 3 years ago
Metadata Files
Readme Changelog Contributing License Authors

README.rst 

=============================
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

    Charts

Configuration
-------------

To visualize any property of your model you have to pass in the models name (lowercase), the field-path (using django's lookup syntax `__` to follow foreign key and many2many relations) and the chart type (bar|line|pie) via keyword arguments to the `charts.views.DynChartView()`. In case those params are valid (i.d. the model and the lookup path acutally exist) the according chart should be drawn. But be aware that this only works if your project's `DEBUG` settings are set to `True`.
As **recomended** alternative you should create `ChartConfig` objects for each property/model you'd like to explore via django admin-backend.

management commands
-------------------

The package ships with a management command to

* create/delete chartconfig objects (Bar, Pie, Linecharts)

.. code-block:: console

    python manage.py create_charttypes

.. code-block:: console

    python manage.py delete_charttypes

* create/delete ChartConfig objects per application

.. code-block:: console

    python manage.py create_charts 

.. code-block:: console

    python manage.py delete_charts 

Build and publish
-----------------

.. code-block:: console

    python setup.py sdist bdist_wheel
    twine upload dist/*



Features
--------

* Visualizes aggregated values of your models as charts (pie/bar/line) using https://www.highcharts.com/
* Charts can be configured via admin backend (see Configuration Section)

Running Tests
-------------

Does the code actually work?

::

    source /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

Owner

  • Name: Austrian Centre for Digital Humanities & Cultural Heritage
  • Login: acdh-oeaw
  • Kind: organization
  • Email: acdh@oeaw.ac.at
  • Location: Vienna, Austria

GitHub Events

Total
Last Year

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 20
  • Total Committers: 3
  • Avg Commits per committer: 6.667
  • Development Distribution Score (DDS): 0.1
Top Committers
Name Email Commits
Peter Andorfer P****r@o****t 18
csae8092 p****r@g****m 1
dependabot[bot] 4****]@u****m 1
Committer Domains (Top 20 + Academic)
oeaw.ac.at: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 2
  • Total pull requests: 2
  • Average time to close issues: 2 days
  • Average time to close pull requests: 1 day
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • koeaw (1)
  • csae8092 (1)
Pull Request Authors
  • b1rger (1)
  • dependabot[bot] (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 334 last-month
  • Total dependent packages: 2
  • Total dependent repositories: 17
  • Total versions: 11
  • Total maintainers: 1
pypi.org: acdh-django-charts

An app to explore your data through charts based on Highcharts.js

  • Versions: 11
  • Dependent Packages: 2
  • Dependent Repositories: 17
  • Downloads: 334 Last month
Rankings
Dependent packages count: 3.1%
Dependent repos count: 3.5%
Downloads: 9.1%
Average: 14.1%
Stargazers count: 25.0%
Forks count: 29.8%
Maintainers (1)
csae8092
Last synced: 7 months ago

Dependencies

requirements_dev.txt pypi
  • bumpversion ==0.5.3 development
  • wheel ==0.30.0 development
requirements_test.txt pypi
  • codecov >=2.0.0 test
  • coverage ==4.4.1 test
  • flake8 >=2.1.0 test
  • mock >=1.0.1 test
  • tox >=1.7.0 test
requirements.txt pypi
setup.py pypi