Allows creating tickets in redmine instance
Project description
CKAN plugin to automatically create redmine issues when new dataset appears.
Requirements
Tested with CKAN 2.5.x branch
Requires celery
To work over SSL, requires pyOpenSSL, ndg-httpsclient and pyasn1
Installation
To install ckanext-redmine:
Activate your CKAN virtual environment, for example:
. /usr/lib/ckan/default/bin/activate
Install the ckanext-redmine Python package into your virtual environment:
pip install ckanext-redmine
Add redmine to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini).
Restart CKAN. For example if you’ve deployed CKAN with Apache on Ubuntu:
sudo service apache2 reload
You will also need to set up celery. In a development environment this can be done with the following paster command from within your virtual environment:
paster --plugin=ckan celeryd run -c /etc/ckan/default/development.ini
Config Settings
# The URL of the Redmine site ckan.redmine.url = https://redmine.example.org/ # Redmine API key ckan.redmine.apikey = CHANGE_THIS_OR_IT_WONT_WORK # Redmine project ckan.redmine.project = my_project # The custom metadata flag used for storing redmine URL # (optional, default: redmine_url). ckan.redmine.flag = redmine_url # A prefix to apply to the name of the dataset when creating an issue # (optional, default: New dataset) ckan.redmine.subject_prefix = New dataset
Development Installation
To install ckanext-redmine-autoissues for development, activate your CKAN virtualenv and do:
git clone https://github.com/sorki/ckanext-redmine-autoissues.git cd ckanext-redmine-autoissues python setup.py develop pip install -r dev-requirements.txt
See also Installation
Running Celery in production
Place the provided ckan-celery.service file to /etc/systemd/system/:
cp ckan-celery.service /etc/systemd/system/ systemctl daemon-reload systemctl start ckan-celery # check with systemctl status -l ckan-celery # watch with journalctl -f # enable permanently with systemctl enable ckan-celery
Registering ckanext-redmine-autoissues on PyPI
ckanext-redmine-autoissues should be availabe on PyPI as https://pypi.python.org/pypi/ckanext-redmine-autoissues. If that link doesn’t work, then you can register the project on PyPI for the first time by following these steps:
Create a source distribution of the project:
python setup.py sdist
Register the project:
python setup.py register
Upload the source distribution to PyPI:
python setup.py sdist upload
Tag the first 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
Releasing a New Version of ckanext-redis-autoissues
ckanext-redis-autoissues is availabe on PyPI as https://pypi.python.org/pypi/ckanext-redis-autoissues. To publish a new version to PyPI follow these steps:
Update the version number in the setup.py file. See PEP 440 for how to choose version numbers.
Create a source distribution of the new version:
python setup.py sdist
Upload the source distribution to PyPI:
python setup.py sdist upload
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.2 then do:
git tag 0.0.2 git push --tags
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
File details
Details for the file ckanext-redmine-autoissues-1.0.0.tar.gz
.
File metadata
- Download URL: ckanext-redmine-autoissues-1.0.0.tar.gz
- Upload date:
- Size: 7.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a03b0bb0492522f7df9f7d18ab003db90ae1bda36f4dadd1c21d7ea594e9f4d |
|
MD5 | f0034be5cf5438e4de61d3986193ef73 |
|
BLAKE2b-256 | 6a44a8987fafac534a492cd78d99f0c84e09a4c072334f1710843ab38f7ca7fe |