You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ pip install umbi
15
15
16
16
## Quick start
17
17
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:
19
19
20
20
```python
21
21
import umbi
@@ -50,11 +50,11 @@ More examples can be found in the [examples](https://github.com/pmc-tools/umbi/t
50
50
51
51
`umbi` offers multiple levels of abstraction for working with UMB files:
52
52
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.
54
54
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.
56
56
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.
58
58
59
59
## CLI
60
60
@@ -105,7 +105,7 @@ Current test coverage:
105
105
106
106
### Code Quality
107
107
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)
109
109
110
110
Set up the hooks with:
111
111
@@ -121,14 +121,14 @@ pre-commit run --all-files
121
121
122
122
Individual tools can be run manually:
123
123
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]`)
125
125
```bash
126
126
ruff check .# check for issues
127
127
ruff check . --fix # check and fix
128
128
ruff format .# format code
129
129
```
130
130
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]`)
132
132
```bash
133
133
pyright # check entire project
134
134
pyright umbi/ # check specific directory
@@ -142,9 +142,9 @@ To bump the version, run
142
142
bump-my-version bump <patch|minor|major>
143
143
git push origin --follow-tags
144
144
```
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:
146
146
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
148
148
2. build the distribution packages
149
149
3. publish to [PyPI](https://pypi.org/project/umbi/) via trusted publishing
150
150
4. update the stable branch to track the latest release
0 commit comments