Skip to main content

Create short URLs for datasets and resources

Project description

Tests

ckanext-short-urls

This extensions creates a short permanent urls for datasets and resources so they can be referenced in articles and other places. https://yourckan.org/link/xxxx -> https://yourcan.org/dataset/my-dataset/resource/xyz

Requirements

The extension has been developed and tested with CKAN 2.9 + python3

Installation

To install ckanext-short-urls:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate

  2. Install the extension

    pip install ckanext-short-urls

  3. [optional] Or install from source:

    git clone https://github.com/fjelltopp/ckanext-short-urls.git cd ckanext-short-urls pip install -e . pip install -r requirements.txt

  4. Add short-urls to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

  5. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:

    sudo service apache2 reload
    
  6. Initialize the extensions db

    ckan -c ckan.ini short-urls initdb
    

Migration of already existing datasets and resources

You can create short urls for all already existing datasets and resources with the command:

ckan -c ckan.ini short-urls migrate

Developer installation

To install ckanext-short-urls for development, activate your CKAN virtualenv and do:

git clone https://github.com/fjelltopp/ckanext-short-urls.git
cd ckanext-short-urls
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-short-urls

If ckanext-short-urls 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 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ckanext-short-urls-0.0.1.tar.gz (22.4 kB view details)

Uploaded Source

Built Distribution

ckanext_short_urls-0.0.1-py3-none-any.whl (23.9 kB view details)

Uploaded Python 3

File details

Details for the file ckanext-short-urls-0.0.1.tar.gz.

File metadata

  • Download URL: ckanext-short-urls-0.0.1.tar.gz
  • Upload date:
  • Size: 22.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for ckanext-short-urls-0.0.1.tar.gz
Algorithm Hash digest
SHA256 f2534fb78368e55a23d1c1ca4ff75dba7de4d180b7895fd03665d647cc2e3f42
MD5 07643c4fdfcb344dbf0e76e024acc6d7
BLAKE2b-256 b4d7a7f7cbf2c24d6a87821bb281d576931dd4768bd179c9392c19f3c4818f5c

See more details on using hashes here.

File details

Details for the file ckanext_short_urls-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: ckanext_short_urls-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 23.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for ckanext_short_urls-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 55fdf4e0242cace5c20dfcf2ccf25cabae4197a21b956987f0c2188423e4b2a5
MD5 8e62f8fff02521c2a0ec340ca3700a6f
BLAKE2b-256 8440dcd3e0816d1ee808d83cba934424aa16fa961ee241b05aaf4fd865fae0ad

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page