Skip to content

Godel is Golden's open-source Python SDK that will provide developers and agents with the tools and means to build applications and extend Golden's protocol.

License

Notifications You must be signed in to change notification settings

goldenrecursion/godel

Repository files navigation

Godel: Golden's Python SDK for its Decentralized Canonical Knowledge Graph

Overview

Golden's protocol provides users with the opportunity to query from and contribute towards building the world's most extensive decentralized graph of canonical knowledge.

Godel is Golden's open-source Python SDK that will provide developers and agents with the tools and means to build applications and extend Golden's protocol.

Godel's repository includes a python package and software to help provide developers with an API wrapper, data processing framework, and web3 utility toolkit for programmatic data query and ingest.

Documentation

Godel guides and documentation can be found in Golden's API Docs.

Installation

Godel requires Python 3.7+

pip install godel

# Add extras to install web3, jupyter, data tools, etc.
pip install godel[web3,data-tools]

Quickstart

Query against the protocol GraphQL API to retrieve and explore data in the knowledge graph.

from godel import GoldenAPI

goldapi = GoldenAPI()

# Operations that do not require authentication
# Retrieve existing triple predicates
goldapi.predicates()

# Retrieve existing entity templates 
goldapi.templates()

# With signed authentication
# Find your JSON Web Token(JWT) at "https://dapp.golden.xyz/profile" after signing in
goldapi = GoldenAPI(jwt_token=<your_token>)

# Search and query for specific entities
goldapi.entity_search(name="Golden")

Docker Setup

Run docker-compose build and then docker-compose up.

Go to localhost:8888 to run our tutorials in jupyter lab.

Images are built with data processing and compute in mind to aid users in their validation and ingest queries.

Contact

For all things related to godel and development, please contact the maintainer Andrew Chang at andrew@golden.co or @achang1618 for any quesions or comments.

For all other support, please reach out to support@golden.co.

Follow @golden to keep up with additional news!

License

This project is licensed under the terms of the Apache 2.0 license