No project description provided
Project description
ckanext-federated-index
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-federated-index:
-
Activate your CKAN virtual environment, for example:
. /usr/lib/ckan/default/bin/activate
-
Clone the source and install it on the virtualenv
git clone https://github.com/DataShades/ckanext-federated-index.git cd ckanext-federated-index pip install -e . pip install -r requirements.txt
-
Add
federated-index
to theckan.plugins
setting in your CKAN config file (by default the config file is located at/etc/ckan/default/ckan.ini
). -
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.federated_index.some_setting = some_default_value
Developer installation
To install ckanext-federated-index for development, activate your CKAN virtualenv and do:
git clone https://github.com/DataShades/ckanext-federated-index.git
cd ckanext-federated-index
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-federated-index
If ckanext-federated-index should be available on PyPI you can follow these steps to publish a new version:
-
Update the version number in the
setup.py
file. See PEP 440 for how to choose version numbers. -
Make sure you have the latest version of necessary packages:
pip install --upgrade setuptools wheel twine
-
Create a source and binary distributions of the new version:
python setup.py sdist bdist_wheel && twine check dist/*
Fix any errors you get.
-
Upload the source distribution to PyPI:
twine upload dist/*
-
Commit any outstanding changes:
git commit -a git push
-
Tag the new release of the project on GitHub with the version number from the
setup.py
file. For example if the version number insetup.py
is 0.0.1 then do:git tag 0.0.1 git push --tags
License
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
Built Distribution
Hashes for ckanext-federated-index-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e88230f5ed5e0820d3a5d6b8333219a24b24b12ed983a94b3755773f652153ea |
|
MD5 | 80a0666889dad7049246e16ac977baa0 |
|
BLAKE2b-256 | b9af72dce0d27d738dfc73e33d828e95846a2b85e5bc93a5eb38712e16598257 |
Hashes for ckanext_federated_index-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09c5e6aab270d04416f452353e7474e695b660c2d96d3b6e4b83c5bfb24335e5 |
|
MD5 | d6af65dbe11a82f4690f6dac5c14cb51 |
|
BLAKE2b-256 | eb1a866306d31f4094ad6e6c44505eb01d4816235e7253ed0ce0b8cb06cc6d4d |