معرفی شرکت ها
ckanext-showcase-1.5.1
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
A ckan extension to showcase datasets in use
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | ckanext-showcase-1.5.1 |
| نام | ckanext-showcase |
| نسخه کتابخانه | 1.5.1 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Brook Elgie |
| ایمیل نویسنده | brook.elgie@okfn.org |
| آدرس صفحه اصلی | https://github.com/ckan/ckanext-showcase |
| آدرس اینترنتی | https://pypi.org/project/ckanext-showcase/ |
| مجوز | AGPL |
.. You should enable this project on travis-ci.org and coveralls.io to make
these badges work. The necessary Travis and Coverage config files have been
generated for you.
.. image:: https://github.com/ckan/ckanext-showcase/workflows/Tests/badge.svg?branch=master
:target: https://github.com/ckan/ckanext-showcase/actions
.. image:: https://codecov.io/gh/ckan/ckanext-showcase/branch/master/graph/badge.svg
:target: https://codecov.io/gh/ckan/ckanext-showcase
================
ckanext-showcase
================
Showcase and link to datasets in use. Datasets used in an app, website or
visualization, or featured in an article, report or blog post can be showcased
within the CKAN website. Showcases can include an image, description, tags and
external link. Showcases may contain several datasets, helping users discover
related datasets being used together. Showcases can be discovered by searching
and filtered by tag.
Site sysadmins can promote selected users to become 'Showcase Admins' to help
create, populate and maintain showcases.
ckanext-showcase is intended to be a more powerful replacement for the
'Related Item' feature.
------------
Requirements
------------
Tested on CKAN 2.7 to 2.10..
------------
Installation
------------
.. 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-showcase:
1. Activate your CKAN virtual environment, for example::
. /usr/lib/ckan/default/bin/activate
2. Install the ckanext-showcase Python package into your virtual environment::
pip install ckanext-showcase
3. Add ``showcase`` to the ``ckan.plugins`` setting in your CKAN
config file (by default the config file is located at
``/etc/ckan/default/production.ini``).
4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu::
sudo service apache2 reload
------------------------
Development Installation
------------------------
To install ckanext-showcase for development, activate your CKAN virtualenv and
do::
git clone https://github.com/ckan/ckanext-showcase.git
cd ckanext-showcase
python setup.py develop
pip install -r dev-requirements.txt
The extension contains a custom build of CKEditor to allow using a WYSIWYG editor
to write the content of the showcase. It has been built using `webpack` and the
repository contains all the files needed to edit and customize it if needed::
npm install
npx webpack --config webpack.config.js
The webpack will use as entrypoint a file located in `ckanext/showcase/fanstatic/src/ckeditor.js`,
create a build and save it to `ckanext/showcase/fanstatic/dist/ckeditor.js`
More info on how to build CKEditor from source:
https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/advanced-setup.html#scenario-2-building-from-source
---
API
---
All actions in the Showcase extension are available in the CKAN Action API.
Showcase actions::
- create a new showcase (sysadmins and showcase admins only)
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_create -H "Authorization:{YOUR-API-KEY}" -d '{"name": "my-new-showcase"}'
- delete a showcase (sysadmins and showcase admins only)
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_delete -H "Authorization:{YOUR-API-KEY}" -d '{"name": "my-new-showcase"}'
- show a showcase
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_show -d '{"id": "my-new-showcase"}'
- list showcases
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_list -d ''
Dataset actions::
- add a dataset to a showcase (sysadmins and showcase admins only)
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_package_association_create -H "Authorization:{YOUR-API-KEY}" -d '{"showcase_id": "my-showcase", "package_id": "my-package"}'
- remove a dataset from a showcase (sysadmins and showcase admins only)
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_package_association_delete -H "Authorization:{YOUR-API-KEY}" -d '{"showcase_id": "my-showcase", "package_id": "my-package"}'
- list datasets in a showcase
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_package_list -d '{"showcase_id": "my-showcase"}'
- list showcases featuring a given dataset
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_package_showcase_list -d '{"package_id": "my-package"}'
Showcase admin actions::
- add showcase admin (sysadmins only)
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_admin_add -H "Authorization:{YOUR-API-KEY}" -d '{"username": "bert"}'
- remove showcase admin (sysadmins only)
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_admin_remove -H "Authorization:{YOUR-API-KEY}" -d '{"username": "bert"}'
- list showcase admins (sysadmins only)
curl -X POST http://127.0.0.1:5000/api/3/action/ckanext_showcase_admin_list -H "Authorization:{YOUR-API-KEY}" -d ''
---
UI
---
The Showcase extension adds the following pages to the user interface:
* The main showcase index is available on: ``http://127.0.0.1:5000/showcase``
* To create a new showcase: ``http://127.0.0.1:5000/showcase/new``
* To edit or delete a showcase: ``http://127.0.0.1:5000/showcase/edit/{showcase-name}``
* To add a Showcase Admin : ``http://127.0.0.1:5000/ckan-admin/showcase_admins``
---------------------
Configuration
---------------------
If you want to use the WYSIWYG editor instead of Markdown to write the content of the showcase::
ckanext.showcase.editor = ckeditor
-----------------------------------------------
Migrating Showcases Notes from Markdown to HTML
-----------------------------------------------
When using CKEditor as WYSIWYG editor showcases notes are stored in HTML
instead of Markdown. To migrate all existing notes from markdown to
HTML you can use the ```showcase markdown_to_html``` command.
From the ``ckanext-showcase`` directory::
paster showcase markdown-to-html -c {path to production.ini}
-----------------
Running the Tests
-----------------
To run the tests, do::
nosetests --ckan --nologcapture --with-pylons=test.ini
To run the tests and produce a coverage report, first make sure you have
coverage installed in your virtualenv (``pip install coverage``) then run::
nosetests --ckan --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.showcase --cover-inclusive --cover-erase --cover-tests
------------------------------------
Registering ckanext-showcase on PyPI
------------------------------------
ckanext-showcase should be availabe on PyPI as
https://pypi.python.org/pypi/ckanext-showcase. If that link doesn't work, then
you can register the project on PyPI for the first time by following these
steps:
1. Create a source distribution of the project::
python setup.py sdist
2. Register the project::
python setup.py register
3. Upload the source distribution to PyPI::
python setup.py sdist upload
4. 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-showcase
-------------------------------------------
ckanext-showcase is availabe on PyPI as https://pypi.python.org/pypi/ckanext-showcase.
To publish a new version to PyPI follow these steps:
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. Create a source distribution of the new version::
python setup.py sdist
3. Upload the source distribution to PyPI::
python setup.py sdist upload
4. 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
-------------------------------------------
i18n
-------------------------------------------
See: "Internationalizing strings in extensions" : http://docs.ckan.org/en/latest/extensions/translating-extensions.html
1. Install babel
pip install Babel
2. Init Catalog for your language
python setup.py init_catalog -l es
3. Compile your language catalog ( You can force pybabel compile to compile messages marked as fuzzy with the -f)
python setup.py compile_catalog -f -l es
نحوه نصب
نصب پکیج whl ckanext-showcase-1.5.1:
pip install ckanext-showcase-1.5.1.whl
نصب پکیج tar.gz ckanext-showcase-1.5.1:
pip install ckanext-showcase-1.5.1.tar.gz