Skip to content

Repository files navigation

Aembit Edge SDKs

SDKs and examples for integrating applications and services with the Aembit Edge API.

These libraries make it easier for developers to authenticate workloads and retrieve credentials through Aembit without interacting with raw Aembit Edge API HTTP requests directly.

The SDKs are intended for:

  • AI agents and MCP servers
  • serverless functions
  • backend services
  • automation and CI/CD systems
  • other applications that need programmatic access to credentials managed by Aembit

Each SDK provides a developer-friendly interface for the Aembit Edge API authentication and credential retrieval flow while handling common concerns such as request construction, token lifecycle management, and error handling.

Repository Structure

This repository is organized as a multi-language SDK workspace.

Repository layout:

  • / repository-level governance and overview docs (README.md, AGENTS.md)
  • docs/ architecture and design documentation
  • spec/ cross-language SDK contracts
  • spec/openapi/ pinned OpenAPI snapshots and snapshot metadata
  • ts/ TypeScript SDK (reference implementation)
  • py/ Python SDK
  • go/ planned Go SDK directory

Each language SDK directory should contain:

  • the SDK implementation
  • examples demonstrating common usage
  • language-specific documentation

Project Status

This repository hosts SDKs for the Aembit Edge API.

The TypeScript SDK is the first implementation and serves as the reference design for the SDK architecture.

The Python SDK is in early implementation and follows the same conceptual design where practical.

Additional SDKs for other languages (such as Go) will follow the same conceptual design where possible.

Examples

Each SDK will include runnable example applications that demonstrate common usage patterns such as:

  • authenticating a workload
  • retrieving credentials
  • using credentials to access protected services

Examples are intended to be minimal, practical, and easy to run.
Examples should live in language-specific directories such as ts/examples/, py/examples/, and go/examples/.

Contributing

Contributions are welcome.

If you are contributing code, please review:

AGENTS.md

This file contains repository guidelines and development conventions intended for both human contributors and coding agents.

Documentation

Additional documentation about the architecture and SDK design can be found in:

  • docs/ for architecture and design notes
  • spec/ for cross-language SDK design contracts
  • spec/openapi/ for pinned OpenAPI snapshots used in SDK development
  • official Aembit Edge API docs: https://docs.aembit.io/api-guide/edge/

Quality Checks

Run TypeScript SDK checks from ts/:

  • npm run lint
  • npm run typecheck
  • npm test

Run Python SDK checks from py/:

  • uv sync --extra dev --locked
  • uv run ruff check .
  • uv run ruff format --check .
  • uv run pyright
  • uv run pytest

Run Markdown checks from repository root:

  • npm run lint:md

Dependency Management

This repository adheres to standard industry dependency patterns for public SDK development:

  • Flexible Ranges for Consumers: Public SDK dependencies are kept flexible using semantic ranges (^ / ~ / >=) to avoid downstream dependency conflicts.
  • Strict Internal Lockfiles: Committed lockfiles (package-lock.json and uv.lock) guarantee secure and reproducible environments for internal development and CI testing.
  • Automated Upgrades with Renovate: Renovate is integrated to automatically scan our dependencies and open unified pull requests monthly to keep our dependencies and GitHub Actions securely updated.

License

This project will be released under an open source license prior to public release.

About

SDKs and examples for integrating applications and services with the Aembit Edge API

Resources

Contributing

Stars

3 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages