diff --git a/README.md b/README.md index 03d69b0..10590f3 100644 --- a/README.md +++ b/README.md @@ -2,70 +2,35 @@ # ckanext-charts -**TODO:** Put a description of your extension here: What does it do? What features does it have? Consider including some screenshots or embedding a video! +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. -## Requirements +With ckanext-charts, users can easily generate interactive and visually appealing charts to enhance data analysis and presentation in CKAN. -**TODO:** For example, you might want to mention here which versions of CKAN this -extension works with. -If your extension works across different versions you can add the following table: +## Requirements Compatibility with core CKAN versions: | CKAN version | Compatible? | | --------------- | ------------- | -| 2.6 and earlier | not tested | -| 2.7 | not tested | -| 2.8 | not tested | -| 2.9 | not tested | - -Suggested values: - -* "yes" -* "not tested" - I can't think of a reason why it wouldn't work -* "not yet" - there is an intention to get it working -* "no" +| 2.9 and earlier | no | +| 2.10+ | yes | ## Installation -**TODO:** Add any additional install steps to the list below. - For example installing any non-Python dependencies or adding any required - config settings. - -To install ckanext-charts: - -1. Activate your CKAN virtual environment, for example: - - . /usr/lib/ckan/default/bin/activate - -2. Clone the source and install it on the virtualenv - - git clone https://github.com/DataShades/ckanext-charts.git - cd ckanext-charts - pip install -e . - pip install -r requirements.txt - -3. Add `charts` to the `ckan.plugins` setting in your CKAN - config file (by default the config file is located at - `/etc/ckan/default/ckan.ini`). - -4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu: - - sudo service apache2 reload - +- Install it with `PyPi` with `pip install ckanext-charts` +- Add `charts_view` to the list of plugins in your CKAN config (`ckan.plugins = charts_view`) ## Config settings -None at present -**TODO:** Document any optional config settings here. For example: +List of config options: - # The minimum number of hours to wait before re-checking a resource - # (optional, default: 24). - ckanext.charts.some_setting = some_default_value + # Caching strategy for chart data (required, default: redis). + ckanext-charts = disk ## Developer installation @@ -86,38 +51,6 @@ To run the tests, do: pytest --ckan-ini=test.ini -## Releasing a new version of ckanext-charts - -If ckanext-charts should be available on PyPI you can follow these steps to publish a new version: - -1. Update the version number in the `setup.py` file. See [PEP 440](http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers) for how to choose version numbers. - -2. Make sure you have the latest version of necessary packages: - - pip install --upgrade setuptools wheel twine - -3. Create a source and binary distributions of the new version: - - python setup.py sdist bdist_wheel && twine check dist/* - - Fix any errors you get. - -4. Upload the source distribution to PyPI: - - twine upload dist/* - -5. Commit any outstanding changes: - - git commit -a - git push - -6. Tag the new release of the project on GitHub with the version number from - the `setup.py` file. For example if the version number in `setup.py` is - 0.0.1 then do: - - git tag 0.0.1 - git push --tags - ## License [AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)