Skip to main content

Access via Python

The OSO API serves queries on metrics and metadata about open source projects. You can access the full data lake via our pyoso Python library.

Let's make your first query in under five minutes.

Generate an API key​

First, go to www.opensource.observer and create a new account.

If you already have an account, log in. Then create a new personal API key:

  1. Go to Account settings
  2. In the "API Keys" section, click "+ New"
  3. Give your key a label - this is just for you, usually to describe a key's purpose.
  4. You should see your brand new key. Immediately save this value, as you'll never see it again after refreshing the page.
  5. Click "Create" to save the key.

generate API key

Install pyoso​

You can install pyoso using pip:

pip install pyoso

Issue your first query​

Here is a basic example of how to use pyoso:

from pyoso import Client

# Initialize the client
os.environ["OSO_API_KEY"] = 'your_api_key'
client = Client()

# Fetch artifacts
query = "SELECT * FROM artifacts_v1 LIMIT 5"
artifacts = client.query(query)

print(artifacts)

Next steps​

Congratulations! You've made your first API request. Now try one of our tutorials.