Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .adr-dir
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs/decisions
136 changes: 136 additions & 0 deletions ATTRIBUTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,40 @@ without prior written permission from Aignostics GmbH.

```

## annotated-types (0.7.0) - MIT License

Reusable constraint types to use with typing.Annotated

* URL: https://github.com/annotated-types/annotated-types
* Author(s): Adrian Garcia Badaracco <1755071+adriangb@users.noreply.github.com>, Samuel Colvin <s@muelcolvin.com>, Zac Hatfield-Dodds <zac@zhd.dev>

### License Text

```
The MIT License (MIT)

Copyright (c) 2022 the contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

```

## argcomplete (3.6.3) - Apache Software License

Bash tab completion for argparse
Expand Down Expand Up @@ -5123,6 +5157,74 @@ Library for serializing and deserializing Python Objects to and from JSON and XM

```

## pydantic (2.12.5) - UNKNOWN

Data validation using Python type hints

* URL: https://github.com/pydantic/pydantic
* Author(s): Samuel Colvin <s@muelcolvin.com>, Eric Jolibois <em.jolibois@gmail.com>, Hasan Ramezani <hasan.r67@gmail.com>, Adrian Garcia Badaracco <1755071+adriangb@users.noreply.github.com>, Terrence Dorsey <terry@pydantic.dev>, David Montague <david@pydantic.dev>, Serge Matveenko <lig@countzero.co>, Marcelo Trylesinski <marcelotryle@gmail.com>, Sydney Runkle <sydneymarierunkle@gmail.com>, David Hewitt <mail@davidhewitt.io>, Alex Hall <alex.mojaki@gmail.com>, Victorien Plot <contact@vctrn.dev>, Douwe Maan <hi@douwe.me>

### License Text

```
The MIT License (MIT)

Copyright (c) 2017 to present Pydantic Services Inc. and individual contributors.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

```

## pydantic_core (2.41.5) - UNKNOWN

Core functionality for Pydantic validation and serialization

* URL: https://github.com/pydantic/pydantic-core
* Author(s): Samuel Colvin <s@muelcolvin.com>, Adrian Garcia Badaracco <1755071+adriangb@users.noreply.github.com>, David Montague <david@pydantic.dev>, David Hewitt <mail@davidhewitt.dev>, Sydney Runkle <sydneymarierunkle@gmail.com>, Victorien Plot <contact@vctrn.dev>

### License Text

```
The MIT License (MIT)

Copyright (c) 2022 Samuel Colvin

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

```

## pyparsing (3.3.2) - UNKNOWN

pyparsing - Classes and methods to define and execute parsing grammars
Expand Down Expand Up @@ -7747,6 +7849,40 @@ DEALINGS IN THE SOFTWARE.

```

## typing-inspection (0.4.2) - UNKNOWN

Runtime typing introspection tools

* URL: https://github.com/pydantic/typing-inspection
* Author(s): Victorien Plot <contact@vctrn.dev>

### License Text

```
MIT License

Copyright (c) Pydantic Services Inc. 2025 to present

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

```

## typing_extensions (4.15.0) - UNKNOWN

Backported and Experimental Type Hints for Python 3.9+
Expand Down
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,9 @@ Or follow the [installation guide](https://mise.jdx.dev/getting-started.html) fo
## Usage

```python
from aignostics_foundry_core import greet
from aignostics_foundry_core.health import Health, HealthStatus

