Saravanan666/pypi-org huggingface dataset:
Package: ckanext-query-dois
ckanext-query-doisA CKAN extension that creates DOIs for queries on resources.OverviewThis extension creates (mints) digital object identifiers (DOIs) for queries on resources. By recording the query parameters used and the exact version of the data at the time of the query, this allows precise retrieval of the data as it looked when the DOI was minted.Can be used in conjunction withv5.2+ofckanext-versioned-datastore.You will need an account with a DataCite DOI service provider to use this extension.InstallationPath variables used below:$INSTALL_FOLDER(i.e. where CKAN is installed), e.g./usr/lib/ckan/default$CONFIG_FILE, e.g./etc/ckan/default/development.iniInstalling from PyPIpipinstallckanext-query-doisInstalling from sourceClone the repository into thesrcfolder:cd$INSTALL_FOLDER/src
gitclonehttps://github.com/NaturalHistoryMuseum/ckanext-query-dois.gitActivate the virtual env:.$INSTALL_FOLDER/bin/activateInstall via pip:pipinstall$INSTALL_FOLDER/src/ckanext-query-doisInstalling in editable modeInstalling from apyproject.tomlin editable mode (i.e.pip install -e) requiressetuptools>=64; however, CKAN 2.9 requiressetuptools==44.1.0. Seeour CKAN forkfor a version of v2.9 that uses an updated setuptools if this functionality is something you need.Post-install setupAdd 'query_dois' to the list of plugins in your$CONFIG_FILE:ckan.plugins=... query_doisInstalllesscglobally:npminstall-g"less@~4.1"Initialise database tables:ckan-c$CONFIG_FILEquery-doisinitdbSign up for an account withDataCiteand provide the credentials in your configuration.ConfigurationThese are the options that can be specified in your .ini config file.[REQUIRED]NameDescriptionOptionsckanext.query_dois.prefixPrefix to use for the new DOIsckanext.query_dois.datacite_usernameDatacite account usernameckanext.query_dois.datacite_passwordDatacite account passwordckanext.query_dois.doi_titleTemplate string for the DOI title: takescountas a format argumentckanext.query_dois.publisherDOI publisher nameOther optionsNameDescriptionOptionsDefaultckanext.query_dois.test_modeEnable/disable using test DOIs (i.e. not creating real DOIs)True/FalseTrueUsageCommandsinitdbInitialises the database table.initdb: initialise the database modelckan-c$CONFIG_FILEquery-doisinitdbTestingThere is a Docker compose configuration available in this repository to make it easier to run tests. The ckan image uses the Dockerfile in thedocker/folder.To run the tests against ckan 2.9.x on Python3:Build the required images:docker-composebuildThen run the tests.
The root of the repository is mounted into the ckan container as a volume by the Docker compose
configuration, so you should only need to rebuild the ckan image if you change the extension's
dependencies.docker-composerunckan
Package: ckanext-recaptcha
ckanext-recaptchaTODO:Put a description of your extension here:  What does it do? What features does it have? Consider including some screenshots or embedding a video!RequirementsTODO: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 versionCompatible?2.6 and earliernot tested2.7not tested2.8not tested2.9not testedSuggested 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"InstallationTODO: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-recaptcha:Activate your CKAN virtual environment, for example:. /usr/lib/ckan/default/bin/activateClone the source and install it on the virtualenvgit clonehttps://github.com/DataShades/ckanext-recaptcha.gitcd ckanext-recaptcha
pip install -e .
pip install -r requirements.txtAddrecaptchato theckan.pluginssetting in your CKAN
config file (by default the config file is located at/etc/ckan/default/ckan.ini).Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:sudo service apache2 reloadConfig settingsNone at presentTODO:Document any optional config settings here. For example:# The minimum number of hours to wait before re-checking a resource
# (optional, default: 24).
ckanext.recaptcha.some_setting = some_default_valueDeveloper installationTo install ckanext-recaptcha for development, activate your CKAN virtualenv and
do:git clone https://github.com/DataShades/ckanext-recaptcha.git
cd ckanext-recaptcha
python setup.py develop
pip install -r dev-requirements.txtTestsTo run the tests, do:pytest --ckan-ini=test.iniReleasing a new version of ckanext-recaptchaIf ckanext-recaptcha should be available on PyPI you can follow these steps to publish a new version:Update the version number in thesetup.pyfile. SeePEP 440for how to choose version numbers.Make sure you have the latest version of necessary packages:pip install --upgrade setuptools wheel twineCreate a source and binary distributions of the new version:python setup.py sdist bdist_wheel && twine check dist/*Fix any errors you get.Upload the source distribution to PyPI:twine upload dist/*Commit any outstanding changes:git commit -a
git pushTag the new release of the project on GitHub with the version number from
thesetup.pyfile. For example if the version number insetup.pyis
0.0.1 then do:git tag 0.0.1
git push --tagsLicenseAGPL
Package: ckanext-resourcedictionary
ckanext-resourcedictionaryExtends the default CKAN Data Dictionary functionality by adding possibility to create data dictionary before actual data is uploaded to datastore.
For resources that don't have datastore records, the data dictionary can be edited in every way (adding/removing/editing fields) and even completely deleted.
For resources that contain datastore records editing data dictionary is limited only to the info properties of a field.
Resource dictionary fields, labels and notes are added to the SOLR index as a resource extras.RequirementsCompatibility with core CKAN versions:CKAN versionCompatible?2.9yesInstallationTo install ckanext-resourcedictionary:Activate your CKAN virtual environment, for example:. /usr/lib/ckan/default/bin/activateClone the source and install it on the virtualenvgit clone https://github.com/keitaroinc/ckanext-resourcedictionary.git
cd ckanext-resourcedictionary
pip install -e .
pip install -r requirements.txtAddresourcedictionarybefore thedatastoreto theckan.pluginssetting in your CKAN
config file (by default the config file is located at/etc/ckan/default/ckan.ini).ckan.plugins = resourcedictionary datastoreRestart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:sudo service apache2 reloadConfig settingsNone at presentDeveloper installationTo install ckanext-resourcedictionary for development, activate your CKAN virtualenv and
do:git clone https://github.com/keitaroinc/ckanext-resourcedictionary.git
cd ckanext-resourcedictionary
python setup.py develop
pip install -r dev-requirements.txtAPIResource Dictionary API:POST /api/v3/resource_dictionary_createTestsTo run the tests, do:pytest --ckan-ini=test.iniReleasing a new version of ckanext-resourcedictionaryIf ckanext-resourcedictionary should be available on PyPI you can follow these steps to publish a new version:Update the version number in thesetup.pyfile. SeePEP 440for how to choose version numbers.Make sure you have the latest version of necessary packages:pip install --upgrade setuptools wheel twineCreate a source and binary distributions of the new version:python setup.py sdist bdist_wheel && twine check dist/*Fix any errors you get.Upload the source distribution to PyPI:twine upload dist/*Commit any outstanding changes:git commit -a
git pushTag the new release of the project on GitHub with the version number from
thesetup.pyfile. For example if the version number insetup.pyis
0.0.1 then do:git tag 0.0.1
git push --tagsLicenseAGPL
Package: ckanext-restricted_api
CKAN Restricted APIExtension to allow dataset restriction via CKAN API.Documentation:https://envidat.gitlab-pages.wsl.ch/ckanext-restricted_api/Source Code:https://gitlabext.wsl.ch/EnviDat/ckanext-restricted_apiThis plugin is primarily intended for custom frontends built on the CKAN API.Requires CKAN >= 2.10. For <2.10, use ckanext-restricted-api==1.0.0Restrict the accessibility to the resources of a dataset.This way the package metadata is accesible but not the data itself (resource).The resource access restriction level can be individualy defined for every package.Based on work by @espona (Lucia Espona Pernas) for ckanext-restricted (https://github.com/EnviDat/ckanext-restricted).Installpipinstallckanext-restricted-apiConfigOptional variables can be set in your ckan.ini:restricted_api.access_request_templateDescription: Path to access request template to render as html email.Default: uses default template.restricted_api.access_granted_templateDescription: Path to access granted template to render as html email.Default: uses default template.ckanext.restricted_api.omit_resources_on_pkg_listDescription: on current_package_list_with_resources
omit resources completely, or process them all to restrict fields (this may not be performant).Default: True (to maximise performance).The Restricted DictThis plugin works by storing information in theextrafield of theresourcetable in CKAN.By default, CKAN extras values are extracted into the package/resource JSONs returned by the API.The keyrestrictedis stored, with a value containing a nested dictionary of:level: a string containing the restriction level, with options:publicany userregisteredonly registered usersonly_allowed_usersonly users specified in theallowed_userskey.any_organizationany user that is a member in an organisation.same_organizationonly users of the same organisation the dataset is within.allowed_users: a comma separated string containing specified allowed users,
to be used withonly_allowed_users.Example:"restricted":'{"level":"same_organization","allowed_users":""}'"only_allowed_users":'{"level":"same_organization","allowed_users":"user1,user2,user3"}'Granting AccessUsers can request access to a dataset by calling an API endpoint from a frontend.The package owner is emailed and can allow individual users to access the resource.
a. Access can be granted by updating the restricted dict (via the API / frontend).If access is granted, the user will be notified by email automatically.EndpointsPOSTGETNotesUsers who do not have restricted access have two fields redacted:url: to download the datasetrestricted: to see the restriction informationDownloading of the restricted resource is also not possible via the CKAN API.However, it should be noted, if resources are hosted in public S3 storage, then this obfuscation does not prevent direct download of the data.
Package: ckanext-s3filestore
ckanext-s3filestoreUse Amazon S3 as a filestore for resources.RequirementsRequires CKAN 2.5+InstallationTo install ckanext-s3filestore:Activate your CKAN virtual environment, for example:. /usr/lib/ckan/default/bin/activateInstall the ckanext-s3filestore Python package into your virtual environment:pip install ckanext-s3filestoreAdds3filestoreto theckan.pluginssetting in your CKAN
config file (by default the config file is located at/etc/ckan/default/production.ini).Restart CKAN. For example if you’ve deployed CKAN with Apache on Ubuntu:sudo service apache2 reloadConfig SettingsRequired:ckanext.s3filestore.aws_access_key_id = Your-AWS-Access-Key-ID
ckanext.s3filestore.aws_secret_access_key = Your-AWS-Secret-Access-Key
ckanext.s3filestore.aws_bucket_name = a-bucket-to-store-your-stuffOptional:# An optional path to prepend to keys
ckanext.s3filestore.aws_storage_path = my-site-name

# An optional setting to fallback to filesystem for downloads
ckanext.s3filestore.filesystem_download_fallback = true
# The ckan storage path option must also be set correctly for the fallback to work
ckan.storage_path = path/to/storage/directoryDevelopment InstallationTo install ckanext-s3filestore for development, activate your CKAN virtualenv and
do:git clone https://github.com/okfn/ckanext-s3filestore.git
cd ckanext-s3filestore
python setup.py develop
pip install -r dev-requirements.txt
pip install -r requirements.txtRunning the TestsTo run the tests, do:nosetests --ckan --nologcapture --with-pylons=test.iniTo 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.s3filestore --cover-inclusive --cover-erase --cover-testsRegistering ckanext-s3filestore on PyPIckanext-s3filestore should be available on PyPI ashttps://pypi.python.org/pypi/ckanext-s3filestore. If that link doesn’t work, then
you can register the project on PyPI for the first time by following these
steps:Create a source distribution of the project:python setup.py sdistRegister the project:python setup.py registerUpload the source distribution to PyPI:python setup.py sdist uploadTag the first release of the project on GitHub with the version number from
thesetup.pyfile. For example if the version number insetup.pyis
0.0.1 then do:git tag 0.0.1
git push --tagsReleasing a New Version of ckanext-s3filestoreckanext-s3filestore is available on PyPI ashttps://pypi.python.org/pypi/ckanext-s3filestore.
To publish a new version to PyPI follow these steps:Update the version number in thesetup.pyfile.
SeePEP 440for how to choose version numbers.Create a source distribution of the new version:python setup.py sdistUpload the source distribution to PyPI:python setup.py sdist uploadTag the new release of the project on GitHub with the version number from
thesetup.pyfile. For example if the version number insetup.pyis
0.0.2 then do:git tag 0.0.2
git push --tags
Package: ckanext-salford
CKAN extension forhttps://www.salforddataquay.uk/InstallationTo install ckanext-salford:Activate your CKAN virtual environment, for example:. /usr/lib/ckan/default/bin/activateInstall the ckanext-salford Python package into your virtual environment:pip install ckanext-salfordInstall the ckanext-esdstandards Python package into your virtual environment:pip install ckanext-esdstandardsAddsalfordandesdto theckan.pluginssetting in your CKAN
config file (by default the config file is located at/etc/ckan/default/production.ini).Add thelicenses_group_urlsetting to your CKAN config file.
For development use:licenses_group_url = http://127.0.0.1:5000/licenses.jsonFor production use:licenses_group_url = https://www.salforddataquay.uk/licenses.jsonInstall the Bower components:cd /ckanext/salford/fanstatic
bower installRestart CKAN. For example if you’ve deployed CKAN with Apache on Ubuntu:sudo service apache2 reloadConfigurationAdd the following configuration options to the ini file:ckan.i18n_directory = /usr/lib/ckan/default/src/ckanext-salford/src/ckanext-salford/
ckan.locale_default = en_GB
ckan.locales_filtered_out = enImporting Datasets from data.gov.ukTheetl.pyscript can import datasets from theSalford City Council publisher on data.gov.ukinto a development or production CKAN instance. Usage:pip install ckanapi
./etl.py -u 'http://127.0.0.1:5000' -a <your_api_key>
./etl.py -u 'https://www.salforddataquay.uk/' -a <your_api_key>Note that only non-UKLP datasets are imported for now, ie INSPIRE datasets on data.gov.uk
are not imported.
Package: ckanext-semantictags
ckanext-semantictags====================CKAN SemanticTags plugin gives the possibility for Open Data Portals to atribute semantic tags to their datasets.What can you do with the SemanticTags plugin?-------------------------------------------With the SemanticTags plugin you can:- Relate your CKAN tags with semantic objects- Define custom RDF predicates for linking your datasets with the Linked Open Data cloud- Connect several CKAN instances through the use of global semantic tagsWhy a SemanticTags plugin?-------------------------------------------CKAN core offers an RDF version of each database, which gives access to all metadata in Linked Open Data format. However, it does not allow linking the database to external semantic resources. SemanticTags fills this gap, allowing datasets to be tagged with LOD resources.------------Requirements------------CKAN >= 2.5------------Installation------------To install ckanext-semantictags:1. Activate your CKAN virtual environment, for example::. /usr/lib/ckan/default/bin/activate2. Install the ckanext-semantictags Python package into your virtual environment::pip install ckanext-semantictags3. Run the database migration::paster --plugin=ckanext-semantictags semantictags migrate -c /etc/ckan/default/production.ini3. Add ``semantictags`` to the ``ckan.plugins`` setting in your CKANconfig 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-semantictags for development, activate your CKAN virtualenv anddo::git clone https://github.com/alantygel/ckanext-semantictags.gitcd ckanext-semantictagspython setup.py developpaster --plugin=ckanext-semantictags semantictags migrate -c /etc/ckan/default/development.iniAdd ``semantictags`` to the ``ckan.plugins`` setting in your CKANconfig file (by default the config file is located at``/etc/ckan/default/development.ini``).
Package: ckanext-sentry
The Sentry CKAN extension allows to add aSentrymiddleware to the CKAN and stack and optionally configure a Sentry log handler.This extension builds on top of the previous work of:@noirbizarre onhttps://github.com/etalab/ckanext-sentry@rshk onhttps://github.com/opendatatrentino/ckanext-sentryInstallationTo install the extension, activate your virtualenv and run:pip install ckanext-sentryAlternative, you can install a development version with:git clone https://github.com/okfn/ckanext-sentry.git
cd ckanext-sentry
python setup.py develop
pip install -r requirements.txtConfigurationTo activate the plugin, addsentryto theckan.pluginskey in your ini file:ckan.plugins = sentry <other-plugins>You must provide a Sentry DSN:sentry.dsn = https://xxxxxx:xxxxxx@sentry.domain.com/1You can see a full list of supported options for the Sentry client on theofficial Raven documentation.If you want Sentry to record your log messages, you can turn it on adding the following options:sentry.configure_logging=True
sentry.log_level=WARNThe default log level if not provided in the configuration is INFO.All these configuration options can also be passed via environment variables:SENTRY_DSNorCKAN_SENTRY_DSNCKAN_SENTRY_CONFIGURE_LOGGINGCKAN_SENTRY_LOG_LEVELThe configuration also supports env vars named like theckanext-envvarsextension convention (egCKAN___SENTRY__LOG_LEVEL).
Package: ckanext-shopping-cart
ckanext-shopping-cartTODO:Put a description of your extension here:  What does it do? What features does it have? Consider including some screenshots or embedding a video!RequirementsTODO: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 versionCompatible?2.9yesmasteryesInstallationTo install ckanext-shopping-cart:Activate your CKAN virtual environment, for example:. /usr/lib/ckan/default/bin/activateClone the source and install it on the virtualenvgit clonehttps://github.com/DataShades/ckanext-shopping-cart.gitcd ckanext-shopping-cart
pip install -e .
pip install -r requirements.txtAddshopping-cartto theckan.pluginssetting in your CKAN
config file (by default the config file is located at/etc/ckan/default/ckan.ini).Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:sudo service apache2 reloadConfig settingsNone at presentTODO:Document any optional config settings here. For example:# The minimum number of hours to wait before re-checking a resource
# (optional, default: 24).
ckanext.shopping_cart.factory.default = redisTestsTo run the tests, do:pytest --ckan-ini=test.ini
Package: ckanext-short-urls
ckanext-short-urlsThis 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/xyzRequirementsThe extension has been developed and tested with CKAN 2.9 + python3InstallationTo install ckanext-short-urls:Activate your CKAN virtual environment, for example:. /usr/lib/ckan/default/bin/activateInstall the extensionpip install ckanext-short-urls[optional] Or install from source:git clonehttps://github.com/fjelltopp/ckanext-short-urls.gitcd ckanext-short-urls
pip install -e .
pip install -r requirements.txtAddshort-urlsto theckan.pluginssetting in your CKAN
config file (by default the config file is located at/etc/ckan/default/ckan.ini).Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:sudo service apache2 reloadInitialize the extensions dbckan -c ckan.ini short-urls initdbMigration of already existing datasets and resourcesYou can create short urls for all already existing datasets and resources with the command:ckan-cckan.inishort-urlsmigrateDeveloper installationTo 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.txtTestsTo run the tests, do:pytest --ckan-ini=test.iniReleasing a new version of ckanext-short-urlsIf ckanext-short-urls should be available on PyPI you can follow these steps to publish a new version:Update the version number in thesetup.pyfile. SeePEP 440for how to choose version numbers.Make sure you have the latest version of necessary packages:pip install --upgrade setuptools wheel twineCreate a source and binary distributions of the new version:python setup.py sdist bdist_wheel && twine check dist/*Fix any errors you get.Upload the source distribution to PyPI:twine upload dist/*Commit any outstanding changes:git commit -a
git pushTag the new release of the project on GitHub with the version number from
thesetup.pyfile. For example if the version number insetup.pyis
0.0.1 then do:git tag 0.0.1
git push --tagsLicenseAGPL