Skip to main content

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

Project 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.

Authorisation

Log in to the CharityBase API Portal and create an API key.

Example

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

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)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

charity-base-client-python-0.1.3.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

charity_base_client_python-0.1.3-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file charity-base-client-python-0.1.3.tar.gz.

File metadata

  • Download URL: charity-base-client-python-0.1.3.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for charity-base-client-python-0.1.3.tar.gz
Algorithm Hash digest
SHA256 6a021867d9632b650a32d698483dec565cdf46b78f88dc2e71fb1a1d07e44790
MD5 24a55376c798b7583067056f10d2d6cd
BLAKE2b-256 7b6b804b81768f534b02799f98bd7a4487baf1d67e353912d7ff42dc2540fc24

See more details on using hashes here.

File details

Details for the file charity_base_client_python-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: charity_base_client_python-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for charity_base_client_python-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6343bb686af17fd7ca71d0f59669560b26ae6b2f0d144fb64576b364dc07cf4b
MD5 ffada8719f847ef57b4bb75d6fd6ad94
BLAKE2b-256 7c8f0f297fea700d21aab8b49f69906c256b14acd5e28b1eddfddc29f700139a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page