Skip to content

Commit 33ce4ab

Browse files
committed
readme: use absolute urls for files
1 parent 5461953 commit 33ce4ab

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ pip install umbi
1515

1616
## Quick start
1717

18-
A short example where we read a umbfile into an [`SimpleAts`](umbi/ats/explicit_ats.py) object, modify initial states, and write it back:
18+
A short example where we read a umbfile into an [`SimpleAts`](https://github.com/pmc-tools/umbi/blob/main/umbi/ats/explicit_ats.py) object, modify initial states, and write it back:
1919

2020
```python
2121
import umbi
@@ -50,11 +50,11 @@ More examples can be found in the [examples](https://github.com/pmc-tools/umbi/t
5050

5151
`umbi` offers multiple levels of abstraction for working with UMB files:
5252

53-
**[`TarFile`](umbi/tar/tar_file.py) and [`TarCoder`](umbi/tar/tar_coder.py)** - low-level access to umbfile contents.
53+
**[`TarFile`](https://github.com/pmc-tools/umbi/blob/main/umbi/tar/tar_file.py) and [`TarCoder`](https://github.com/pmc-tools/umbi/blob/main/umbi/tar/tar_coder.py)** - low-level access to umbfile contents.
5454

55-
**[`ExplicitUmb`](umbi/umb/explicit_umb.py)** - in-memory representation of a typical umbfile. Attributes are standard Python objects (lists, dicts, dataclasses) providing a deserialized view of the file contents.
55+
**[`ExplicitUmb`](https://github.com/pmc-tools/umbi/blob/main/umbi/umb/explicit_umb.py)** - in-memory representation of a typical umbfile. Attributes are standard Python objects (lists, dicts, dataclasses) providing a deserialized view of the file contents.
5656

57-
**[`SimpleAts`](umbi/ats/simple_ats.py)** - format-agnostic abstraction for annotated transition systems (states, transitions, annotations, etc.). Recommended for most use cases: easiest to use programmatically and remains stable across UMB format changes. See [umbi.ats.examples](https://github.com/pmc-tools/umbi/tree/main/umbi/ats/examples/) for usage examples.
57+
**[`SimpleAts`](https://github.com/pmc-tools/umbi/blob/main/umbi/ats/simple_ats.py)** - format-agnostic abstraction for annotated transition systems (states, transitions, annotations, etc.). Recommended for most use cases: easiest to use programmatically and remains stable across UMB format changes. See [umbi.ats.examples](https://github.com/pmc-tools/umbi/tree/main/umbi/ats/examples/) for usage examples.
5858

5959
## CLI
6060

@@ -105,7 +105,7 @@ Current test coverage:
105105

106106
### Code Quality
107107

108-
Pre-commit hooks automatically run code quality checks before each commit. Configuration: [.pre-commit-config.yaml](.pre-commit-config.yaml)
108+
Pre-commit hooks automatically run code quality checks before each commit. Configuration: [.pre-commit-config.yaml](https://github.com/pmc-tools/umbi/blob/main/.pre-commit-config.yaml)
109109

110110
Set up the hooks with:
111111

@@ -121,14 +121,14 @@ pre-commit run --all-files
121121

122122
Individual tools can be run manually:
123123

124-
**[Ruff](https://github.com/astral-sh/ruff)** -- Code formatting and linting. Config: [pyproject.toml](pyproject.toml) (`[tool.ruff]`)
124+
**[Ruff](https://github.com/astral-sh/ruff)** -- Code formatting and linting. Config: [pyproject.toml](https://github.com/pmc-tools/umbi/blob/main/pyproject.toml) (`[tool.ruff]`)
125125
```bash
126126
ruff check . # check for issues
127127
ruff check . --fix # check and fix
128128
ruff format . # format code
129129
```
130130

131-
**[Pyright](https://github.com/microsoft/pyright)** -- Static type checking. Config: [pyproject.toml](pyproject.toml) (`[tool.pyright]`)
131+
**[Pyright](https://github.com/microsoft/pyright)** -- Static type checking. Config: [pyproject.toml](https://github.com/pmc-tools/umbi/blob/main/pyproject.toml) (`[tool.pyright]`)
132132
```bash
133133
pyright # check entire project
134134
pyright umbi/ # check specific directory
@@ -142,9 +142,9 @@ To bump the version, run
142142
bump-my-version bump <patch|minor|major>
143143
git push origin --follow-tags
144144
```
145-
or run the [bump version workflow](.github/workflows/bump.yml) (via GitHub Actions UI). When the new version tag is pushed, the [release workflow](.github/workflows/release.yml) is automatically triggered to:
145+
or run the [bump version workflow](https://github.com/pmc-tools/umbi/blob/main/.github/workflows/bump.yml) (via GitHub Actions UI). When the new version tag is pushed, the [release workflow](https://github.com/pmc-tools/umbi/blob/main/.github/workflows/release.yml) is automatically triggered to:
146146

147-
1. update [uv.lock](uv.lock) to pin dependencies
147+
1. update [uv.lock](https://github.com/pmc-tools/umbi/blob/main/uv.lock) to pin dependencies
148148
2. build the distribution packages
149149
3. publish to [PyPI](https://pypi.org/project/umbi/) via trusted publishing
150150
4. update the stable branch to track the latest release

0 commit comments

Comments
 (0)