Skip to main content

Create and run a BigConfig CLI from a language-specific GitHub package.

Project description

bc-pkg

bc-pkg creates or reuses a BigConfig CLI in the current directory, then forwards your command to that CLI.

The PyPI package and the npm package expose the same behavior. The target package can be implemented in Clojure, TypeScript, or Python; bc-pkg infers that language from the pinned GitHub content.

Usage

uvx bc-pkg <owner/repo@ref> package validate
uvx bc-pkg package validate

ref can be a branch name or a full 40-character commit SHA:

uvx bc-pkg bigconfig-ai/once@python package validate
uvx bc-pkg bigconfig-ai/once@2f4e8c0d0b4c4b8f0c3a9f6e2a1b5c7d8e9f0123 package validate

On the first run, bc-pkg resolves the ref to a full SHA and pins it. Later runs omit <owner/repo@ref> and keep using the pinned SHA.

Local repositories

For live local development you can point bc-pkg at a local checkout of a target package instead of a GitHub spec. The first argument is treated as a local path when it starts with /, ./, ../, ~, or is ./..:

uvx bc-pkg ../once/python package build
uvx bc-pkg /abs/path/to/once/clojure package build

Local targets are wired up live — your uncommitted edits in the local package are picked up on the next run, with no SHA pinning and no push:

Target language Local dependency
Clojure deps.edn / bb.edn use :local/root
TypeScript package.json uses a file: dependency
Python pyproject.toml uses an editable [tool.uv.sources] path

The run file is symlinked (not copied) so run-file edits are also live. Run bc-pkg from a separate directory; pointing it at the current directory is refused so it never overwrites the package's own manifest. Switching an initialized directory between local and GitHub (or to a different local path) is a hard error, just like a repo/ref/SHA mismatch.

Notes: TypeScript local dev requires the local package to be built (its dist/); Python local dev installs the package editable. Python template data ships as a top-level resources package, which BigConfig's renderer resolves through importlib.resources, so no ./resources directory is created.

What is created

The launcher copies the target package's root run file into the current directory and writes language-native metadata:

Target language Manifest Runtime command
Clojure deps.edn bb run ...
TypeScript package.json node run ...
Python pyproject.toml uv run python run ...

For Clojure targets, a small bb.edn runtime dependency file is also written so Babashka can load the pinned Git dependency.

If the directory is already initialized for a different repo/ref/SHA, bc-pkg exits with an error instead of updating it implicitly.

Requirements

  • Python launcher: Python >= 3.11.
  • TypeScript target packages: Node.js and npm must already be installed.
  • Python target packages: Python and uv must already be installed.
  • Clojure target packages: bc-pkg downloads pinned Babashka and Temurin JDK versions into a shared user cache and checks/installs git on Linux.

Environment

Variable Effect
GITHUB_TOKEN Used for private GitHub repos or higher API rate limits.
BB_VERSION Override the Babashka version for Clojure targets.
JDK_VERSION Override the Temurin JDK feature version for Clojure targets.

Cache

Babashka and JDK downloads are shared across projects under:

  • macOS/Linux: $XDG_CACHE_HOME/bc-pkg or ~/.cache/bc-pkg
  • Windows: %LOCALAPPDATA%/bc-pkg

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bc_pkg-1.0.3.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bc_pkg-1.0.3-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

Details for the file bc_pkg-1.0.3.tar.gz.

File metadata

  • Download URL: bc_pkg-1.0.3.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for bc_pkg-1.0.3.tar.gz
Algorithm Hash digest
SHA256 a1054da6c824d164302fb499eca77111017ac1608c6d55491790b8490f1af515
MD5 6d6b6959c529330db94e7a9f6d11e3d5
BLAKE2b-256 48591732145ea1ee0aee0ce1c74a1adef8f509b745f6afaa6248a56b4df52ffb

See more details on using hashes here.

File details

Details for the file bc_pkg-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: bc_pkg-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 11.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for bc_pkg-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d64a8751148f38226532af1f42da9c932c1b17b61a3f1037107f04dc2de225e7
MD5 fd5f6357d9d74f579c8f3aa393313b69
BLAKE2b-256 38fb631522b8525eca298bfadacd7bfd21a2d29492a9a1effb8e459f12510430

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page