charity-base-client-python 0.1.1

A Python client library for interacting with the CharityBase REST API.

Copyright (c) 2018 David Kane

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Description: # CharityBase Client Library (Python)

A Python client library for interacting with the CharityBase REST API. Tested on python 3.7.1

Modelled on the [official charitybase JavaScript client](https://github.com/charity-base/charity-base-client-js).

## Authorisation

Log in to the [CharityBase API Portal](https://charitybase.uk/api-portal) and create an API key.

## Example

Search for "homeless" charities with income range £100k - £1m, sorted by descending income:

```python
from charitybase import CharityBase


charityBase = CharityBase(apiKey='my-api-key')

res = charityBase.charity.list({
'fields': ['income.latest.total'],
'search': 'homeless',
'incomeRange': [100000, 1000000],
'sort': 'income.latest.total:desc',
'limit': 10,
'skip': 0,
})
print(res.charities)
```

(Remember to replace `my-api-key` with your actual key, copied from the [CharityBase API Portal](https://charitybase.uk/api-portal))

Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown