Geodesic Basics

The general workflow for using the Geodesic Python API is as follows:

1. Import the Geodesic Python API

>>> import geodesic

2. Authenticate your account. You will not need to log in each time you use the API. The credentials stored are long lived.

>>> geodesic.authenticate()

3. Create a new projects and activate.

>>> geodesic.create_project(name="docs-example", alias="Docs Example Project", description="Test project for illustration purposes")
>>> geodesic.get_active_project("docs-example")

For more indepth instructions on installing the python API, please visit our Installing page.