Skip to main content

Add a support of wysiwyg editors for CKAN

Project description

Tests

ckanext-wysiwyg

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-wysiwyg:

  1. Activate your CKAN virtual environment, for example:

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

  2. Clone the source and install it on the virtualenv

    git clone https://github.com/DataShades/ckanext-wysiwyg.git cd ckanext-wysiwyg pip install -e . pip install -r requirements.txt

  3. Add wysiwyg to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

  4. 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.wysiwyg.some_setting = some_default_value

Developer installation

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

git clone https://github.com/DataShades/ckanext-wysiwyg.git
cd ckanext-wysiwyg
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-wysiwyg

If ckanext-wysiwyg 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_wysiwyg-0.2.25.tar.gz (556.6 kB view details)

Uploaded Source

Built Distribution

ckanext_wysiwyg-0.2.25-py3-none-any.whl (561.4 kB view details)

Uploaded Python 3

File details

Details for the file ckanext_wysiwyg-0.2.25.tar.gz.

File metadata

  • Download URL: ckanext_wysiwyg-0.2.25.tar.gz
  • Upload date:
  • Size: 556.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.10

File hashes

Hashes for ckanext_wysiwyg-0.2.25.tar.gz
Algorithm Hash digest
SHA256 0c266649977b48f18f397ded36270a63180e4f1b88d5f8e5ef567b73f557376a
MD5 d3c6d99f11c27a4c6bbe70054f66fad5
BLAKE2b-256 cf8ed4abbfaa4637e4a7d61282d3caae485fdc901c84d6e33b2d061481db1cf4

See more details on using hashes here.

File details

Details for the file ckanext_wysiwyg-0.2.25-py3-none-any.whl.

File metadata

File hashes

Hashes for ckanext_wysiwyg-0.2.25-py3-none-any.whl
Algorithm Hash digest
SHA256 67820f9cd760ea0d35e334145930981908c6ff2b20b1bd7c9b84bbc5a4acb790
MD5 28add54b7bb22540bce09942de498d43
BLAKE2b-256 d53935ee54e82ca55a2351a0fff85435652018a2b1f81fdef07e89d9251ce87d

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