Saravanan666/pypi-org huggingface dataset:
Package: ckanext-keycloak
ckanext-keycloak - Keycloak authentication extensionCkanext-keycloak is a extension for enalbing the user authentication with Keycloak, an open source software product to allow single sign-on with Identity Management and Access Management aimed at modern applications and services.This extension provides an ability to let users use access-token from Keycloak server to access CKAN functions via CKAN REST Api.Notes:A new user will be created automatically in ckan database for the corresponding keycloak user if it does not exist.Original ckan authentication still works normally with this extension.RequirementsThis extension was developed and tested under CKAN-2.7.3 and Keycloak-2.5.5InstallationTo install ckanext-keycloak:Activate your CKAN virtual environment, for example:. /usr/lib/ckan/default/bin/activateInstall the ckanext-keycloak Python package into your virtual environment:pip install ckanext-keycloakAddkeycloaksetting in your CKAN config file (by default the config file is located at/etc/ckan/default/production.ini) as follows:ckan.plugins = keycloak <other-plugins>
ckan.keycloak.authorization_endpoint = http://localhost/auth
ckan.keycloak.realm = master
ckan.keycloak.client_id = client_id
ckan.keycloak.client_secret = client_secret
ckan.keycloak.sysadmin_group_name = admin
ckan.keycloak.profile_group_field = group
ckan.keycloak.profile_username_field = preferred_username
ckan.keycloak.profile_email_field = email
ckan.keycloak.profile_fullname_field = nameRestart CKAN. For example if you’ve deployed CKAN with Apache on Ubuntu:sudo service apache2 reloadDevelopment InstallationTo install ckanext-keycloak for development, activate your CKAN virtualenv and
do:git clone https://github.com/etri-odp/ckanext-keycloak.git
cd ckanext-keycloak
python setup.py develop
pip install -r dev-requirements.txtRunning the TestsTo run the tests, do:nosetests --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 --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.keycloak --cover-inclusive --cover-erase --cover-testsRegistering ckanext-keycloak on PyPIckanext-keycloak should be availabe on PyPI ashttps://pypi.python.org/pypi/ckanext-keycloak. 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 --tagsAcknowledgementsThis work was supported by Institute for Information & communications Technology Promotion (IITP) grant funded by the Korea government (MSIT) (No.2017-00253, Development of an Advanced Open Data Distribution Platform based on International Standards)
Package: ckanext-lapaz
ckanext-lapazVer documentacíon de proyecto La PazRequirementsTODO: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-lapaz:Activate your CKAN virtual environment, for example:. /usr/lib/ckan/default/bin/activateClone the source and install it on the virtualenvgit clonehttps://github.com/redciudadana/ckanext-lapaz.gitcd ckanext-lapaz
pip install -e .
pip install -r requirements.txtAddlapazto 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.lapaz.some_setting = some_default_valueDeveloper installationTo install ckanext-lapaz for development, activate your CKAN virtualenv and
do:git clone https://github.com/redciudadana/ckanext-lapaz.git
cd ckanext-lapaz
python setup.py develop
pip install -r dev-requirements.txtTestsTo run the tests, do:pytest --ckan-ini=test.iniReleasing a new version of ckanext-lapazIf ckanext-lapaz 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-let-me-in
ckanext-let-me-inAn extension that generates a one-time login link for a user by itsid,nameoremail.Uselmi_generate_otlAPI action orckan letmein uliCLI command to generate an OTL link.The link will expire in 24h, by default or after it was used.RequirementsCompatibility with core CKAN versions:CKAN versionCompatible?2.8 and earlierno2.9not yet2.10+yesInstallationUsepipto install an extension:pip install ckanext-let-me-inAddlet_me_into theckan.pluginssetting in your CKAN config file.Config settingsAvailable configuration options:# The number in seconds that specifies the OTL link TTL (optional, default: 86400).
ckanext.let_me_in.otl_link_ttl= 3600Developer installationTo install ckanext-let-me-in for development, activate your CKAN virtualenv and
do:git clone https://github.com/mutantsan/ckanext-let-me-in.git
cd ckanext-let-me-in
python setup.py developTestsTo run the tests, do:pytest --ckan-ini=test.iniLicenseAGPL
Package: ckanext-list
ckanext-listA CKAN extension that adds a list view for resources.OverviewThis extension adds a list view for resources on a CKAN instance. Records are listed as brief summaries, with a configurable set of fields shown for each.NB: This extension currently only works with the Natural History Museum's theme extensionckanext-nhm; thisshould be fixedin future releases (contributions are always welcome).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-listInstalling from sourceClone the repository into thesrcfolder:cd$INSTALL_FOLDER/src
gitclonehttps://github.com/NaturalHistoryMuseum/ckanext-list.gitActivate the virtual env:.$INSTALL_FOLDER/bin/activateInstall via pip:pipinstall$INSTALL_FOLDER/src/ckanext-listInstalling 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 'list' to the list of plugins in your$CONFIG_FILE:ckan.plugins=... listInstalllesscglobally:npminstall-g"less@~4.1"ConfigurationThere are currently no options that can be specified in your .ini config file.UsageTo use the view in a template:<divdata-module="list"data-module-resource="{{h.dump_json(resource_json)}}"data-module-resource-view="{{h.dump_json(resource_view_json)}}"></div>{%resource'ckanext-list/main'%}TestingThere 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-logstash
The LogStash CKAN extension allows to add aLogstashmiddleware to the CKAN and stack and optionally configure a LohStash log handler.This extension builds on top of the previous work of:@okfn onhttps://github.com/okfn/ckanext-sentry.@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-logstashAlternative, you can install a development version with:git clone https://github.com/datopian/ckanext-logstash.git
cd ckanext-logstash
python setup.py develop
pip install -r requirements.txtConfigurationTo activate the plugin, addlogstashto theckan.pluginskey in your ini file:ckan.plugins = logstash <other-plugins>You must provide a Logstash Endpoint:logstash.kind = tcp/udp/amqp
logstash.host = <hostname>
logstash.port = <port> (5959 by default)If you want Logstash to record your log messages, you can turn it on adding the following options:logstash.configure_logging=True
logstash.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:CKAN_LOGSTASH_KINDCKAN_LOGSTASH_HOSTCKAN_LOGSTASH_PORTCKAN_SENTRY_CONFIGURE_LOGGINGCKAN_SENTRY_LOG_LEVELThe configuration also supports env vars named
like theckanext-envvarsextension convention (egCKAN___LOGSTASH__LOG_LEVEL).
Package: ckanext-matomo
ckanext-matomoRequirementsFor example, you might want to mention here which versions of CKAN this
extension works with.InstallationTo install ckanext-matomo:Activate your CKAN virtual environment, for example:. /usr/lib/ckan/default/bin/activateInstall the ckanext-matomo Python package into your virtual environment:pip install ckanext-matomoAddmatomoto 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 Settings# The domain used for matomo analytics
ckanext.matomo.domain =http://example.com/# The site id used in matomo
ckanext.matomo.site_id = 1# The domain where matomo script is downloaded
# (optional, default ckanext.matomo.domain)
ckanext.matomo.script_domainDevelopment InstallationTo install ckanext-matomo for development, activate your CKAN virtualenv and
do:git clone https://github.com/vrk-kpa/ckanext-matomo.git
cd ckanext-matomo
python setup.py develop
pip install -r dev-requirements.txtRunning the TestsTo run the tests, do:nosetests --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 --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.matomo --cover-inclusive --cover-erase --cover-testsRegistering ckanext-matomo on PyPIckanext-matomo should be availabe on PyPI ashttps://pypi.python.org/pypi/ckanext-matomo. 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-matomockanext-matomo is availabe on PyPI ashttps://pypi.python.org/pypi/ckanext-matomo.
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-metadata
.. You should enable this project on travis-ci.org and coveralls.io to makethese badges work. The necessary Travis and Coverage config files have beengenerated for you... image:: https://travis-ci.org/ericsnth/ckanext-metadata.svg?branch=master:target: https://travis-ci.org/ericsnth/ckanext-metadata.. image:: https://coveralls.io/repos/ericsnth/ckanext-metadata/badge.svg:target: https://coveralls.io/r/ericsnth/ckanext-metadata.. image:: https://pypip.in/download/ckanext-metadata/badge.svg:target: https://pypi.python.org/pypi/ckanext-metadata/:alt: Downloads.. image:: https://pypip.in/version/ckanext-metadata/badge.svg:target: https://pypi.python.org/pypi/ckanext-metadata/:alt: Latest Version.. image:: https://pypip.in/py_versions/ckanext-metadata/badge.svg:target: https://pypi.python.org/pypi/ckanext-metadata/:alt: Supported Python versions.. image:: https://pypip.in/status/ckanext-metadata/badge.svg:target: https://pypi.python.org/pypi/ckanext-metadata/:alt: Development Status.. image:: https://pypip.in/license/ckanext-metadata/badge.svg:target: https://pypi.python.org/pypi/ckanext-metadata/:alt: License=============ckanext-metadata=============.. Put a description of your extension here:CKAN Extension untuk integrasi dengan Portal Satu Data Indonesia v3sesuai dengan template DDW 16 field------------Installation------------.. Add any additional install steps to the list below.To install ckanext-metadata:1. Activate your CKAN virtual environment, for example::. /usr/lib/ckan/default/bin/activate2. Install the ckanext-metadata Python package into your virtual environment::pip install ckanext-metadata3. Add ``metadata`` 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-----------------Running the Tests-----------------To run the tests, do::nosetests --nologcapture --with-pylons=test.iniTo run the tests and produce a coverage report, first make sure you havecoverage installed in your virtualenv (``pip install coverage``) then run::nosetests --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.metadata --cover-inclusive --cover-erase --cover-tests-----------------Author-----------------Ericson Thomas | https://www.linkedin.com/in/ericsnthProgramming Specialist Satu Data Indonesia, Kantor Staf Presiden RI
Package: ckanext-metrics-dashboard
# ckanext-metrics_dashboard[![GitHub Actions](https://github.com/GSA/ckanext-metrics_dashboard/actions/workflows/deploy.yml/badge.svg)](https://github.com/GSA/ckanext-metrics_dashboard/actions/workflows/publish.yml)
[![PyPI version](https://badge.fury.io/py/ckanext-metrics_dashboard.svg)](https://badge.fury.io/py/ckanext-metrics_dashboard)A CKAN extension to display metrics about harvest sources.## Features${CKAN_URL}/report/metrics_dashboardDisplays a summary report of number of datasets and harvest sources for each organization${CKAN_URL}/report/metrics_dashboard/{org}Displays a detailed report of each harvest source in an organization, where org is the ID of your organizationCSV Export: A comprehensive table of all harvest sourcesJSON Export: CSV raw data plus a second keytable_data_by_orgthat includes the same data grouped by organizationThis extension is compatible with these versions of CKAN.CKAN version | Compatibility
———— | ————-
<=2.8        | ???
2.9          | yes (with ckanext-datagovtheme==0.1.*)
2.10         | yes (with ckanext-datagovtheme>=0.2.1)## Usage### RequirementsThese extensions are required for metrics_dashboard:[ckanext-report](https://github.com/ckan/ckanext-report/)## Development### RequirementsGNU MakeDocker Compose### SetupBuild the docker containers. You’ll want to do this anytime the dependencies
change (requirements.txt, dev-requirements.txt).$ make buildStart the containers.$ make upCKAN will start at [localhost:5000](http://localhost:5000).Start the containers, but don’t start ckan. More debugging instructions [here](#Debugging)$ make debugOpen a shell to run commands in the container.$ docker-compose exec app bashIf you’re unfamiliar with docker-compose, see our
[cheatsheet](https://github.com/GSA/datagov-deploy/wiki/Docker-Best-Practices#cheatsheet)
and the [official docs](https://docs.docker.com/compose/reference/).Clean the containers and remove the data.$ make cleanFor additional make targets, see the help.$ make help### TestingThey follow the guidelines for [testing CKAN extensions](https://docs.ckan.org/en/2.8/extensions/testing-extensions.html#testing-extensions).To run the extension tests:$ make testLint your code.$ make lint### DebuggingWe have not determined a good way for most IDE native debugging, however you can use the built in Python pdb debugger. Simply runmake debug, which will run docker with an interactive shell. Add import pdb; pdb.set_trace() anywhere you want to start debugging, and if the code is triggered you should see a command prompt waiting in the shell. Use a pdb cheat sheet when starting to learn like this.When you edit/add/remove code, the server is smart enough to restart. If you are editing logic that is not part of the webserver (ckan command, etc) then you should be able to run the command after edits and get the same debugger prompt.Launch the containers withmake debugStart the CKAN process by running./start_ckan_development.shAddimport ibdb; ipdb.set_trace()at the point you wish to debug.Invoke that code to hit that breakpoint.
Package: ckanext-mongodatastore
ckanext-mongodatastoreThis plugin provides a datastore implementation forCKAN, based onMongoDBfor storing data records. One aspect of this implementation is, that it follows theRDA Recommendations for Data Citation. This guarantiees citability for every query that is submited to the datastore.As this extension provides an implementation of theIDatastoreBackend,therefore the DataStore API can be used as before.RequirementsThis CKAN extension is tested with CKAN 2.9.0 running on Python 3.8.2.To run this plugin beside an CKAN a mongo and a postgre database is required. The mongo database is needed for storing the data records and the postgre database is used as a querystore, described in the RDA Recommendations. For both instances a connection string has to be set in the CKAN config file.InstallationTo install ckanext-mongodatastore:InstallMongoDBIf not already existing, a QueryStore database has to be created::sudo -u postgres createuser -S -D -R -P querystore
sudo -u postgres createdb -O querystore querystore -E utf-8Activate your CKAN virtual environment, for example::. /usr/lib/ckan/default/bin/activateInstall the ckanext-mongodatastore Python package into your virtual environment:pip install ckanext-mongodatastoreSet the ckanext-mongodatastore specific config settings the CKAN configuration file
(by default the config file is located at/etc/ckan/default/production.ini).Addmongodatastoreto theckan.pluginssetting in your CKAN
config file (by default the config file is located at/etc/ckan/default/production.ini).Initialize the query store with the customclickcommandcreate_schemackan -c "/etc/ckan/default/production.ini" create_schemaRestart CKAN. For example if you've deployed CKAN with Apache on Ubuntu::sudo service apache2 reloadConfig SettingsFor running the MongoDb datastore two settings have to configured in your CKAN's configuration file::NameDescriptionDefaultckanext.mongodatastore.mongodb_urlURL pointing to the MongoDB instanceckanext.mongodatastore.querystore_urlURL pointing to the QueryStore databaseckanext.mongodatastore.sharding_enabledIf a sharded MongoDB instance is used, the sharding feature has to be enabledFalseckanext.mongodatastore.database_nameName of the MongoDB database, that contains all resource collectionsCKAN_DatastoreDevelopment InstallationTo install ckanext-mongodatastore for development, activate your CKAN virtualenv and
do::git clone https://github.com/fwoerister/ckanext-mongodatastore.git
cd ckanext-mongodatastore
python setup.py develop
pip install -r dev-requirements.txtRunning the TestsTo run the tests, do::nosetests --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 --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.mongodatastore --cover-inclusive --cover-erase --cover-tests
Package: ckanext-msal
ckanext-msalThis extension allows you to sign in users with Microsoft identities (Azure AD, Microsoft Accounts and Azure AD B2C accounts). It usesMicrosoft MSALlibrary.It works with Microsoft 365 accounts. But in future, the situation could change.RequirementsCompatibility with core CKAN versions:CKAN versionCompatible?2.7 and earlierno2.8no2.9no2.10.0+yesInstallationTo install ckanext-msal:Activate your CKAN virtual environment, for example:. /usr/lib/ckan/default/bin/activateClone the source and install it on the virtualenvgit clonehttps://github.com/mutantsan/ckanext-msal.gitcd ckanext-msal
pip install -e .
pip install -r requirements.txtAddmsalto 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 settings# The application client id. Mandatory option.
ckanext.msal.client_id = 000000-0000-0000-0000-00000000000

# The client secret. Mandatory option.
ckanext.msal.client_secret = 000000-0000-0000-0000-00000000000

# The tenant ID. If it's not provided, the common one for multi-tenant app will be used.
# In this case, the application is not guaranteed to work properly.
# (optional, default: 'common').
ckanext.msal.tenant_id = 000000-0000-0000-0000-00000000000

# The redirect path should be setted up in Azure AD web app config.
# It handles the response from Microsoft.
# (optional, default: "/get_msal_token").
ckanext.msal.redirect_path

# While the session lifespan could be manage only in Azure AD conditional policies panel,
# this option actually implies how often do we send a test request for the Microsoft Graph API
# to check if our Access token is still alive.
# (optional, default: 3600, in seconds).
ckanext.msal.session_lifetime = 3600

# The list of restricted email domains. User won't be able to login under
# an email with those domains (optional, default: None)
ckanext.msal.restrict.domain_list = gmail.com, onmicrosoft.com

# The list of allowed email domains. User won't be able to login under
# any other emails (optional, default: None)
ckanext.msal.restrict.allowed_domain_list = protonmail.com, orgname.onmicrosoft.com

# A message that will be shown to users with a restricted domain
# (optional, default: "Your email domain is restricted. Please, contact site admin.")
ckanext.msal.restrict.error_messageDeveloper installationTo install ckanext-msal for development, activate your CKAN virtualenv and
do:git clone https://github.com/mutantsan/ckanext-msal.git
cd ckanext-msal
python setup.py develop
pip install -r dev-requirements.txtTestsIf you changed something - be sure to run tests before merging your changes. To run tests, do:pytest --ckan-ini=test.iniLicenseAGPL