Skip to main content

Python client for OpenClimate API

Project description

OpenClimate-pyclient

Tests Documentation Status pypi Formatted with black License Examples on binder contributions welcome

OpenClimate Python Client is a Python 3.8+ package for the OpenClimate API. The goal of this package is to make emissions data and pledges more accessible.

Installation

pip install openclimate

Usage

Import and create a Client() object

from openclimate import Client
client = Client()

Retrieving data

Emissions

Retrieve all emissions data for a single actor. Here I am retrieving emissions data for Canada

df = client.emissions(actor_id='CA')

Retrieve all emissions data for a list of actors. Here I am retrieving emission data for the United States, Canada, and Great Britain.

df = client.emissions(actor_id=['US','CA','GB'])

Return the different datasets available for a particular actor:

df = client.emissions_datasets(actor_id='US')

Only select data for a particular dataset

df = client.emissions_datasets(actor_id='US', datasource_id='GCB2022:national_fossil_emissions:v1.0')

Targets

Retrieve emissions targets for a particule actor

df = client.targets(actor_id='US')

Population

Retrieve population data.

df = client.population(actor_id=['US','CA','GB'])

GDP

Retrieve GDP data.

df = client.gdp(actor_id=['US','CA','GB'])

Searching for codes

use the following to list the actor_ids for countries:

df = client.country_codes()

search for actor codes:

df = client.search(query='Minnesota')

get all the parts of an actor. Here I am returning the actor_id for each US state.

df = client.parts(actor_id='US',part_type='adm1')

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

openclimate-0.1.5.tar.gz (17.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openclimate-0.1.5-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file openclimate-0.1.5.tar.gz.

File metadata

  • Download URL: openclimate-0.1.5.tar.gz
  • Upload date:
  • Size: 17.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for openclimate-0.1.5.tar.gz
Algorithm Hash digest
SHA256 cee9d4140da99815421786a736d0ed31b464cb1268caf4b4ad98c8912b9d765b
MD5 f180cb7944125518240dcd1cb5fe2679
BLAKE2b-256 be4e661f05d6eed742ab6cb7d1cf7a42240cc14ea7ede6abdca207e82afd5bc0

See more details on using hashes here.

File details

Details for the file openclimate-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: openclimate-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for openclimate-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 226f4671ac07b2772a560900ea4ae34a3937d85200f9e093bc8e118e6ef101fa
MD5 ab997bffa02d67af0725808bac06dff9
BLAKE2b-256 9df2f09de9c28fd0e4c656e5ababf84be0876290a62892062753eea85f7984c1

See more details on using hashes here.

Supported by

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