Skip to main content

No project description provided

Project description

Tests

ckanext-files

Files as first-class citizens of CKAN. Upload, manage, remove files directly and attach them to datasets, resources, etc.

Read the documentation for a full user guide.

Quickstart

  1. Install the extension

    pip install ckanext-files
    
  2. Add files to the ckan.plugins setting in your CKAN config file.

  3. Run DB migrations

    ckan db upgrade -p files
    
  4. Configure storage

    ckanext.files.storage.default.type = files:fs
    ckanext.files.storage.default.path = /tmp/example
    ckanext.files.storage.default.create_path = true
    
  5. Upload your first file

    ckanapi action files_file_create upload@~/Downloads/file.txt`
    

Development

Install dev extras and nodeJS dependencies:

pip install -e '.[dev]'
npm ci

Run unittests:

pytest

Run frontend tests:

# start test server in separate terminal
make test-server

# run tests
npx cypress run

Run typecheck:

npx pyright

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_files-1.0.0a1.tar.gz (122.7 kB view hashes)

Uploaded Source

Built Distribution

ckanext_files-1.0.0a1-py3-none-any.whl (154.9 kB view hashes)

Uploaded Python 3

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