[](https://github.com/ckan/ckan-service-provider/actions/workflows/test.yml)
[](https://pypi.python.org/pypi/ckanserviceprovider/)
[](https://pypi.python.org/pypi/ckanserviceprovider/)
[](https://pypi.python.org/pypi/ckanserviceprovider/)
[](https://pypi.python.org/pypi/ckanserviceprovider/)
[](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
pytest
```
## 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:
1. Increment the version number in [setup.py](setup.py)
2. Build a source distribution of the new version and publish it to
[PyPI][]:
```bash
python setup.py sdist bdist_wheel
pip install --upgrade twine
twine upload dist/*
```
You may want to test installing and running the new version from PyPI in a
clean virtualenv before continuing to the next step.
3. 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)
Raw data
{
"_id": null,
"home_page": "https://github.com/ckan/ckan-service-provider",
"name": "ckanserviceprovider",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "ckan",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/6f/f6/15ba8953f6ea22049b516d2d8412c396cbb7293e4629b712dd63da698472/ckanserviceprovider-1.2.0.tar.gz",
"platform": null,
"description": "[](https://github.com/ckan/ckan-service-provider/actions/workflows/test.yml)\n[](https://pypi.python.org/pypi/ckanserviceprovider/)\n[](https://pypi.python.org/pypi/ckanserviceprovider/)\n[](https://pypi.python.org/pypi/ckanserviceprovider/)\n[](https://pypi.python.org/pypi/ckanserviceprovider/)\n[](https://pypi.python.org/pypi/ckanserviceprovider/)\n\n[DataPusher]: https://github.com/okfn/datapusher\n[PyPI]: https://pypi.python.org/pypi/ckanserviceprovider\n\n\n# CKAN Service Provider\n\nA library for making web services that make functions available as synchronous\nor asynchronous jobs. Used by [DataPusher][].\n\n\n## Getting Started\n\nTo install ckanserviceprovider for development:\n\n```bash\ngit clone https://github.com/ckan/ckan-service-provider.git\ncd ckan-service-provider\npip install -r requirements-dev.txt\n```\n\nTo get started making a web service with ckanserviceprovider have a look at\n[/example](example). You can run the example server with\n`python example/main.py example/settings_local.py`.\n\nFor a real-world example have a look at [DataPusher][].\n\n\n## Running the Tests\n\nTo run the ckanserviceprovider tests:\n\n```bash\npytest\n```\n\n\n## Building the Documentation\n\nTo build the ckanserviceprovider docs:\n\n```bash\npython setup.py build_sphinx\n```\n\n\n## Releasing a New Version\n\nTo release a new version of ckanserviceprovider:\n\n1. Increment the version number in [setup.py](setup.py)\n\n2. Build a source distribution of the new version and publish it to\n [PyPI][]:\n\n ```bash\n python setup.py sdist bdist_wheel\n pip install --upgrade twine\n twine upload dist/*\n ```\n\n You may want to test installing and running the new version from PyPI in a\n clean virtualenv before continuing to the next step.\n\n3. Commit your setup.py changes to git, tag the release, and push the changes\n and the tag to GitHub:\n\n ```bash\n git commit setup.py -m \"Bump version number\"\n git tag 0.0.1\n git push\n git push origin 0.0.1\n ```\n\n (Replace both instances of 0.0.1 with the number of the version you're\n releasing.)\n\n\n## Authors\n\nThe original authors of ckanserviceprovider were\nDavid Raznick <david.raznick@okfn.org> and\nDominik Moritz <dominik.moritz@okfn.org>. For the current list of contributors\nsee [github.com/ckan/ckan-service-provider/contributors](https://github.com/ckan/ckan-service-provider/contributors)",
"bugtrack_url": null,
"license": "AGPL",
"summary": "A library for making web services that make functions available as synchronous or asynchronous jobs",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://github.com/ckan/ckan-service-provider"
},
"split_keywords": [
"ckan"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6ff615ba8953f6ea22049b516d2d8412c396cbb7293e4629b712dd63da698472",
"md5": "4165eadb7373e244c0c6444ac0aca63c",
"sha256": "b86486df8dcdb86e02a0ae19b16f446ae132290bb6e8f00789b9842fec2422f1"
},
"downloads": -1,
"filename": "ckanserviceprovider-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "4165eadb7373e244c0c6444ac0aca63c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29385,
"upload_time": "2023-10-16T13:59:16",
"upload_time_iso_8601": "2023-10-16T13:59:16.378302Z",
"url": "https://files.pythonhosted.org/packages/6f/f6/15ba8953f6ea22049b516d2d8412c396cbb7293e4629b712dd63da698472/ckanserviceprovider-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-16 13:59:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ckan",
"github_project": "ckan-service-provider",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "APScheduler",
"specs": [
[
"==",
"3.9.1.post1"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.27.1"
]
]
},
{
"name": "Flask",
"specs": [
[
"==",
"2.1.1"
]
]
},
{
"name": "Flask-Login",
"specs": [
[
"==",
"0.5.0"
]
]
},
{
"name": "future",
"specs": [
[
"==",
"0.18.3"
]
]
}
],
"lcname": "ckanserviceprovider"
}
JSON
