https://github.com/dathere/ckanext-boernetx_theme
https://github.com/dathere/ckanext-boernetx_theme
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dathere/ckanext-boernetx_theme
- Owner: dathere
- License: agpl-3.0
- Created: 2022-08-23T15:23:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-04T20:29:41.000Z (about 1 year ago)
- Last Synced: 2025-02-04T21:27:54.956Z (about 1 year ago)
- Language: CSS
- Size: 2.72 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/TomeCirun/ckanext-boernetx_theme/actions)
# ckanext-boernetx_theme
**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!
## Requirements
**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:
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"
## 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-boernetx_theme:
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/TomeCirun/ckanext-boernetx_theme.git
cd ckanext-boernetx_theme
pip install -e .
pip install -r requirements.txt
3. Add `boernetx_theme` 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
## Config settings
None at present
**TODO:** Document any optional config settings here. For example:
# The minimum number of hours to wait before re-checking a resource
# (optional, default: 24).
ckanext.boernetx_theme.some_setting = some_default_value
## Developer installation
To install ckanext-boernetx_theme for development, activate your CKAN virtualenv and
do:
git clone https://github.com/TomeCirun/ckanext-boernetx_theme.git
cd ckanext-boernetx_theme
python setup.py develop
pip install -r dev-requirements.txt
## Tests
To run the tests, do:
pytest --ckan-ini=test.ini
## Releasing a new version of ckanext-boernetx_theme
If ckanext-boernetx_theme 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)