# ckanext-datagovtheme
[](https://github.com/GSA/ckanext-datagovtheme/actions)
[](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
### Requirements
- GNU Make
- Docker Compose
### Setup
Build the docker containers. You'll want to do this anytime the dependencies
change (requirements.txt, dev-requirements.txt).
$ make build
Start the containers.
$ make up
CKAN will start at [localhost:5000](http://localhost:5000).
Clean up the environment.
$ make down
Open a shell to run commands in the container.
$ docker-compose exec ckan bash
If 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
### Testing
They 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 test
Lint your code.
$ make lint
#### Common issues
We have seen issues with `datagovtheme not installed`.
If this is the case, run `python setup.py develop` in the container.
### Matrix builds
The 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 the `CKAN_VERSION`
environment variable.
$ make CKAN_VERSION=2.10 test
Variable | Description | Default
-------- | ----------- | -------
CKAN_VERSION | Version of CKAN to use. | 2.10
COMPOSE_FILE | docker-compose service description file. | docker-compose.yml
Raw data
{
"_id": null,
"home_page": "https://github.com/GSA/ckanext-datagovtheme/",
"name": "ckanext-datagovtheme",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Data.gov",
"author_email": "datagovhelp@gsa.gov",
"download_url": "https://files.pythonhosted.org/packages/8b/98/e39b17050a37e4cf5cf0c016a89fa00cdec27f61a02b472f4b81a66a4f0c/ckanext-datagovtheme-0.2.18.tar.gz",
"platform": null,
"description": "# ckanext-datagovtheme\n\n[](https://github.com/GSA/ckanext-datagovtheme/actions)\n[](https://badge.fury.io/py/ckanext-datagovtheme)\n\nData.gov theme, branding, and UI customizations for\n[catalog.data.gov](https://catalog.data.gov/) as a [CKAN](https://ckan.org/)\nextension.\n\n\n## Features\n\n_TODO document these better._\n\n- Provides a new spatial query view (overrides [ckanext-spatial](https://github.com/ckan/ckanext-spatial) some front end)\n\n\n## Usage\n\n\n### Requirements\n\n_TODO: document how ckanext-datagovtheme interacts with third-party extensions, maybe\nin the context of Features above._\n\nThese extensions are required.\n\n- [ckanext-spatial](https://github.com/gsa/ckanext-spatial)\n- [ckanext-harvest](https://github.com/ckan/ckanext-harvest)\n\nAdditionally, ckanext-datagovtheme has \"weak\" dependencies on these extensions.\nThe dependency might be on templates, template helpers, or other functionality.\n\n- [ckanext-archiver](https://github.com/ckan/ckanext-archiver)\n- [ckanext-dcat](https://github.com/ckan/ckanext-dcat)\n- [ckanext-qa](https://github.com/ckan/ckanext-qa)\n\nThis extension is compatible with these versions of CKAN.\n\nCKAN version | Compatibility\n------------ | -------------\n<=2.8 | no\n2.9 | 0.1.27 (last supported)\n2.10 | >=0.2.0\n\n\n### Configuration\n\n_TODO: what configuraiton options exist?_\n\n\n## Development\n\n### Requirements\n\n- GNU Make\n- Docker Compose\n\n\n### Setup\n\nBuild the docker containers. You'll want to do this anytime the dependencies\nchange (requirements.txt, dev-requirements.txt).\n\n $ make build\n\nStart the containers.\n\n $ make up\n\nCKAN will start at [localhost:5000](http://localhost:5000).\n\nClean up the environment.\n\n $ make down\n\nOpen a shell to run commands in the container.\n\n $ docker-compose exec ckan bash\n\nIf you're unfamiliar with docker-compose, see our\n[cheatsheet](https://github.com/GSA/datagov-deploy/wiki/Docker-Best-Practices#cheatsheet)\nand the [official docs](https://docs.docker.com/compose/reference/).\n\nFor additional make targets, see the help.\n\n $ make help\n\n\n### Testing\n\nThey follow the guidelines for [testing CKAN extensions](https://docs.ckan.org/en/2.8/extensions/testing-extensions.html#testing-extensions).\n\nTo run the extension tests:\n\n $ make test\n\nLint your code.\n\n $ make lint\n\n#### Common issues\n\nWe have seen issues with `datagovtheme not installed`.\nIf this is the case, run `python setup.py develop` in the container.\n\n### Matrix builds\n\nThe development environment drops as many dependencies as possible. It is\nnot meant to have feature parity with\n[GSA/catalog.data.gov](https://github.com/GSA/catalog.data.gov/) or\n[GSA/inventory-app](https://github.com/GSA/inventory-app/). Tests should mock\nexternal dependencies where possible.\n\nIn order to support multiple versions of CKAN, or even upgrade to new versions\nof CKAN, we support development and testing through the `CKAN_VERSION`\nenvironment variable.\n\n $ make CKAN_VERSION=2.10 test\n\n\nVariable | Description | Default\n-------- | ----------- | -------\nCKAN_VERSION | Version of CKAN to use. | 2.10\nCOMPOSE_FILE | docker-compose service description file. | docker-compose.yml\n\n\n",
"bugtrack_url": null,
"license": "Public Domain",
"summary": "CKAN Extension to manage data.gov theme",
"version": "0.2.18",
"project_urls": {
"Homepage": "https://github.com/GSA/ckanext-datagovtheme/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "90f788806120ce82a1b0279a5e18e3d4d66460cd5b5646dfb40b2357135e7544",
"md5": "8017e0b401684a6511a5c3e5aa3695b1",
"sha256": "09c68189f6f90dc0edd19455cf274f5a0af4f9371803a99ba92dd505f6ce08d7"
},
"downloads": -1,
"filename": "ckanext_datagovtheme-0.2.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8017e0b401684a6511a5c3e5aa3695b1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11637544,
"upload_time": "2024-04-05T13:37:06",
"upload_time_iso_8601": "2024-04-05T13:37:06.538823Z",
"url": "https://files.pythonhosted.org/packages/90/f7/88806120ce82a1b0279a5e18e3d4d66460cd5b5646dfb40b2357135e7544/ckanext_datagovtheme-0.2.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8b98e39b17050a37e4cf5cf0c016a89fa00cdec27f61a02b472f4b81a66a4f0c",
"md5": "a68f89e7310fa2142ac4df4c85e15252",
"sha256": "7fe6caf7929c2bef04fb3d1db69d09c5677cb6415079a4302aeeb37f5dfe18d8"
},
"downloads": -1,
"filename": "ckanext-datagovtheme-0.2.18.tar.gz",
"has_sig": false,
"md5_digest": "a68f89e7310fa2142ac4df4c85e15252",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11509072,
"upload_time": "2024-04-05T13:37:09",
"upload_time_iso_8601": "2024-04-05T13:37:09.186663Z",
"url": "https://files.pythonhosted.org/packages/8b/98/e39b17050a37e4cf5cf0c016a89fa00cdec27f61a02b472f4b81a66a4f0c/ckanext-datagovtheme-0.2.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-05 13:37:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GSA",
"github_project": "ckanext-datagovtheme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "ckanext-datagovtheme"
}
JSON
