Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cfpb/ckanext-cfpb-extrafields

Last synced: 17 days ago
JSON representation

Host: GitHub
URL: https://github.com/cfpb/ckanext-cfpb-extrafields
Owner: cfpb
License: cc0-1.0
Created: 2015-03-23T15:58:47.000Z (almost 10 years ago)
Default Branch: master
Last Pushed: 2021-07-15T18:28:29.000Z (over 3 years ago)
Last Synced: 2024-04-08T00:16:53.062Z (9 months ago)
Language: CSS
Homepage:
Size: 1.51 MB
Stars: 4
Watchers: 6
Forks: 13
Open Issues: 5
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# CFPB CKAN Extra Fields

[![Build Status](https://travis-ci.org/cfpb/ckanext-cfpb-extrafields.png)](https://travis-ci.org/cfpb/ckanext-cfpb-extrafields)
[![Coverage Status](https://coveralls.io/repos/cfpb/ckanext-cfpb-extrafields/badge.svg?branch=master)](https://coveralls.io/r/cfpb/ckanext-cfpb-extrafields?branch=master)

**Description**: This is a [CKAN](http://docs.ckan.org) extension to add CFPB-specific extra metadata fields.
It is a sibling project to https://github.com/cfpb/ckan-installer and expected to live along-side that project.

## Dependencies

## General

- Python 2.7
- virtualenv and virtualenvwrapper
- Vagrant for local testing

### Runtime

This is a CKAN extension designed to plug in to a running instance of CKAN.
For local testing, we use Vagrant. See https://github.com/cfpb/ckan-installer for details.

### Testing

For running unit tests:

1. git clone this repository and cd into it
1. create a new virtualenv: `mkvirtualenv ckanext-cfpb-extrafields`
1. install requirements: `pip install -r requirements-test.txt`

## Installation

This software should live alongside a cloned copy of https://github.com/cfpb/ckan-installer.
That project's provisioning will create a mapped directory in the Vagrant install.

For real servers, this software should be installed via `pip install`

## How to test the software

After following the testing installation instructions above, you can test with:

`nosetests -s --with-coverage --cover-package=ckanext.cfpb_extrafields.validators`

## Getting help

If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.

## Getting involved

See [CONTRIBUTING](CONTRIBUTING.md).

----

## Open source licensing info
1. [TERMS](TERMS.md)
2. [LICENSE](LICENSE)
3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)

----

## Credits and references

1. http://docs.ckan.org/en/latest/extensions/index.html