Skip to content

README.md

Latest commit

 

History

History
85 lines (61 loc) · 3.66 KB

README.md

File metadata and controls

85 lines (61 loc) · 3.66 KB

Seequent logo

PyPI - Version

Seequent Developer Portal • Seequent Community • Seequent website

Evo SDK Common

Evo SDK Common is a Python package that establishes a common framework for use by client libraries that interact with Seequent Evo APIs. It can also be used to power arbitrary API requests to Seequent Evo APIs, where an existing client SDK may not exist yet.

Pre-requisites

Installation

pip install evo-sdk-common

To use the SDK within a Jupyter notebook, include the notebooks optional dependency:

pip install evo-sdk-common[notebooks]

Usage

See the Getting Started guide to learn how to use this library. There is more detailed information about authentication options in the OAuth examples, and a selection of interactive Jupyter notebooks in the examples folder.

Here's a small example from the Getting Started guide showing to use evo-sdk-common to list the organizations you have access to:

from evo.aio import AioTransport
from evo.oauth import OAuthConnector, AuthorizationCodeAuthorizer
from evo.discovery import DiscoveryAPIClient
from evo.common import APIConnector
import asyncio

transport = AioTransport(user_agent="Your Application Name")
connector = OAuthConnector(transport=transport, client_id="<YOUR_CLIENT_ID>")
authorizer = AuthorizationCodeAuthorizer(oauth_connector=connector, redirect_url="http://localhost:3000/signin-callback")

async def main():
    await authorizer.login()
    await discovery()

async def discovery():
    async with APIConnector("https://discover.api.seequent.com", transport, authorizer) as api_connector:
        discovery_client = DiscoveryAPIClient(api_connector)
        organizations = await discovery_client.list_organizations()
        print("Organizations:", organizations)

asyncio.run(main())

Contributing

For instructions on contributing to the development of this library, please refer to the evo-python-sdk documentation.

License

The Python SDK for Evo is open source and licensed under the Apache 2.0 license..

Copyright © 2025 Bentley Systems, Incorporated.

Licensed under the Apache License, Version 2.0 (the "License"). You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.