Skip to main content

grow-openbao (Python)

Python SDK for OpenBao by Grow Codes. Unofficial and community maintained; "OpenBao" is a trademark of OpenBao a Series of LF Projects, LLC.

pip install grow-openbao
from grow_openbao import OpenBaoClient, OpenBaoConfig

# Reads GROW_OPENBAO_URL, GROW_OPENBAO_TOKEN, ... from the environment.
with OpenBaoClient.from_env() as client:
    print(client.health())
    print(client.server_version())

The async client has the same methods:

import asyncio
from grow_openbao import AsyncOpenBaoClient

async def main() -> None:
    async with AsyncOpenBaoClient.from_env() as client:
        print(await client.health())

asyncio.run(main())

Service modules hang off the client (the async client mirrors every one of them):

from grow_openbao import AppRoleAuth, OpenBaoClient

with OpenBaoClient.from_env() as client:
    client.auth.login(AppRoleAuth(role_id, secret_id), auto_renew=True)   # TokenRenewer
    client.kv().write("app/db", {"password": "s3cret"})                    # KV v1/v2 auto-detected
    print(client.kv().read("app/db").metadata)
    ct = client.transit().encrypt("my-key", "hello")                       # transit
    lease = client.database().get_credentials("readonly")                  # dynamic credentials
    client.leases.manage(lease, on_expire=lambda: print("expired"))       # LeaseManager
    cert = client.pki().issue_certificate("web", "app.example.com")        # PKI
    token = client.wrapping.wrap({"one-time": "value"}, ttl_s=60).token    # response wrapping
    client.sys.write_policy("app", 'path "secret/data/app/*" { capabilities = ["read"] }')
    print(client.secrets(path="app").get_string("db"))                     # SecretsProvider
Module Accessor Functions
Auth client.auth login(TokenAuth / AppRoleAuth / KubernetesAuth / JwtAuth / UserpassAuth), lookup_self, renew_self, revoke_self, create_token, start_renewer (TokenRenewer)
KV client.kv(mount), kv_v1, kv_v2 read, write, patch, delete, delete_versions, undelete, destroy, list, read_metadata, write_metadata, delete_metadata
Transit client.transit(mount) create_key, read_key, list_keys, rotate_key, update_key_config, delete_key, encrypt, decrypt, rewrap, encrypt_batch, decrypt_batch, generate_data_key, hmac, sign, verify, hash, random_bytes
Database client.database(mount) get_credentials → Lease, configure_connection, read_connection, delete_connection, create_role, read_role, delete_role
Leases client.leases renew, revoke, revoke_prefix, lookup, manage (auto-renew + on_expire), stop_all
PKI client.pki(mount) issue_certificate, sign_csr, revoke_certificate, read_ca_chain, read_certificate, list_certificates, tidy, tidy_status
System client.sys health, seal_status, leader, version, policies, secrets engines, auth methods, AppRole admin (create_app_role, read_role_id, generate_secret_id …)
Wrapping client.wrapping wrap, unwrap, lookup_wrapping
Secrets client.secrets(mount, path=…) the shared SecretsProvider (get, set, list, delete, metadata, load_env, watch …)
Testing grow_openbao.testing.lifecycle init, unseal, seal, init_status, wait_for_active (+ a… async forms)

Durations are float seconds (…_s parameters, timedelta accepted); timestamps are aware UTC datetimes; tokens, keys and passwords are Secret values.

  • Python 3.10 or newer, typed (py.typed), httpx based, environment proxies ignored unless configured.
  • Retries with full-jitter backoff and Retry-After, connect/request/total timeouts, cancellation, hooks and a silent-by-default logging logger named grow_openbao.
  • Credentials are wrapped in Secret and never appear in repr(), logs or error messages.
  • grow_openbao.testing ships in-memory fakes and the conformance runner.

Documentation: https://grow-codes-packages.github.io/openbao/ · Source: https://github.com/grow-codes-packages/openbao · Licence: Apache-2.0

Metadata

Release files for grow-openbao 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for grow-openbao 0.1.0
File Size Uploaded Provenance Actions
grow_openbao-0.1.0.tar.gz 157.6 kB Without provenance Details for grow_openbao-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for grow-openbao 0.1.0
File Interpreter ABI Platform Actions
grow_openbao-0.1.0-py3-none-any.whl Python 3 none any Details for grow_openbao-0.1.0-py3-none-any.whl

Total release size: 269.4 kB

Release files / grow_openbao-0.1.0.tar.gz

Download URL grow_openbao-0.1.0.tar.gz
Size 157.6 kB
Tags Source
SHA-256 checksum
How to use checksums
96b43d217478a4d83f77d8120ef2334cbf7a1e35e86926d38b842f1250262a77
BLAKE2b-256 checksum
How to use checksums
4c0b005a8a2f00ca7acda7345c073e2ebfeec5be423b262c9ab1101cbc63c9ad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.4

Release files / grow_openbao-0.1.0-py3-none-any.whl

Download URL grow_openbao-0.1.0-py3-none-any.whl
Size 111.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
553da6b939117c13070558bf68e4e1dbd091c957dadef52597a3f02cc1b688c4
BLAKE2b-256 checksum
How to use checksums
538974724cf9a8e31c08464695d3723ca89a5db2f7b8a569682b875aa1094ac5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.4

Security for grow-openbao 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page