message = greet("World")
print(message) # Output: Hello, World!
health = Health(status=HealthStatus.UP)
```

## Further Reading
Expand Down
20 changes: 20 additions & 0 deletions docs/decisions/0001-record-architecture-decisions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# 1. Record architecture decisions

Date: 2026-03-24

## Status

Accepted

## Context

We need to record the architectural decisions made on this project.

## Decision

We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
We will use `adr-tools` to manage our ADRs, and we will store them in the `docs/decisions` directory.

## Consequences

See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).
53 changes: 53 additions & 0 deletions docs/decisions/0002-module-structure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# 2. Module structure

Date: 2026-03-24

## Status

Accepted

## Context

We need to decide how to structure the internal modules of `aignostics_foundry_core`. Three options were considered:

**#1 Private modules with package-level exports**
```
aignostics_foundry_core/
├── __init__.py # exposes Health class
└── _health.py # contains Health class
```
Import: `from aignostics_foundry_core import Health`
Pros: matches Bridge/Python SDK conventions.
Cons: top-level `__init__.py` exports grow very long; hard to know which submodule an object comes from.

**#2 Public modules**
```
aignostics_foundry_core/
├── __init__.py
└── health.py # contains and exposes Health class
```
Import: `from aignostics_foundry_core.health import Health`
Pros: simple; can be migrated to #3 without breaking imports if needed.
Cons: modules cannot hide implementation details; everything in a module is public.

**#3 Public modules with module-level exports**
```
aignostics_foundry_core/
├── __init__.py
└── health/
├── __init__.py # exposes Health class
└── _health.py # contains Health class
```
Import: `from aignostics_foundry_core.health import Health`
Pros: modules can control what they advertise.
Cons: overhead (one directory + one file per module); migration from #2 is non-breaking if needed.

## Decision

We will use **#2 (public modules)**. Each concept lives in a single public module file, and is imported directly from that module.

## Consequences

- Module structure is simple and easy to navigate.
- All symbols in a module file are implicitly public; internal helpers should be prefixed with `_` by convention.
- If a module later needs to hide implementation details (e.g. a complex subpackage), it can be migrated to option #3 without breaking existing imports, since the import path `from aignostics_foundry_core.health import Health` is stable across both structures.
1 change: 1 addition & 0 deletions docs/decisions/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
To document a decision: `adr new "My decision title".`
76 changes: 76 additions & 0 deletions mise.lock
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,18 @@ backend = "aqua:nektos/act"
checksum = "sha256:116c7f27c4862fb01730c956c9bc9f51f9d44d8f3850fe6166b7da9f68677a5c"
url = "https://github.com/nektos/act/releases/download/v0.2.84/act_Linux_arm64.tar.gz"

[tools.act."platforms.linux-arm64-musl"]
checksum = "sha256:116c7f27c4862fb01730c956c9bc9f51f9d44d8f3850fe6166b7da9f68677a5c"
url = "https://github.com/nektos/act/releases/download/v0.2.84/act_Linux_arm64.tar.gz"

[tools.act."platforms.linux-x64"]
checksum = "sha256:19d4525fb0d80ff50bd3252d3fa47ee1265a331fe4c39249ac65347e527e16e2"
url = "https://github.com/nektos/act/releases/download/v0.2.84/act_Linux_x86_64.tar.gz"

[tools.act."platforms.linux-x64-musl"]
checksum = "sha256:19d4525fb0d80ff50bd3252d3fa47ee1265a331fe4c39249ac65347e527e16e2"
url = "https://github.com/nektos/act/releases/download/v0.2.84/act_Linux_x86_64.tar.gz"

[tools.act."platforms.macos-arm64"]
checksum = "sha256:6739345c2bf7bbd1a3ceaf6503a9ffbe98b33dd3789edce39e8c844c6b49036b"
url = "https://github.com/nektos/act/releases/download/v0.2.84/act_Darwin_arm64.tar.gz"
Expand All @@ -24,6 +32,32 @@ url = "https://github.com/nektos/act/releases/download/v0.2.84/act_Darwin_x86_64
checksum = "sha256:3b4fcf9497d1f23afbdd40bfa8e78e154d69754da73c2d792a4152b4f8ae5c96"
url = "https://github.com/nektos/act/releases/download/v0.2.84/act_Windows_x86_64.zip"

[[tools.adr-tools]]
version = "3.0.0"
backend = "aqua:npryce/adr-tools"

[tools.adr-tools."platforms.linux-arm64"]
url = "https://github.com/npryce/adr-tools/archive/refs/tags/3.0.0.tar.gz"

[tools.adr-tools."platforms.linux-arm64-musl"]
url = "https://github.com/npryce/adr-tools/archive/refs/tags/3.0.0.tar.gz"

[tools.adr-tools."platforms.linux-x64"]
url = "https://github.com/npryce/adr-tools/archive/refs/tags/3.0.0.tar.gz"

[tools.adr-tools."platforms.linux-x64-musl"]
url = "https://github.com/npryce/adr-tools/archive/refs/tags/3.0.0.tar.gz"

[tools.adr-tools."platforms.macos-arm64"]
checksum = "blake3:1b011324e104b8957270f29fde38aae5f80a8131f7854c521c8f237233ea4d2b"
url = "https://github.com/npryce/adr-tools/archive/refs/tags/3.0.0.tar.gz"

[tools.adr-tools."platforms.macos-x64"]
url = "https://github.com/npryce/adr-tools/archive/refs/tags/3.0.0.tar.gz"

[tools.adr-tools."platforms.windows-x64"]
url = "https://github.com/npryce/adr-tools/archive/refs/tags/3.0.0.tar.gz"

[[tools.gh]]
version = "2.87.3"
backend = "aqua:cli/cli"
Expand All @@ -32,10 +66,18 @@ backend = "aqua:cli/cli"
checksum = "sha256:5f5d89563bf26751e2173b37e594065504e85b6b781c1f1832d24bf2c2b4554f"
url = "https://github.com/cli/cli/releases/download/v2.87.3/gh_2.87.3_linux_arm64.tar.gz"

[tools.gh."platforms.linux-arm64-musl"]
checksum = "sha256:5f5d89563bf26751e2173b37e594065504e85b6b781c1f1832d24bf2c2b4554f"
url = "https://github.com/cli/cli/releases/download/v2.87.3/gh_2.87.3_linux_arm64.tar.gz"

[tools.gh."platforms.linux-x64"]
checksum = "sha256:c6e5537631fca45f277ef405ce8751d139b491e9402cc20891a003525a8773b2"
url = "https://github.com/cli/cli/releases/download/v2.87.3/gh_2.87.3_linux_amd64.tar.gz"

[tools.gh."platforms.linux-x64-musl"]
checksum = "sha256:c6e5537631fca45f277ef405ce8751d139b491e9402cc20891a003525a8773b2"
url = "https://github.com/cli/cli/releases/download/v2.87.3/gh_2.87.3_linux_amd64.tar.gz"

[tools.gh."platforms.macos-arm64"]
checksum = "sha256:dedfc6f569e9dbc5b92d47dce44acadbdf5b6b7a861510db0c748dfac55002f6"
url = "https://github.com/cli/cli/releases/download/v2.87.3/gh_2.87.3_macOS_arm64.zip"
Expand All @@ -56,10 +98,18 @@ backend = "aqua:jqlang/jq"
checksum = "sha256:6bc62f25981328edd3cfcfe6fe51b073f2d7e7710d7ef7fcdac28d4e384fc3d4"
url = "https://github.com/jqlang/jq/releases/download/jq-1.8.1/jq-linux-arm64"

[tools.jq."platforms.linux-arm64-musl"]
checksum = "sha256:6bc62f25981328edd3cfcfe6fe51b073f2d7e7710d7ef7fcdac28d4e384fc3d4"
url = "https://github.com/jqlang/jq/releases/download/jq-1.8.1/jq-linux-arm64"

[tools.jq."platforms.linux-x64"]
checksum = "sha256:020468de7539ce70ef1bceaf7cde2e8c4f2ca6c3afb84642aabc5c97d9fc2a0d"
url = "https://github.com/jqlang/jq/releases/download/jq-1.8.1/jq-linux-amd64"

[tools.jq."platforms.linux-x64-musl"]
checksum = "sha256:020468de7539ce70ef1bceaf7cde2e8c4f2ca6c3afb84642aabc5c97d9fc2a0d"
url = "https://github.com/jqlang/jq/releases/download/jq-1.8.1/jq-linux-amd64"

[tools.jq."platforms.macos-arm64"]
checksum = "sha256:a9fe3ea2f86dfc72f6728417521ec9067b343277152b114f4e98d8cb0e263603"
url = "https://github.com/jqlang/jq/releases/download/jq-1.8.1/jq-macos-arm64"
Expand Down Expand Up @@ -87,10 +137,18 @@ backend = "core:python"
checksum = "sha256:c4a5cc7681da3ed2066194f6fac24207a764db38f23fc5a2b1b56671ee3142d6"
url = "https://github.com/astral-sh/python-build-standalone/releases/download/20260320/cpython-3.14.3+20260320-aarch64-unknown-linux-gnu-install_only_stripped.tar.gz"

[tools.python."platforms.linux-arm64-musl"]
checksum = "sha256:c4a5cc7681da3ed2066194f6fac24207a764db38f23fc5a2b1b56671ee3142d6"
url = "https://github.com/astral-sh/python-build-standalone/releases/download/20260320/cpython-3.14.3+20260320-aarch64-unknown-linux-gnu-install_only_stripped.tar.gz"

[tools.python."platforms.linux-x64"]
checksum = "sha256:bc35984c271adb7b0d2f730eced89fbbb96246c4d716c415e4af7ed686627831"
url = "https://github.com/astral-sh/python-build-standalone/releases/download/20260320/cpython-3.14.3+20260320-x86_64-unknown-linux-gnu-install_only_stripped.tar.gz"

[tools.python."platforms.linux-x64-musl"]
checksum = "sha256:bc35984c271adb7b0d2f730eced89fbbb96246c4d716c415e4af7ed686627831"
url = "https://github.com/astral-sh/python-build-standalone/releases/download/20260320/cpython-3.14.3+20260320-x86_64-unknown-linux-gnu-install_only_stripped.tar.gz"

[tools.python."platforms.macos-arm64"]
checksum = "sha256:f9b4a94d2d62ca77e08873b861b8cd989eda922ad3c3eafd2dfad57375e6ae61"
url = "https://github.com/astral-sh/python-build-standalone/releases/download/20260320/cpython-3.14.3+20260320-aarch64-apple-darwin-install_only_stripped.tar.gz"
Expand All @@ -112,11 +170,21 @@ checksum = "sha256:7e3924a974e912e57b4a99f65ece7931f8079584dae12eb7845024f97087b
url = "https://github.com/aquasecurity/trivy/releases/download/v0.69.3/trivy_0.69.3_Linux-ARM64.tar.gz"
provenance = "cosign"

[tools.trivy."platforms.linux-arm64-musl"]
checksum = "sha256:7e3924a974e912e57b4a99f65ece7931f8079584dae12eb7845024f97087bdfd"
url = "https://github.com/aquasecurity/trivy/releases/download/v0.69.3/trivy_0.69.3_Linux-ARM64.tar.gz"
provenance = "cosign"

[tools.trivy."platforms.linux-x64"]
checksum = "sha256:1816b632dfe529869c740c0913e36bd1629cb7688bd5634f4a858c1d57c88b75"
url = "https://github.com/aquasecurity/trivy/releases/download/v0.69.3/trivy_0.69.3_Linux-64bit.tar.gz"
provenance = "cosign"

[tools.trivy."platforms.linux-x64-musl"]
checksum = "sha256:1816b632dfe529869c740c0913e36bd1629cb7688bd5634f4a858c1d57c88b75"
url = "https://github.com/aquasecurity/trivy/releases/download/v0.69.3/trivy_0.69.3_Linux-64bit.tar.gz"
provenance = "cosign"

[tools.trivy."platforms.macos-arm64"]
checksum = "sha256:a2f2179afd4f8bb265ca3c7aefb56a666bc4a9a411663bc0f22c3549fbc643a5"
url = "https://github.com/aquasecurity/trivy/releases/download/v0.69.3/trivy_0.69.3_macOS-ARM64.tar.gz"
Expand All @@ -140,10 +208,18 @@ backend = "aqua:astral-sh/uv"
checksum = "sha256:685e47f8f88b6845a9fc2ca27c3d246c0f53af8c017daf8e98ac0a97fe20365b"
url = "https://github.com/astral-sh/uv/releases/download/0.10.2/uv-aarch64-unknown-linux-musl.tar.gz"

[tools.uv."platforms.linux-arm64-musl"]
checksum = "sha256:685e47f8f88b6845a9fc2ca27c3d246c0f53af8c017daf8e98ac0a97fe20365b"
url = "https://github.com/astral-sh/uv/releases/download/0.10.2/uv-aarch64-unknown-linux-musl.tar.gz"

[tools.uv."platforms.linux-x64"]
checksum = "sha256:c162182ba7dd692794362d76dd183990d6e51553217954106da19bdb6ced211b"
url = "https://github.com/astral-sh/uv/releases/download/0.10.2/uv-x86_64-unknown-linux-musl.tar.gz"

[tools.uv."platforms.linux-x64-musl"]
checksum = "sha256:c162182ba7dd692794362d76dd183990d6e51553217954106da19bdb6ced211b"
url = "https://github.com/astral-sh/uv/releases/download/0.10.2/uv-x86_64-unknown-linux-musl.tar.gz"

[tools.uv."platforms.macos-arm64"]
checksum = "sha256:3828b2de196687f60e9d199aea8b504299629300831eea0935ff3fe339903d0a"
url = "https://github.com/astral-sh/uv/releases/download/0.10.2/uv-aarch64-apple-darwin.tar.gz"
Expand Down
Loading
Loading