Skip to content
AdaStruct

Contributors

For contributors

Section titled “For contributors”

Local development

Section titled “Local development”

Use uv:

Terminal window
uv sync --group dev

Run the CLI from the repo:

Terminal window
uv run codeshare --help
uv run codeshare --version

Smoke test

Section titled “Smoke test”

Run:

Terminal window
uv run python -m codeshare.release_checks

The smoke test currently covers: • snapshot creation • diff creation • read-only snapshot behavior • docs rendering in full mode • default log exclusion • explicit log inclusion • .codeignore lockfile exclusion • cross-repo file rendering • docs exclusion from API-only output

Build

Section titled “Build”
Terminal window
rm -rf dist build src/*.egg-info
uv run python -m build

Publish

Section titled “Publish”
Terminal window
uv run twine upload \
  --repository-url https://pypi.adastruct.com/ \
  -u admin \
  -p PASSWORD \
  dist/*

Install or update the CLI

Section titled “Install or update the CLI”

Install globally:

Terminal window
uv tool install \
  --index-url https://pypi.adastruct.com/simple \
  codeshare-dump

Upgrade later:

Terminal window
uv tool install --upgrade \
  --index-url https://pypi.adastruct.com/simple \
  codeshare-dump

Force reinstall when needed:

Terminal window
uv tool install --upgrade --reinstall \
  --index-url https://pypi.adastruct.com/simple \
  codeshare-dump

Check the installed version:

Terminal window
codeshare --version

Shell completion

Section titled “Shell completion”
Terminal window
codeshare completion bash
codeshare completion zsh

Self-update

Section titled “Self-update”
Terminal window
codeshare self-update

Notes • codeshare is a CLI tool, not a normal Python dependency for downstream projects. • prompts_artifacts/ should remain ignored. • prompt artifacts in downstream repos are intentionally private and should not be published in docs. • explicitly requested cross-repo files are supported.