[](https://github.com/DataShades/ckanext-charts/actions/workflows/test.yml)
# ckanext-charts
This extension, ckanext-charts, provides additional functionality for working with charts in CKAN. It allows users to create, manage, and visualize charts based on data stored in CKAN datasets.
The extension includes features such as chart creation, chart editing, chart embedding, and chart sharing. It also supports various chart types, including bar charts, line charts, pie charts, and more.
With ckanext-charts, users can easily generate interactive and visually appealing charts to enhance data analysis and presentation in CKAN.
See the [documentation](https://datashades.github.io/ckanext-charts/) for more information.
## Quick start
- Install it with `PyPi` with `pip install ckanext-charts[pyarrow]`
- Add `charts_view` to the list of plugins in your CKAN config (`ckan.plugins = charts_view charts_builder_view`)
## Developer installation
To install `ckanext-charts` for development, activate your CKAN virtualenv and
do:
git clone https://github.com/DataShades/ckanext-charts.git
cd ckanext-charts
pip install -e '.[dev]'
## Tests
To run the tests, do:
pytest --ckan-ini=test.ini
## Building the documentation
We are using `mkdocs` to build the documentation. To build and deploy the documentation, do:
CHARTS_FIELDS=1 mkdocs build && mkdocs gh-deploy
We need to set the `CHARTS_FIELDS` for our custom handler, that autogenerate documentation
for chart types fields.
The CKAN instance will be initialized, because we will call validators and helpers in this code. Therefore, you'll need
another environment variable to set the CKAN configuration file path:
export CKAN_INI=$PWD/config/ckan.ini
The config file must enable the `ckanext-charts` plugin:
ckan.plugins = ... charts_view charts_builder_view ...
If you're working on the documentation, you can run the following command to start a live-reloading server without
gathering the chart types fields data. It will speed up the process significantly, as we won't need to wait for the
CKAN initialization:
mkdocs serve -a 127.0.0.1:8001
## License
[AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)
Raw data
{
"_id": null,
"home_page": null,
"name": "ckanext-charts",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "DataShades <datashades@linkdigital.com.au>",
"keywords": "CKAN, charts, visualization",
"author": null,
"author_email": "DataShades <datashades@linkdigital.com.au>, Sergey Motornyuk <sergey.motornyuk@linkdigital.com.au>, Oleksandr Cherniavskyi <mutantsan@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/95/6a/59fd46818cabeb9699811309d3b89c6672c25640e494dbf882d1c753befa/ckanext_charts-1.5.0.tar.gz",
"platform": null,
"description": "[](https://github.com/DataShades/ckanext-charts/actions/workflows/test.yml)\n\n# ckanext-charts\n\nThis extension, ckanext-charts, provides additional functionality for working with charts in CKAN. It allows users to create, manage, and visualize charts based on data stored in CKAN datasets.\n\nThe extension includes features such as chart creation, chart editing, chart embedding, and chart sharing. It also supports various chart types, including bar charts, line charts, pie charts, and more.\n\nWith ckanext-charts, users can easily generate interactive and visually appealing charts to enhance data analysis and presentation in CKAN.\n\nSee the [documentation](https://datashades.github.io/ckanext-charts/) for more information.\n\n## Quick start\n\n- Install it with `PyPi` with `pip install ckanext-charts[pyarrow]`\n- Add `charts_view` to the list of plugins in your CKAN config (`ckan.plugins = charts_view charts_builder_view`)\n\n\n\n## Developer installation\n\nTo install `ckanext-charts` for development, activate your CKAN virtualenv and\ndo:\n\n git clone https://github.com/DataShades/ckanext-charts.git\n cd ckanext-charts\n pip install -e '.[dev]'\n\n## Tests\n\nTo run the tests, do:\n\n pytest --ckan-ini=test.ini\n\n\n## Building the documentation\n\nWe are using `mkdocs` to build the documentation. To build and deploy the documentation, do:\n\n CHARTS_FIELDS=1 mkdocs build && mkdocs gh-deploy\n\nWe need to set the `CHARTS_FIELDS` for our custom handler, that autogenerate documentation\nfor chart types fields.\n\nThe CKAN instance will be initialized, because we will call validators and helpers in this code. Therefore, you'll need\nanother environment variable to set the CKAN configuration file path:\n\n export CKAN_INI=$PWD/config/ckan.ini\n\nThe config file must enable the `ckanext-charts` plugin:\n\n ckan.plugins = ... charts_view charts_builder_view ...\n\nIf you're working on the documentation, you can run the following command to start a live-reloading server without\ngathering the chart types fields data. It will speed up the process significantly, as we won't need to wait for the\nCKAN initialization:\n\n mkdocs serve -a 127.0.0.1:8001\n\n## License\n\n[AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)\n",
"bugtrack_url": null,
"license": "AGPL",
"summary": null,
"version": "1.5.0",
"project_urls": {
"Homepage": "https://github.com/DataShades/ckanext-charts"
},
"split_keywords": [
"ckan",
" charts",
" visualization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a0ec8c47d288edf49a87d109e5cc2339a535e12d0e6f3f2cc0e9ebd982550d98",
"md5": "a7e0908f55ba0780cf7e6b841600a8be",
"sha256": "29ff525d80181b2bf0d78974eba0082cbce1a8d1da695465dff4b2a416545aa4"
},
"downloads": -1,
"filename": "ckanext_charts-1.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a7e0908f55ba0780cf7e6b841600a8be",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 2158344,
"upload_time": "2025-01-26T11:43:24",
"upload_time_iso_8601": "2025-01-26T11:43:24.129135Z",
"url": "https://files.pythonhosted.org/packages/a0/ec/8c47d288edf49a87d109e5cc2339a535e12d0e6f3f2cc0e9ebd982550d98/ckanext_charts-1.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "956a59fd46818cabeb9699811309d3b89c6672c25640e494dbf882d1c753befa",
"md5": "4b971d1ddd6e7c87f8abface894ebb18",
"sha256": "8ee2823720bcf5cb89911e9765f9dc5e735b9effeac1d679861de19c0c8b6923"
},
"downloads": -1,
"filename": "ckanext_charts-1.5.0.tar.gz",
"has_sig": false,
"md5_digest": "4b971d1ddd6e7c87f8abface894ebb18",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 2123671,
"upload_time": "2025-01-26T11:43:27",
"upload_time_iso_8601": "2025-01-26T11:43:27.077044Z",
"url": "https://files.pythonhosted.org/packages/95/6a/59fd46818cabeb9699811309d3b89c6672c25640e494dbf882d1c753befa/ckanext_charts-1.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-26 11:43:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DataShades",
"github_project": "ckanext-charts",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "ckanext-charts"
}
JSON
