Saravanan666/pypi-org huggingface dataset:
Package: ckanext-datagovtheme
# ckanext-datagovtheme[![Github Actions](https://github.com/GSA/ckanext-datagovtheme/actions/workflows/ckan.yml/badge.svg)](https://github.com/GSA/ckanext-datagovtheme/actions)
[![PyPI version](https://badge.fury.io/py/ckanext-datagovtheme.svg)](https://badge.fury.io/py/ckanext-datagovtheme)Data.gov theme, branding, and UI customizations for
[catalog.data.gov](https://catalog.data.gov/) as a [CKAN](https://ckan.org/)
extension.## Features_TODO document these better._Provides a new spatial query view (overrides [ckanext-spatial](https://github.com/ckan/ckanext-spatial) some front end)## Usage### Requirements_TODO: document how ckanext-datagovtheme interacts with third-party extensions, maybe
in the context of Features above._These extensions are required.[ckanext-spatial](https://github.com/gsa/ckanext-spatial)[ckanext-harvest](https://github.com/ckan/ckanext-harvest)Additionally, ckanext-datagovtheme has “weak” dependencies on these extensions.
The dependency might be on templates, template helpers, or other functionality.[ckanext-archiver](https://github.com/ckan/ckanext-archiver)[ckanext-dcat](https://github.com/ckan/ckanext-dcat)[ckanext-qa](https://github.com/ckan/ckanext-qa)This extension is compatible with these versions of CKAN.CKAN version | Compatibility
———— | ————-
<=2.8        | no
2.9          | 0.1.27 (last supported)
2.10         | >=0.2.0### Configuration_TODO: what configuraiton options exist?_## 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).Clean up the environment.$ make downOpen a shell to run commands in the container.$ docker-compose exec ckan 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/).For 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#### Common issuesWe have seen issues withdatagovtheme not installed.
If this is the case, runpython setup.py developin the container.### Matrix buildsThe development environment drops as many dependencies as possible. It is
not meant to have feature parity with
[GSA/catalog.data.gov](https://github.com/GSA/catalog.data.gov/) or
[GSA/inventory-app](https://github.com/GSA/inventory-app/). Tests should mock
external dependencies where possible.In order to support multiple versions of CKAN, or even upgrade to new versions
of CKAN, we support development and testing through theCKAN_VERSIONenvironment variable.$ make CKAN_VERSION=2.10 testVariable | Description | Default
——– | ———– | ——-
CKAN_VERSION | Version of CKAN to use. | 2.10
COMPOSE_FILE | docker-compose service description file. | docker-compose.yml
Package: ckanext-datapackage-creator
CKNEXT Data Package CreatorCKAN extension to use the fritioncless libraryTable of ContentsPublish or Update Package to PypiInstallationConfigurationPublish or Update Package to PypiCheck the last version published onPypi.UpdateCHANGELOG.mdfile with a short review of what had been done.Updatesetup.pyfile with the new version number.Commit all the above changes with the new version number (one above that publish on Pypi). Example:git commit -am 'v0.1.1'.Push the created commit to the online repository: Example:git push origin master.Create a new tag with the new version number (same as used to commit last changes). Example:git tag v0.1.1 HEAD.Push the new created tag to the online repository: Example:git push origin v0.1.1.Publish on Pypi withmake update-package.Instalationpip install ckanext-datapackage-creatorConfigurationOnce installed, add thedatapackage_creatorplugin to theckan.pluginsconfiguration option in your INI file.ckan.plugins = ... datapackage_creatorDatapackage Creator ConfigurationOpening the file with vi editorsudo vi /etc/ckan/default/datapackage_creator.jsonThe plugin allows you to configure which fields of the resource and package are mandatory and/or 'readonly', for this you just need to add a configuration in your INI file.datapackage_creator = /path/to/datapackage_creator.jsonWe suggest that the file path would be/etc/ckan/default/datapackage_creator.jsonor in the same folder asckan.inifile.Configuration example file:{
    "package": {
        "required": [],
        "readonly": []
    },
    "resource": {
        "required": [],
        "readonly": []
    },
    "token": ""
}Mandatory possible package fields:descriptionsourceversionlicensefrequencytagsauthorauthor_emailPossible read-only package fields:NothingMandatory possible resource fields:titledescriptionformattypeencodingfield.name (Column field)field.title (Column field)field.description (Column field)field.format (Column field)Possible read-only package fields:formattypeencodingTokenIt is necessary to configure an administrator token so that the plugin can query private dataEntity DiagramTo generate the entity diagram it is necessary to install the library: graphviz.On ubuntu: sudo apt-get install graphviz
Package: ckanext-datapreview
CKAN Extension Data Preview - preview package resources.Data Preview is a CKAN extension -http://wiki.ckan.net/Extensions.Enable by adding to your ckan.plugins line in the CKAN config:ckan.plugins = datapreviewOptional configuration options:## a data proxy URL
## Default proxy URL is http://jsonpdataproxy.appspot.com
ckanext.dataapi.data_proxy_url = http://...This extension provides preview functionality (using javascript) in relation to
Packge Resources (i.e. urls pointing to datasets).
Package: ckanext-datasetpreview
CKAN dataset previewStill in a develpment statusAdds automatically charts for all datasets in the dataset list.
Usesmessytablesto discover field types.How to set up?General extension config valuesAvailable config options# Define if the extension should draw chart for# - 'ALL'    All datasets with a CSV resource# - 'EXTRA' Just datasets with the 'dataset_preview' extra dictionary defined# - 'NO'     No datasets with show any previewckanext.datasetpreview.draw='ALL'# default draw allckanext.datasetpreview.chart_height=300# pixelsEach dataset could add and extra value with nthe keydataset_preview:extras["dataset_preview"]={// field to use in the chart. Could be:// - A list of field names (valids in the CSV resource)// Default will be [0, 1] ( the first two columns in the CSV). You could use numbers instead of field names"fields":["Field1","Field2"],"chart_type":"Bar",// Allows 'Pie', 'Bar', 'Column'// URL could be:// - A external url// - No use this value: will be "csv_resource" with pick the first CSV resource in the dataset// - Name of the resource in the datasets (must be a CSV one)"url":"csv_resource","height":450,// pixels"chart_color":"#AA5521"}If you don't setup each dataset it will show the first CSV resource in the dataset (using the first two columns)
Package: ckanext-Dataset-Reference
ckanext-Dataset-ReferenceThis CKAN extension ables CKAN users to link references to their dataset. A reference can be a publication or another dataset. The extension embeds the added references to the target dataset view as a table of citations.There are three ways to add a reference:With the DOI number or link (look athttp://dx.doi.org/)With pasting the BibTex (http://www.bibtex.org/) citation metadata (Not implemented yet)Manually adding the target reference metadata. (Not implemented yet)RequirementsCompatibility with core CKAN versions:CKAN versionCompatible?2.9YesearlierNoInstallationTo install ckanext-Dataset-Reference:Activate your CKAN virtual environment, for example:> source /usr/lib/ckan/default/bin/activate
> pip install ckanext-Dataset-ReferenceOR, Clone the source and install it on the virtualenv (Suggested location: /usr/lib/ckan/default/src)
:git clone https://github.com/TIBHannover/ckanext-Dataset-Reference.git
    cd ckanext-Dataset-Reference
    pip install -e .
    pip install -r requirements.txtAdddataset_referenceto theckan.pluginssetting in your CKAN
config file (by default the config file is located at/etc/ckan/default/ckan.ini).Upgrade the CKAN database to add the plugin table:ckan -c /etc/ckan/default/ckan.ini db upgrade -p dataset_referenceRestart CKAN and supervisor. For example if you've deployed CKAN with nginx on Ubuntu:sudo service nginx reload
 sudo service supervisor reloadTestsTo run the tests, do:pytest --ckan-ini=test.ini  --disable-pytest-warnings  ckanext/dataset_reference/tests/
Package: ckanext-dataviewanalytics
DataViewAnalytics CKAN Extension=========================This extension displays analytics on resources by analysing the country and occupation of visitors to every resource/data.This extension is presently on development and is not officially released for use yet. You should only install if you are a developer and want to contribute to the project.To install and set up CKAN, visit [CKAN Documentation](http://docs.ckan.org/en/latest/maintaining/installing/index.html)Then follow the steps below to install the DataViewAnalytics extension:Step 1:* Activate your virtual environment; use the path to your virtual environment. On Mac OSX, you may have to use `/usr/local/lib/ckan/default/bin/activate`. You can copy the code as is below, including the preceeding dot.```bash. /usr/lib/ckan/default/bin/activate```Step 2:* Install the extension>You can download the source code and install the extension manually. To do so, execute the following command:> ```bash> pip install -e git+https://github.com/shemogumbe/ckanext-dataviewanalytics.git#egg=ckanext-dataviewanalytics> ```> **Alternatively**: You can clone this repo (preferably into the /src directory where you installed CKAN), cd into ckanext-dataviewanalytics and run>```bash> python setup.py develop> ```> Install necessary requirements>```bash> pip install -r requirements.txt> ```Step 3:* Modify your configuration file (generally in `/etc/ckan/default/production.ini`) and add `dataviewanalytics` to the `ckan.plugins` property.```bashckan.plugins = dataviewanalytics <OTHER_PLUGINS>```Step 4:* Restart your server:```bashpaster serve /etc/ckan/default/production.ini```OR```bashpaster serve --reload /etc/ckan/default/production.ini```With `--reload`, your server is restarted automatically whenever you make changes to your source code.Support-------If you've found a bug/issue in the extension, please open a new issue [here](https://github.com/shemogumbe/ckanext-dataviewanalytics/issues/new) (trysearching first to see if there's already an [issue](https://github.com/shemogumbe/ckanext-dataviewanalytics/issues) for your bug).Contributing to DataViewAnalytics CKAN Extension---------------------------------------------If you have interest in contributing to the development of DataViewAnalytics extension, you are welcome. A good starting pointwill be reading the CKAN general [Contributing guide](http://docs.ckan.org/en/ckan-2.7.0/contributing/index.html). Then you can check outexisting [issues](https://github.com/shemogumbe/ckanext-dataviewanalytics/issues) that are open for contribution; new features and issues are welcome.To work on any issue, comment on the issue to indicate your interest and the issue will be assigned to you. It is always a good idea to seekfor clarification (where necessary) on any issue before you work on it.**It is important that changes that require some form of configuration be documented in the README.**Copying and License--------------------This project is copyright (c) 2017 Andela.It is open and licensed under the GNU Affero General Public License (AGPL) v2.0Find the full text here, http://www.gnu.org/licenses/gpl-2.0.html.
Package: ckanext-dc-log-view
A CKAN log viewer for DC files.Installationpip install ckanext-dc_log_viewAdd this extension to the plugins and defaul_views in ckan.ini:ckan.plugins = [...] dc_log_view
ckan.views.default_views = [...] dc_log_viewTestingIf CKAN/DCOR is installed and setup for testing, this extension can
be tested with pytest:pytest ckanextTesting can also be done via vagrant in a virtualmachine using thedcor-test <https://app.vagrantup.com/paulmueller/boxes/dcor-test/>image.
Make sure thatvagrantandvirtualboxare installed and run the
following commands in the root of this repository:# Setup virtual machine using `Vagrantfile`
vagrant up
# Run the tests
vagrant ssh -- sudo bash /testing/vagrant-run-tests.sh
Package: ckanext-dcor-theme
The CKAN theme of DCOR. What this plugin does:remove the language selection from footer.htmlremove links from footer.htmlset the title of the page to “DCOR”insert a custom about textremove social media buttonschange icons / logouse i18n to change the terms “Organization” -> “Circle”,
“Group” -> “Collection”, etc.:ckan dcor-theme-i18n-brandingcreate a custom theme based on the default main.css file
(hide action buttons (Fullscreen, Embed) in resource view via css,
change colors) using:ckan dcor-theme-main-css-brandingInstallationpip install ckanext-dcor_themeEdit ckan.ini:ckan.plugins = [...] dcor_themeand run the dcor-i18n-hack command:ckan -c /etc/ckan/default/ckan.ini dcor-i18n-hackThen, edit ckan.ini again:ckan.locale_default = en_USTestingIf CKAN/DCOR is installed and setup for testing, this extension can
be tested with pytest:pytest ckanextTesting can also be done via vagrant in a virtualmachine using thedcor-test <https://app.vagrantup.com/paulmueller/boxes/dcor-test/>image.
Make sure thatvagrantandvirtualboxare installed and run the
following commands in the root of this repository:# Setup virtual machine using `Vagrantfile`
vagrant up
# Run the tests
vagrant ssh -- sudo bash /testing/vagrant-run-tests.sh
Package: ckanext-dc-serve
This CKAN plugin provides an API for accessing DC data. The python
package dclab implements a client library (dclab.rtdc_dataset.fmt_dcor)
to access this API. Shape-Out 2 offers a GUI viaFile - Load DCOR data.This plugin implements:The DCOR API for accessing DC datasets online (dcserv).A background job that generates a condensed dataset after a resource
has been created.A background job that uploads the condensed dataset to the S3 object
store.A route that makes the condensed dataset available via
“/dataset/{id}/resource/{resource_id}/condensed.rtdc”
(S3 object store data is made available via a redirect)A route overriding the default route for downloading a resource via
“/dataset/{id}/resource/{resource_id}/download/resource_name”
(S3 object store data is made available via a redirect)Extends the template to show a condensed resource download buttonCLI:add CKAN commandrun-jobs-dc-servethat runs all background
jobs for all resources (if not already done)Installationpip install ckanext-dc_serveAdd this extension to the plugins and defaul_views in ckan.ini:ckan.plugins = [...] dc_serveTestingTesting is done via vagrant in a virtualmachine using thedcor-test <https://app.vagrantup.com/paulmueller/boxes/dcor-test/>image.
Make sure thatvagrantandvirtualboxare installed and run the
following commands in the root of this repository:# Setup virtual machine using `Vagrantfile`
vagrant up
# Run the tests
vagrant ssh -- sudo bash /testing/vagrant-run-tests.sh
Package: ckanext-dc-view
A CKAN resource view for DC data. The preview includes metadata from
the HDF5 attributes and a summary plot (scatter plot of brightness vs. area
and image, contour, mask, and fluorescence data for one event). This plugin
registers a background job for generating the overview plot after a DC
resource has been created.This extensione implements:A default view for RT-DC (mimetype) resourcesA background job that generates the preview imageA background job that uploads preview images to the S3 object storeA route that makes the preview image available via
“/dataset/{id}/resource/{resource_id}/preview.jpg”CLI:add CKAN commandrun-jobs-dc-viewthat runs all background
jobs for all resources (if not already done)Installationpip install ckanext-dc_viewAdd this extension to the plugins and defaul_views in ckan.ini:ckan.plugins = [...] dc_view
ckan.views.default_views = [...] dc_viewTestingTesting can be done via vagrant in a virtual machine using thedcor-test <https://app.vagrantup.com/paulmueller/boxes/dcor-test/>image.
Make sure thatvagrantandvirtualboxare installed and run the
following commands in the root of this repository:# Setup virtual machine using `Vagrantfile`
vagrant up
# Run the tests
vagrant ssh -- sudo bash /testing/vagrant-run-tests.sh
Package: ckanext-ddkids
ckanext-ddkidsRequirementsFor example, you might want to mention here which versions of CKAN this
extension works with.InstallationTo install ckanext-ddkids:Activate your CKAN virtual environment, for example:. /usr/lib/ckan/default/bin/activateInstall the ckanext-ddkids Python package into your virtual environment:pip install ckanext-ddkidsAddddkidsto 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 SettingsDocument any optional config settings here. For example:# The minimum number of hours to wait before re-checking a resource
# (optional, default: 24).
ckan.ddkids.drupal.url = http://brandeisjqjlgt4nyr.devcloud.acquia-sites.comDevelopment InstallationTo install ckanext-ddkids for development, activate your CKAN virtualenv and
do:git clone https://github.com/Velir/ckanext-ddkids.git
cd ckanext-ddkids
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.ddkids --cover-inclusive --cover-erase --cover-testsRegistering ckanext-ddkids on PyPIckanext-ddkids should be availabe on PyPI ashttps://pypi.python.org/pypi/ckanext-ddkids. 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-ddkidsckanext-ddkids is availabe on PyPI ashttps://pypi.python.org/pypi/ckanext-ddkids.
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-ddug
ckanext-ddugRequirementsFor example, you might want to mention here which versions of CKAN this
extension works with.InstallationTo install ckanext-ddug:Activate your CKAN virtual environment, for example:. /usr/lib/ckan/default/bin/activateInstall the ckanext-ddug Python package into your virtual environment:pip install ckanext-ddugAddddugto 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 SettingsDocument any optional config settings here. For example:# The minimum number of hours to wait before re-checking a resource
# (optional, default: 24).
ckanext.ddug.some_setting = some_default_valueDevelopment InstallationTo install ckanext-ddug for development, activate your CKAN virtualenv and
do:git clone https://github.com/datadotug/ckanext-ddug.git
cd ckanext-ddug
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.ddug --cover-inclusive --cover-erase --cover-testsRegistering ckanext-ddug on PyPIckanext-ddug should be availabe on PyPI ashttps://pypi.python.org/pypi/ckanext-ddug. 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-ddugckanext-ddug is availabe on PyPI ashttps://pypi.python.org/pypi/ckanext-ddug.
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