No project description provided
Project description
ckanext-composite-search
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-composite-search:
-
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-composite-search.git cd ckanext-composite-search pip install -e . pip install -r requirements.txt
-
Add
composite-search
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.composite_search.some_setting = some_default_value
Developer installation
To install ckanext-composite-search for development, activate your CKAN virtualenv and do:
git clone https://github.com/DataShades/ckanext-composite-search.git
cd ckanext-composite-search
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-composite-search
If ckanext-composite-search 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-composite-search-0.0.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d0bdf74b2b8577663a62aa77892fe9523f8aad05c3d39ef98c33fe2850ed5dd |
|
MD5 | 6b509f16b0545237c6d0826d6f925a7d |
|
BLAKE2b-256 | 60e0e5b2d81b418fcb5c1208c78c1c6ffa4813608730398b7b63c3e4113af95e |
Hashes for ckanext_composite_search-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f00a36bfad23b3b1d35124d9527ae4f55f0a97c7380bb60c22058e9a6b5c75e |
|
MD5 | aa13b937e4f678c6edb6a7f7cb575545 |
|
BLAKE2b-256 | ce2c94df751f1ab9c095d64829b42da44d121b32bc8019a2debbf1e29e802e31 |