Skip to content

Add 'Where to get it' section in README #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yanyanzhu-pnnl merged 1 commit into from
Jul 23, 2026
Merged

Add 'Where to get it' section in README #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,18 @@ Quickly useful notes:
- If you reference this package from other workspace packages, keep the `tool.uv.sources` entry that maps `comcheck_api = { workspace = true }` so `uv` resolves it to the local workspace copy.
- For a single-package repo you can also rely on `members = ["."]` and omit additional sources, but leaving the explicit source entry is harmless and makes intent clear.

## Where to get it

The source code is hosted on GitHub at:
https://github.com/pnnl/comcheckweb-api-python

Binary installers for the latest released version are available at the
[Python Package Index (PyPI)](https://pypi.org/project/comcheck-api).

```sh
pip install comcheck-api
```

## Usage

### 1. Obtain an API Key
Expand Down