Package: ckanext-datagovcatalog
ckanext-datagovcatalogData.govData.govis an open data website created by theU.S. General Services Administrationthat is based on two robust open source projects:CKANandWordPress. The data catalog atcatalog.data.govis powered by CKAN, while the content seen atData.govis powered by WordPress.For all code, bugs, and feature requests related to Data.gov, see the project wide Data.govissue tracker.Currently this repository is only used for source version control on the code for the CKAN extension for datagovcatalog features, but you can see all of the Data.gov relevant repos listed in theGSA Data.gov README file.RequirementsFor example, you might want to mention here which versions of CKAN this
extension works with.PackageNotesckanext-harvestThis currently has two different version for py2 and py3 untilthis PRis merged upstreamckanext-envvarsThis is necessary based on how the testing environment is set up.InstallationCKAN versionCompatibility<=2.8no2.90.0.5 (last supported)2.10>=0.1.0To install ckanext-datagovcatalog:Activate your CKAN virtual environment, for example::. /usr/lib/ckan/default/bin/activateInstall the ckanext-datagovcatalog Python package into your virtual environment::pip install ckanext-datagovcatalogAdddatagovcatalogto 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 Settingscomment: <> (Document any optional config settings here. For example::# Add tracking info on each package for the dataset lists
# (optional, default: true).
ckanext.datagovcatalog.add_packages_tracking_info = true)Development InstallationTo install ckanext-datagovcatalog for development, activate your CKAN virtualenv and
do::git clone https://github.com/GSA/ckanext-datagovcatalog.git
cd ckanext-datagovcatalog
python setup.py develop
pip install -r requirements.txt
pip install -r dev-requirements.txt**Note: use the py2-equivalents of the requirement files if running on python 2.Running the TestsTestsUsing the Docker Dev EnvironmentBuild EnvironmentTo start environment, run:make buildmake upCKAN will start at localhost:5000To shut down environment, run:make cleanTo docker exec into the CKAN image, run:docker-compose exec app /bin/bashTestingThey follow the guidelines fortesting CKAN
extensions.To run the extension tests,$ make testLint the code.$ make lintMatrix buildsThe existing development environment assumes a minimal catalog.data.gov test setup. This makes
it difficult to develop and test against dependencies with other extensions.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 testRegistering ckanext-datagovcatalog on PyPIckanext-datagovcatalog should be availabe on PyPI ashttps://pypi.python.org/pypi/ckanext-datagovcatalog. 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-datagovcatalogckanext-datagovcatalog is availabe on PyPI ashttps://pypi.python.org/pypi/ckanext-datagovcatalog.
To publish a new version to PyPI follow these steps:Update the version number in thesetup.pyfile.
SeePEP 440 <http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers>_
for 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