No project description provided
Project description
ckanext-drupal-api
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
- CKAN>=2.9
- python>=3.7
Installation
To install ckanext-drupal-api:
-
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-drupal-api.git cd ckanext-drupal-api pip install -e . pip install -r requirements.txt
-
Add
drupal-api
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 URL of connected drupal instance
ckanext.drupal_api.drupal_url = http://drupal.com
# Request timeout for API calls in seconds
# (optional, default: 5)
ckanext.drupal_api.timeout = 10
# Cache TTL in seconds
# (optional, default: 3600)
ckanext.drupal_api.cache.duration = 60
# HTTP auth credentials (optional)
ckanext.drupal_api.request.user = username
ckanext.drupal_api.request.pass = password
# API versions, only two options: core & json
# Because, there are two supported API versions: JSON API & RESTful Web Services
ckanext.drupal_api.api_version = json
# If you are using the core API version, you might face the situation when your endpoint differ from the default one
# In this case, you can specify the menu export endpoint through the config, e.g.:
ckanext.drupal_api.core.menu_export_endpoint = /api/v1/menu_export
Developer installation
To install ckanext-drupal-api for development, activate your CKAN virtualenv and do:
git clone https://github.com/DataShades/ckanext-drupal-api.git
cd ckanext-drupal-api
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-drupal-api
If ckanext-drupal-api 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_drupal_api-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 416c6566f44598cbe6430f56ff0cb1ef4a0306c0be637ee06865e10a856a98d2 |
|
MD5 | 279f37a30bd81022cb2fd91be171a94e |
|
BLAKE2b-256 | 60cd0f8179fb6e2b62a152641612b9fc0f32a3746f092bf424d8297ba35faebb |