A library for making web services that make functions available as synchronous or asynchronous jobs
Project description
[![Build Status](https://travis-ci.org/ckan/ckan-service-provider.png?branch=master)](https://travis-ci.org/ckan/ckan-service-provider) [![Coverage Status](https://coveralls.io/repos/ckan/ckan-service-provider/badge.png?branch=master)](https://coveralls.io/r/ckan/ckan-service-provider?branch=master) [![Latest Version](https://pypip.in/version/ckanserviceprovider/badge.svg)](https://pypi.python.org/pypi/ckanserviceprovider/) [![Downloads](https://pypip.in/download/ckanserviceprovider/badge.svg)](https://pypi.python.org/pypi/ckanserviceprovider/) [![Supported Python versions](https://pypip.in/py_versions/ckanserviceprovider/badge.svg)](https://pypi.python.org/pypi/ckanserviceprovider/) [![Development Status](https://pypip.in/status/ckanserviceprovider/badge.svg)](https://pypi.python.org/pypi/ckanserviceprovider/) [![License](https://pypip.in/license/ckanserviceprovider/badge.svg)](https://pypi.python.org/pypi/ckanserviceprovider/)
[DataPusher]: https://github.com/okfn/datapusher [PyPI]: https://pypi.python.org/pypi/ckanserviceprovider
# CKAN Service Provider
A library for making web services that make functions available as synchronous or asynchronous jobs. Used by [DataPusher][].
## Getting Started
To install ckanserviceprovider for development:
`bash git clone https://github.com/ckan/ckan-service-provider.git cd ckan-service-provider pip install -r requirements-dev.txt `
To get started making a web service with ckanserviceprovider have a look at [/example](example). You can run the example server with python example/main.py example/settings_local.py.
For a real-world example have a look at [DataPusher][].
## Running the Tests
To run the ckanserviceprovider tests:
`bash nosetests `
## Building the Documentation
To build the ckanserviceprovider docs:
`bash python setup.py build_sphinx `
## Releasing a New Version
To release a new version of ckanserviceprovider:
Increment the version number in [setup.py](setup.py)
Build a source distribution of the new version and publish it to [PyPI][]:
`bash python setup.py sdist python setup.py sdist upload `
You may want to test installing and running the new version from PyPI in a clean virtualenv before continuing to the next step.
Commit your setup.py changes to git, tag the release, and push the changes and the tag to GitHub:
`bash git commit setup.py -m "Bump version number" git tag 0.0.1 git push git push origin 0.0.1 `
(Replace both instances of 0.0.1 with the number of the version you’re releasing.)
## Authors
The original authors of ckanserviceprovider were David Raznick <david.raznick@okfn.org> and Dominik Moritz <dominik.moritz@okfn.org>. For the current list of contributors see [github.com/ckan/ckan-service-provider/contributors](https://github.com/ckan/ckan-service-provider/contributors)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for ckanserviceprovider-0.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1509136300e4b63b62cbaf3580a2d424c6cb455139b5590f8a08cf8de86372b8 |
|
MD5 | 101a1a7c00dcb4e0f7de0a47a3b26649 |
|
BLAKE2b-256 | 9a2374eb5c11a79bac48beb0fcb6fed6c396c8778884316b3c1a947cbac8e44f |