# ckanext-usmetadata
[](https://badge.fury.io/py/ckanext-usmetadata)
This CKAN Extension expands CKAN to offer a number of custom fields related to the [DCAT-US Schema](https://resources.data.gov/schemas/dcat-us/v1.1/)
### Installation
Add `ckanext-usmetadata` to your requirements.txt, and then pip install
Then in your CKAN .ini file, add `usmetadata`
to your ckan.plugins line:
ckan.plugins = (other plugins here...) usmetadata
### Requirements
This extension is compatible with these versions of CKAN.
CKAN version | Compatibility
------------ | -------------
<=2.9 | no
2.10 | yes
### Development
You may also install by cloning the git repo, then running ''python setup.py develop'' from the root of your source
directory, which will install an egg link so that you can modify the code and see results [localhost:5000](http://localhost:5000/).
Clean up any containers and volumes.
$ 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.9/extensions/testing-extensions.html#testing-extensions).
To run the extension tests, start the containers with `make up`, then:
$ make test
Lint the code.
$ make lint
### Matrix builds
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.9 test
## Credit / Copying
Credit to the original owner of the repo. Everything here is built on top of the original foundation.
Raw data
{
"_id": null,
"home_page": "https://github.com/GSA/ckanext-usmetadata",
"name": "ckanext-usmetadata",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Data.gov",
"author_email": "datagovhelp@gsa.gov",
"download_url": "https://files.pythonhosted.org/packages/27/77/c67e2f8273938088dad2e58a28f509a2414b9bb01a442579c402e238c19c/ckanext-usmetadata-0.3.2.tar.gz",
"platform": null,
"description": "# ckanext-usmetadata\n\n\n[](https://badge.fury.io/py/ckanext-usmetadata)\n\nThis CKAN Extension expands CKAN to offer a number of custom fields related to the [DCAT-US Schema](https://resources.data.gov/schemas/dcat-us/v1.1/)\n\n### Installation\n\nAdd `ckanext-usmetadata` to your requirements.txt, and then pip install\n \nThen in your CKAN .ini file, add `usmetadata`\nto your ckan.plugins line:\n\n\tckan.plugins = (other plugins here...) usmetadata\n\n### Requirements\n\nThis extension is compatible with these versions of CKAN.\n\nCKAN version | Compatibility\n------------ | -------------\n<=2.9 | no\n2.10 | yes\n\n### Development\n\nYou may also install by cloning the git repo, then running ''python setup.py develop'' from the root of your source\ndirectory, which will install an egg link so that you can modify the code and see results [localhost:5000](http://localhost:5000/).\n\nClean up any containers and volumes.\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### Testing\n\nThey follow the guidelines for [testing CKAN\nextensions](https://docs.ckan.org/en/2.9/extensions/testing-extensions.html#testing-extensions).\n\nTo run the extension tests, start the containers with `make up`, then:\n\n $ make test\n\nLint the code.\n\n $ make lint\n\n### Matrix builds\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.9 test\n \n## Credit / Copying\n\nCredit to the original owner of the repo. Everything here is built on top of the original foundation.\n\n\n",
"bugtrack_url": null,
"license": "Public Domain",
"summary": "US Metadata Plugin for CKAN",
"version": "0.3.2",
"project_urls": {
"Homepage": "https://github.com/GSA/ckanext-usmetadata"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fc5f3347b5ffb4cceb67e229bcbe19267ed985e084cb0ac061a11f350bd25726",
"md5": "869dfe842b3897017d167d983f9feed9",
"sha256": "5c9dded9fb172eb5f48a93d1728b3f841efa2f039e64550ebc53479daf725af2"
},
"downloads": -1,
"filename": "ckanext_usmetadata-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "869dfe842b3897017d167d983f9feed9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 135835,
"upload_time": "2023-07-24T17:08:06",
"upload_time_iso_8601": "2023-07-24T17:08:06.511562Z",
"url": "https://files.pythonhosted.org/packages/fc/5f/3347b5ffb4cceb67e229bcbe19267ed985e084cb0ac061a11f350bd25726/ckanext_usmetadata-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2777c67e2f8273938088dad2e58a28f509a2414b9bb01a442579c402e238c19c",
"md5": "cc121968e56de19d4ab9f086a91c3652",
"sha256": "0f7947e895f1f3805170c3f5e250613658c4d761dcc2efe412bbeb728e4bb414"
},
"downloads": -1,
"filename": "ckanext-usmetadata-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "cc121968e56de19d4ab9f086a91c3652",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 125151,
"upload_time": "2023-07-24T17:08:08",
"upload_time_iso_8601": "2023-07-24T17:08:08.488576Z",
"url": "https://files.pythonhosted.org/packages/27/77/c67e2f8273938088dad2e58a28f509a2414b9bb01a442579c402e238c19c/ckanext-usmetadata-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-24 17:08:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GSA",
"github_project": "ckanext-usmetadata",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "ckanext-usmetadata"
}
JSON
