[](https://github.com//ckanext-wysiwyg/actions)
# 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//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//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](http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers) 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](https://www.gnu.org/licenses/agpl-3.0.en.html)
Raw data
{
"_id": null,
"home_page": "https://github.com//ckanext-wysiwyg",
"name": "ckanext-wysiwyg",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "CKAN",
"author": "Oleksandr Cherniavskiy",
"author_email": "mutantsan@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a2/cd/de9f327c7f15a9fc1fb439cf9dd8ad9bfdc7d2ca16862aadc78720a172c7/ckanext_wysiwyg-0.1.21.tar.gz",
"platform": null,
"description": "[](https://github.com//ckanext-wysiwyg/actions)\n\n# ckanext-wysiwyg\n\n**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!\n\n\n## Requirements\n\n**TODO:** For example, you might want to mention here which versions of CKAN this\nextension works with.\n\nIf your extension works across different versions you can add the following table:\n\nCompatibility with core CKAN versions:\n\n| CKAN version | Compatible? |\n| --------------- | ------------- |\n| 2.6 and earlier | not tested |\n| 2.7 | not tested |\n| 2.8 | not tested |\n| 2.9 | not tested |\n\nSuggested values:\n\n* \"yes\"\n* \"not tested\" - I can't think of a reason why it wouldn't work\n* \"not yet\" - there is an intention to get it working\n* \"no\"\n\n\n## Installation\n\n**TODO:** Add any additional install steps to the list below.\n For example installing any non-Python dependencies or adding any required\n config settings.\n\nTo install ckanext-wysiwyg:\n\n1. Activate your CKAN virtual environment, for example:\n\n . /usr/lib/ckan/default/bin/activate\n\n2. Clone the source and install it on the virtualenv\n\n git clone https://github.com//ckanext-wysiwyg.git\n cd ckanext-wysiwyg\n pip install -e .\n\tpip install -r requirements.txt\n\n3. Add `wysiwyg` to the `ckan.plugins` setting in your CKAN\n config file (by default the config file is located at\n `/etc/ckan/default/ckan.ini`).\n\n4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:\n\n sudo service apache2 reload\n\n\n## Config settings\n\nNone at present\n\n**TODO:** Document any optional config settings here. For example:\n\n\t# The minimum number of hours to wait before re-checking a resource\n\t# (optional, default: 24).\n\tckanext.wysiwyg.some_setting = some_default_value\n\n\n## Developer installation\n\nTo install ckanext-wysiwyg for development, activate your CKAN virtualenv and\ndo:\n\n git clone https://github.com//ckanext-wysiwyg.git\n cd ckanext-wysiwyg\n python setup.py develop\n pip install -r dev-requirements.txt\n\n\n## Tests\n\nTo run the tests, do:\n\n pytest --ckan-ini=test.ini\n\n\n## Releasing a new version of ckanext-wysiwyg\n\nIf ckanext-wysiwyg should be available on PyPI you can follow these steps to publish a new version:\n\n1. Update the version number in the `setup.py` file. See [PEP 440](http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers) for how to choose version numbers.\n\n2. Make sure you have the latest version of necessary packages:\n\n pip install --upgrade setuptools wheel twine\n\n3. Create a source and binary distributions of the new version:\n\n python setup.py sdist bdist_wheel && twine check dist/*\n\n Fix any errors you get.\n\n4. Upload the source distribution to PyPI:\n\n twine upload dist/*\n\n5. Commit any outstanding changes:\n\n git commit -a\n git push\n\n6. Tag the new release of the project on GitHub with the version number from\n the `setup.py` file. For example if the version number in `setup.py` is\n 0.0.1 then do:\n\n git tag 0.0.1\n git push --tags\n\n## License\n\n[AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)\n",
"bugtrack_url": null,
"license": "AGPL",
"summary": "Add a support of wysiwyg editors for CKAN",
"version": "0.1.21",
"project_urls": {
"Homepage": "https://github.com//ckanext-wysiwyg"
},
"split_keywords": [
"ckan"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "02ff798ab02dc2c28c7568bfa96d87edddd5bd578c963afff08760ba0e5e9e2a",
"md5": "c75d2b1393b63876d2074e622388783d",
"sha256": "24a2a34bed717d4bfc6db8393a04cefdbd3702507735203f0a4e43d64b70b38b"
},
"downloads": -1,
"filename": "ckanext_wysiwyg-0.1.21-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c75d2b1393b63876d2074e622388783d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 461442,
"upload_time": "2024-04-29T11:20:30",
"upload_time_iso_8601": "2024-04-29T11:20:30.489419Z",
"url": "https://files.pythonhosted.org/packages/02/ff/798ab02dc2c28c7568bfa96d87edddd5bd578c963afff08760ba0e5e9e2a/ckanext_wysiwyg-0.1.21-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a2cdde9f327c7f15a9fc1fb439cf9dd8ad9bfdc7d2ca16862aadc78720a172c7",
"md5": "2787fcf5eba652f73251aab0388d4afb",
"sha256": "12c84b57dd58d00b4d6e2f0f72e8c02857a6b515d1064843bcdd6ed2c3b47d2a"
},
"downloads": -1,
"filename": "ckanext_wysiwyg-0.1.21.tar.gz",
"has_sig": false,
"md5_digest": "2787fcf5eba652f73251aab0388d4afb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 456791,
"upload_time": "2024-04-29T11:20:33",
"upload_time_iso_8601": "2024-04-29T11:20:33.165600Z",
"url": "https://files.pythonhosted.org/packages/a2/cd/de9f327c7f15a9fc1fb439cf9dd8ad9bfdc7d2ca16862aadc78720a172c7/ckanext_wysiwyg-0.1.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 11:20:33",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ckanext-wysiwyg"
}
JSON