ottu 0.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- ottu-0.0.0/.github/CODEOWNERS +3 -0
- ottu-0.0.0/.github/workflows/codespell.yml +26 -0
- ottu-0.0.0/.github/workflows/commit-check.yml +57 -0
- ottu-0.0.0/.github/workflows/docs.yml +32 -0
- ottu-0.0.0/.github/workflows/format-check.yml +32 -0
- ottu-0.0.0/.github/workflows/links-check.yml +15 -0
- ottu-0.0.0/.github/workflows/lint.yml +34 -0
- ottu-0.0.0/.github/workflows/publish.yml +47 -0
- ottu-0.0.0/.github/workflows/tests.yml +58 -0
- ottu-0.0.0/.gitignore +25 -0
- ottu-0.0.0/.lycheeignore +5 -0
- ottu-0.0.0/.pre-commit-config.yaml +21 -0
- ottu-0.0.0/.readthedocs.yaml +22 -0
- ottu-0.0.0/CODE_OF_CONDUCT.md +89 -0
- ottu-0.0.0/CONTRIBUTING.md +8 -0
- ottu-0.0.0/LICENSE +23 -0
- ottu-0.0.0/PKG-INFO +39 -0
- ottu-0.0.0/README.md +7 -0
- ottu-0.0.0/SECURITY.md +52 -0
- ottu-0.0.0/commitlint.config.js +40 -0
- ottu-0.0.0/coverage.xml +38 -0
- ottu-0.0.0/docs/Makefile +18 -0
- ottu-0.0.0/docs/ci.rst +121 -0
- ottu-0.0.0/docs/conf.py +22 -0
- ottu-0.0.0/docs/contributing.rst +18 -0
- ottu-0.0.0/docs/conventions.rst +136 -0
- ottu-0.0.0/docs/dev-setup.rst +131 -0
- ottu-0.0.0/docs/index.rst +18 -0
- ottu-0.0.0/docs/use-cases.md +1171 -0
- ottu-0.0.0/ottu/__init__.py +10 -0
- ottu-0.0.0/ottu/_version.py +24 -0
- ottu-0.0.0/ottu/cli.py +21 -0
- ottu-0.0.0/pyproject.toml +110 -0
- ottu-0.0.0/tests/test_cli.py +48 -0
- ottu-0.0.0/uv.lock +1816 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
name: Codespell
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
pull_request:
|
|
6
|
+
|
|
7
|
+
jobs:
|
|
8
|
+
codespell:
|
|
9
|
+
runs-on: ubuntu-latest
|
|
10
|
+
|
|
11
|
+
steps:
|
|
12
|
+
- uses: actions/checkout@v4
|
|
13
|
+
|
|
14
|
+
- name: Install uv
|
|
15
|
+
uses: astral-sh/setup-uv@v2
|
|
16
|
+
with:
|
|
17
|
+
enable-cache: true
|
|
18
|
+
|
|
19
|
+
- name: Set up Python
|
|
20
|
+
run: uv python install 3.11
|
|
21
|
+
|
|
22
|
+
- name: Install dependencies
|
|
23
|
+
run: uv sync --all-extras
|
|
24
|
+
|
|
25
|
+
- name: Check spelling with codespell
|
|
26
|
+
run: uv run codespell
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
name: Commit check
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
pull_request:
|
|
5
|
+
push:
|
|
6
|
+
|
|
7
|
+
jobs:
|
|
8
|
+
commitlint:
|
|
9
|
+
runs-on: ubuntu-latest
|
|
10
|
+
steps:
|
|
11
|
+
- name: Check out repository
|
|
12
|
+
uses: actions/checkout@v7
|
|
13
|
+
with:
|
|
14
|
+
fetch-depth: 100
|
|
15
|
+
|
|
16
|
+
- name: Set up Node.js
|
|
17
|
+
uses: actions/setup-node@v7
|
|
18
|
+
|
|
19
|
+
- name: Install commitlint
|
|
20
|
+
run: |
|
|
21
|
+
npm install --save-dev @commitlint/cli @commitlint/config-conventional
|
|
22
|
+
|
|
23
|
+
- name: Compute commit range
|
|
24
|
+
id: range
|
|
25
|
+
shell: bash
|
|
26
|
+
run: |
|
|
27
|
+
if [ "${{ github.event_name }}" = "pull_request" ]; then
|
|
28
|
+
# For pull requests, GitHub checks out a synthetic merge commit whose
|
|
29
|
+
# parents are the base branch and the PR branch. We use their merge-base
|
|
30
|
+
# as the start of the valid range, so only commits introduced by the PR
|
|
31
|
+
# are checked.
|
|
32
|
+
git merge-base HEAD^1 HEAD^2 || git fetch --unshallow origin
|
|
33
|
+
FROM=$(git merge-base HEAD^1 HEAD^2)
|
|
34
|
+
TO=$(git rev-parse HEAD^2)
|
|
35
|
+
else
|
|
36
|
+
# For direct pushes, prefer the previous SHA when it is still in the
|
|
37
|
+
# current ancestry. After a rebase or force-push, the old SHA can be
|
|
38
|
+
# stale, so fall back to the merge-base with the parent branch and then
|
|
39
|
+
# to HEAD~1 as a last resort.
|
|
40
|
+
FROM="${{ github.event.before }}"
|
|
41
|
+
if ! git rev-parse --verify "$FROM" >/dev/null 2>&1 || ! git merge-base --is-ancestor "$FROM" HEAD >/dev/null 2>&1; then
|
|
42
|
+
FROM=$(git merge-base HEAD origin/main 2>/dev/null || git rev-parse HEAD~1)
|
|
43
|
+
fi
|
|
44
|
+
TO="${{ github.sha }}"
|
|
45
|
+
fi
|
|
46
|
+
|
|
47
|
+
echo "from=${FROM}" >> "$GITHUB_OUTPUT"
|
|
48
|
+
echo "to=${TO}" >> "$GITHUB_OUTPUT"
|
|
49
|
+
|
|
50
|
+
- name: Validate commit messages
|
|
51
|
+
shell: bash
|
|
52
|
+
run: |
|
|
53
|
+
echo "Checking commits between ${{ steps.range.outputs.from }} and ${{ steps.range.outputs.to }}..."
|
|
54
|
+
npx commitlint \
|
|
55
|
+
--from="${{ steps.range.outputs.from }}" \
|
|
56
|
+
--to="${{ steps.range.outputs.to }}" \
|
|
57
|
+
--config commitlint.config.js
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
name: Build docs
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
pull_request:
|
|
6
|
+
paths:
|
|
7
|
+
- docs/**
|
|
8
|
+
|
|
9
|
+
concurrency:
|
|
10
|
+
group: ${{ github.workflow }}-${{ github.ref }}
|
|
11
|
+
cancel-in-progress: true
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
build:
|
|
15
|
+
runs-on: ubuntu-latest
|
|
16
|
+
|
|
17
|
+
steps:
|
|
18
|
+
- uses: actions/checkout@v7
|
|
19
|
+
|
|
20
|
+
- name: Install uv
|
|
21
|
+
uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
|
|
22
|
+
with:
|
|
23
|
+
enable-cache: true
|
|
24
|
+
|
|
25
|
+
- name: Set up Python
|
|
26
|
+
run: uv python install 3.13
|
|
27
|
+
|
|
28
|
+
- name: Install docs dependencies with uv
|
|
29
|
+
run: uv sync --only-group docs --no-install-project
|
|
30
|
+
|
|
31
|
+
- name: Build docs
|
|
32
|
+
run: uv run -- make -C docs html
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
name: Format check
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push: &paths
|
|
5
|
+
paths:
|
|
6
|
+
- '.github/workflows/**'
|
|
7
|
+
- 'ottu/**/*.py'
|
|
8
|
+
- 'tests/**/*.py'
|
|
9
|
+
- '*.toml'
|
|
10
|
+
pull_request: *paths
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
format:
|
|
15
|
+
runs-on: ubuntu-latest
|
|
16
|
+
|
|
17
|
+
steps:
|
|
18
|
+
- uses: actions/checkout@v7
|
|
19
|
+
|
|
20
|
+
- name: Install uv
|
|
21
|
+
uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
|
|
22
|
+
with:
|
|
23
|
+
enable-cache: true
|
|
24
|
+
|
|
25
|
+
- name: Set up Python
|
|
26
|
+
run: uv python install 3.11
|
|
27
|
+
|
|
28
|
+
- name: Install dependencies
|
|
29
|
+
run: uv sync --all-extras
|
|
30
|
+
|
|
31
|
+
- name: Format check with Ruff
|
|
32
|
+
run: uv run ruff format --check --diff
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
name: Links check
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
workflow_dispatch:
|
|
5
|
+
push:
|
|
6
|
+
branches:
|
|
7
|
+
- main
|
|
8
|
+
tags:
|
|
9
|
+
- '*'
|
|
10
|
+
schedule:
|
|
11
|
+
- cron: '30 3 * * 4' # Run every Thursday at 3:30 AM UTC
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
linkChecker:
|
|
15
|
+
uses: Infineon/makers-devops/.github/workflows/check_links.yml@main
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
name: Lint
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push: &paths
|
|
5
|
+
paths:
|
|
6
|
+
- '.github/workflows/**'
|
|
7
|
+
- 'ottu/**/*.py'
|
|
8
|
+
- 'tests/**/*.py'
|
|
9
|
+
- '*.toml'
|
|
10
|
+
pull_request: *paths
|
|
11
|
+
|
|
12
|
+
jobs:
|
|
13
|
+
lint:
|
|
14
|
+
runs-on: ubuntu-latest
|
|
15
|
+
|
|
16
|
+
steps:
|
|
17
|
+
- uses: actions/checkout@v7
|
|
18
|
+
|
|
19
|
+
- name: Install uv
|
|
20
|
+
uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
|
|
21
|
+
with:
|
|
22
|
+
enable-cache: true
|
|
23
|
+
|
|
24
|
+
- name: Set up Python
|
|
25
|
+
run: uv python install 3.11
|
|
26
|
+
|
|
27
|
+
- name: Install dependencies
|
|
28
|
+
run: uv sync --all-extras
|
|
29
|
+
|
|
30
|
+
- name: Lint with Ruff
|
|
31
|
+
run: uv run ruff check --output-format=github
|
|
32
|
+
|
|
33
|
+
- name: Type check with mypy
|
|
34
|
+
run: uv run mypy --show-error-codes --pretty
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
name: Publish
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
tags:
|
|
6
|
+
- "[0-9]+.[0-9]+.[0-9]*"
|
|
7
|
+
|
|
8
|
+
permissions:
|
|
9
|
+
contents: read
|
|
10
|
+
id-token: write
|
|
11
|
+
|
|
12
|
+
jobs:
|
|
13
|
+
publish:
|
|
14
|
+
runs-on: ubuntu-latest
|
|
15
|
+
environment:
|
|
16
|
+
name: pypi
|
|
17
|
+
url: https://pypi.org/project/ottu/
|
|
18
|
+
|
|
19
|
+
steps:
|
|
20
|
+
- uses: actions/checkout@v7
|
|
21
|
+
|
|
22
|
+
- name: Install uv
|
|
23
|
+
uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
|
|
24
|
+
|
|
25
|
+
- name: Set up Python
|
|
26
|
+
run: uv python install 3.11
|
|
27
|
+
|
|
28
|
+
- name: Install dependencies
|
|
29
|
+
run: uv sync --all-extras
|
|
30
|
+
|
|
31
|
+
- name: Format check
|
|
32
|
+
run: uv run ruff format --check
|
|
33
|
+
|
|
34
|
+
- name: Lint
|
|
35
|
+
run: uv run ruff check
|
|
36
|
+
|
|
37
|
+
- name: Type check
|
|
38
|
+
run: uv run mypy
|
|
39
|
+
|
|
40
|
+
- name: Run tests
|
|
41
|
+
run: uv run pytest
|
|
42
|
+
|
|
43
|
+
- name: Build distribution
|
|
44
|
+
run: uv build
|
|
45
|
+
|
|
46
|
+
- name: Publish to PyPI
|
|
47
|
+
run: uv publish
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
name: Tests
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push: &paths
|
|
5
|
+
paths:
|
|
6
|
+
- '.github/workflows/**'
|
|
7
|
+
- 'ottu/**/*.py'
|
|
8
|
+
- 'tests/**/*.py'
|
|
9
|
+
- '*.toml'
|
|
10
|
+
pull_request: *paths
|
|
11
|
+
|
|
12
|
+
permissions:
|
|
13
|
+
contents: read
|
|
14
|
+
pull-requests: write
|
|
15
|
+
|
|
16
|
+
jobs:
|
|
17
|
+
test:
|
|
18
|
+
runs-on: ubuntu-latest
|
|
19
|
+
strategy:
|
|
20
|
+
matrix:
|
|
21
|
+
python-version: ["3.10", "3.11", "3.12"]
|
|
22
|
+
|
|
23
|
+
steps:
|
|
24
|
+
- uses: actions/checkout@v7
|
|
25
|
+
|
|
26
|
+
- name: Install uv
|
|
27
|
+
uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
|
|
28
|
+
with:
|
|
29
|
+
enable-cache: true
|
|
30
|
+
|
|
31
|
+
- name: Set up Python ${{ matrix.python-version }}
|
|
32
|
+
run: uv python install ${{ matrix.python-version }}
|
|
33
|
+
|
|
34
|
+
- name: Install dependencies
|
|
35
|
+
run: uv sync --all-extras --python ${{ matrix.python-version }}
|
|
36
|
+
|
|
37
|
+
- name: Run tests with pytest
|
|
38
|
+
run: uv run --python ${{ matrix.python-version }} pytest
|
|
39
|
+
|
|
40
|
+
- name: Upload coverage
|
|
41
|
+
if: matrix.python-version == '3.12'
|
|
42
|
+
uses: coverallsapp/github-action@v2
|
|
43
|
+
with:
|
|
44
|
+
file: ./coverage.xml
|
|
45
|
+
format: cobertura
|
|
46
|
+
github-token: ${{ secrets.GITHUB_TOKEN }}
|
|
47
|
+
|
|
48
|
+
- name: Coverage Summary Report
|
|
49
|
+
if: matrix.python-version == '3.12'
|
|
50
|
+
run: |
|
|
51
|
+
echo "📊 [🔗 Coveralls Report](https://coveralls.io/builds/${{ github.sha }})" >> $GITHUB_STEP_SUMMARY
|
|
52
|
+
|
|
53
|
+
- name: Coverage Comment on PR
|
|
54
|
+
uses: orgoro/coverage@v3.2
|
|
55
|
+
if: matrix.python-version == '3.12' && github.event_name == 'pull_request'
|
|
56
|
+
with:
|
|
57
|
+
coverageFile: ./coverage.xml
|
|
58
|
+
token: ${{ secrets.GITHUB_TOKEN }}
|
ottu-0.0.0/.gitignore
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
*.pyc
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.egg-info/
|
|
4
|
+
dist/
|
|
5
|
+
build/
|
|
6
|
+
.eggs/
|
|
7
|
+
.pytest_cache/
|
|
8
|
+
.coverage
|
|
9
|
+
htmlcov/
|
|
10
|
+
.mypy_cache/
|
|
11
|
+
ottu/_version.py
|
|
12
|
+
*.bak
|
|
13
|
+
.ruff_cache/
|
|
14
|
+
.venv/
|
|
15
|
+
venv/
|
|
16
|
+
env/
|
|
17
|
+
.idea/
|
|
18
|
+
.vscode/
|
|
19
|
+
*.swp
|
|
20
|
+
*.swo
|
|
21
|
+
*~
|
|
22
|
+
.DS_Store
|
|
23
|
+
.env
|
|
24
|
+
.env.local
|
|
25
|
+
*.log
|
ottu-0.0.0/.lycheeignore
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Ignore local development and loopback URLs used in docs examples.
|
|
2
|
+
^https?://(localhost|127\.0\.0\.1|0\.0\.0\.0|\[::1\]|10\.\d{1,3}\.\d{1,3}\.\d{1,3}|172\.(1[6-9]|2\d|3[01])\.\d{1,3}\.\d{1,3}|192\.168\.\d{1,3}\.\d{1,3})(:\d+)?/?$
|
|
3
|
+
|
|
4
|
+
# npmjs.com is treated as a known 403 by the upstream service; ignore it in docs checks.
|
|
5
|
+
^https://www\.npmjs\.com/?$
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
repos:
|
|
2
|
+
- repo: local
|
|
3
|
+
hooks:
|
|
4
|
+
- id: commitlint
|
|
5
|
+
name: commitlint
|
|
6
|
+
entry: npx --yes @commitlint/cli --config commitlint.config.js --edit
|
|
7
|
+
language: system
|
|
8
|
+
stages: [commit-msg]
|
|
9
|
+
pass_filenames: true
|
|
10
|
+
- repo: https://github.com/astral-sh/ruff-pre-commit
|
|
11
|
+
rev: v0.16.3
|
|
12
|
+
hooks:
|
|
13
|
+
- id: ruff
|
|
14
|
+
args: [--fix]
|
|
15
|
+
- id: ruff-format
|
|
16
|
+
- repo: https://github.com/codespell-project/codespell
|
|
17
|
+
rev: v2.4.3
|
|
18
|
+
hooks:
|
|
19
|
+
- id: codespell
|
|
20
|
+
name: codespell
|
|
21
|
+
args: ["--toml=pyproject.toml"]
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Read the Docs configuration file
|
|
2
|
+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
3
|
+
|
|
4
|
+
# Required
|
|
5
|
+
version: 2
|
|
6
|
+
|
|
7
|
+
# Set the OS, Python version, and other tools you might need
|
|
8
|
+
build:
|
|
9
|
+
os: ubuntu-24.04
|
|
10
|
+
tools:
|
|
11
|
+
python: "3.13"
|
|
12
|
+
|
|
13
|
+
python:
|
|
14
|
+
install:
|
|
15
|
+
- method: uv
|
|
16
|
+
command: sync
|
|
17
|
+
groups:
|
|
18
|
+
- docs
|
|
19
|
+
|
|
20
|
+
# Build documentation in the "docs/" directory with Sphinx
|
|
21
|
+
sphinx:
|
|
22
|
+
configuration: docs/conf.py
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
# Contributor Covenant 3.0 Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We pledge to make our community welcoming, safe, and equitable for all.
|
|
6
|
+
|
|
7
|
+
We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
## Encouraged Behaviors
|
|
11
|
+
|
|
12
|
+
While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
|
|
13
|
+
|
|
14
|
+
With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
|
|
15
|
+
|
|
16
|
+
1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
|
|
17
|
+
2. Engaging **kindly and honestly** with others.
|
|
18
|
+
3. Respecting **different viewpoints** and experiences.
|
|
19
|
+
4. **Taking responsibility** for our actions and contributions.
|
|
20
|
+
5. Gracefully giving and accepting **constructive feedback**.
|
|
21
|
+
6. Committing to **repairing harm** when it occurs.
|
|
22
|
+
7. Behaving in other ways that promote and sustain the **well-being of our community**.
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
## Restricted Behaviors
|
|
26
|
+
|
|
27
|
+
We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
|
|
28
|
+
|
|
29
|
+
1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
|
|
30
|
+
2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
|
|
31
|
+
3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
|
|
32
|
+
4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
|
|
33
|
+
5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
|
|
34
|
+
6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
|
|
35
|
+
7. Behaving in other ways that **threaten the well-being** of our community.
|
|
36
|
+
|
|
37
|
+
### Other Restrictions
|
|
38
|
+
|
|
39
|
+
1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
|
|
40
|
+
2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
|
|
41
|
+
3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
|
|
42
|
+
4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
## Reporting an Issue
|
|
46
|
+
|
|
47
|
+
Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
|
|
48
|
+
|
|
49
|
+
When an incident does occur, it is important to report it promptly. To report a possible violation, contact the project team at maker@infineon.com.
|
|
50
|
+
|
|
51
|
+
Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
## Addressing and Repairing Harm
|
|
55
|
+
|
|
56
|
+
If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
|
|
57
|
+
|
|
58
|
+
1) Warning
|
|
59
|
+
1) Event: A violation involving a single incident or series of incidents.
|
|
60
|
+
2) Consequence: A private, written warning from the Community Moderators.
|
|
61
|
+
3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
|
|
62
|
+
2) Temporarily Limited Activities
|
|
63
|
+
1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
|
|
64
|
+
2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
|
|
65
|
+
3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
|
|
66
|
+
3) Temporary Suspension
|
|
67
|
+
1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
|
|
68
|
+
2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
|
|
69
|
+
3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
|
|
70
|
+
4) Permanent Ban
|
|
71
|
+
1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
|
|
72
|
+
2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
|
|
73
|
+
3) Repair: There is no possible repair in cases of this severity.
|
|
74
|
+
|
|
75
|
+
This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
## Scope
|
|
79
|
+
|
|
80
|
+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
## Attribution
|
|
84
|
+
|
|
85
|
+
This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
|
|
86
|
+
|
|
87
|
+
Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)
|
|
88
|
+
|
|
89
|
+
For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion).
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
The contribution guide for this project is maintained in the documentation on
|
|
4
|
+
Read the Docs:
|
|
5
|
+
|
|
6
|
+
- https://ottu.readthedocs.io/en/latest/contributing.html
|
|
7
|
+
|
|
8
|
+
Please refer to that page for contribution steps, development setup, and followed conventions.
|
ottu-0.0.0/LICENSE
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# License
|
|
2
|
+
|
|
3
|
+
MIT License
|
|
4
|
+
|
|
5
|
+
Copyright (c) 2026 Infineon Technologies AG
|
|
6
|
+
|
|
7
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
8
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
9
|
+
in the Software without restriction, including without limitation the rights
|
|
10
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
11
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
12
|
+
furnished to do so, subject to the following conditions:
|
|
13
|
+
|
|
14
|
+
The above copyright notice and this permission notice shall be included in all
|
|
15
|
+
copies or substantial portions of the Software.
|
|
16
|
+
|
|
17
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
18
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
19
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
20
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
21
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
22
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
23
|
+
SOFTWARE.
|
ottu-0.0.0/PKG-INFO
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: ottu
|
|
3
|
+
Version: 0.0.0
|
|
4
|
+
Summary: CLI tool for embedded on-target testing
|
|
5
|
+
Author-email: Infineon Technologies AG <maker@infineon.com>
|
|
6
|
+
License: MIT
|
|
7
|
+
License-File: LICENSE
|
|
8
|
+
Keywords: cli,embedded,on-target,testing
|
|
9
|
+
Classifier: Development Status :: 3 - Alpha
|
|
10
|
+
Classifier: Environment :: Console
|
|
11
|
+
Classifier: Intended Audience :: Developers
|
|
12
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
13
|
+
Classifier: Operating System :: OS Independent
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: Topic :: Software Development :: Testing
|
|
19
|
+
Requires-Python: >=3.10
|
|
20
|
+
Requires-Dist: click>=8.0.0
|
|
21
|
+
Provides-Extra: dev
|
|
22
|
+
Requires-Dist: codespell>=2.4.3; extra == 'dev'
|
|
23
|
+
Requires-Dist: mypy>=2.3.1; extra == 'dev'
|
|
24
|
+
Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
|
|
25
|
+
Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
|
|
26
|
+
Requires-Dist: pytest>=7.0.0; extra == 'dev'
|
|
27
|
+
Requires-Dist: ruff>=0.16.3; extra == 'dev'
|
|
28
|
+
Provides-Extra: docs
|
|
29
|
+
Requires-Dist: sphinx-rtd-theme>=3.0.2; extra == 'docs'
|
|
30
|
+
Requires-Dist: sphinx<9.0,>=8.0; extra == 'docs'
|
|
31
|
+
Description-Content-Type: text/markdown
|
|
32
|
+
|
|
33
|
+
# ottu
|
|
34
|
+
|
|
35
|
+
ottu (On-Target Testing Utility) is a CLI tool for on-target testing of embedded devices.
|
|
36
|
+
|
|
37
|
+
> [!WARNING]
|
|
38
|
+
> This repository is currently under development and is not yet ready for use.
|
|
39
|
+
|
ottu-0.0.0/README.md
ADDED
ottu-0.0.0/SECURITY.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
## Supported Versions
|
|
4
|
+
|
|
5
|
+
The project maintainers will review security reports for the versions currently
|
|
6
|
+
under active development. Please check the repository's release status and use
|
|
7
|
+
current mainline code for reporting issues.
|
|
8
|
+
|
|
9
|
+
| Version | Supported |
|
|
10
|
+
| ------- | --------- |
|
|
11
|
+
| main / latest | Yes |
|
|
12
|
+
| older released versions | Not guaranteed |
|
|
13
|
+
|
|
14
|
+
## Reporting a Vulnerability
|
|
15
|
+
|
|
16
|
+
If you believe you have found a security vulnerability in this project, please
|
|
17
|
+
report it privately and responsibly.
|
|
18
|
+
|
|
19
|
+
Please email the maintainers at: maker@infineon.com
|
|
20
|
+
|
|
21
|
+
When reporting, include:
|
|
22
|
+
|
|
23
|
+
- a clear description of the vulnerability
|
|
24
|
+
- affected version or branch
|
|
25
|
+
- steps to reproduce the issue
|
|
26
|
+
- the impact and risk assessment
|
|
27
|
+
- any proposed fix or mitigation
|
|
28
|
+
|
|
29
|
+
Please do not open a public GitHub issue for security problems until the issue has
|
|
30
|
+
been triaged and a fix or mitigation is available.
|
|
31
|
+
|
|
32
|
+
## Response Expectations
|
|
33
|
+
|
|
34
|
+
We will make every effort to acknowledge your report promptly and to work with
|
|
35
|
+
you to understand and remediate the issue. We ask for reasonable time to assess
|
|
36
|
+
and address the report before public disclosure.
|
|
37
|
+
|
|
38
|
+
## Disclosure Policy
|
|
39
|
+
|
|
40
|
+
We follow a coordinated disclosure process. Once a fix is available, we may
|
|
41
|
+
publish a security advisory or release notes describing the issue and the
|
|
42
|
+
mitigation, while keeping sensitive details limited to the minimum necessary.
|
|
43
|
+
|
|
44
|
+
## Security Best Practices
|
|
45
|
+
|
|
46
|
+
When contributing to the project:
|
|
47
|
+
|
|
48
|
+
- do not introduce unsafe patterns or insecure defaults
|
|
49
|
+
- validate inputs and handle errors securely
|
|
50
|
+
- avoid exposing secrets or credentials in code, logs, or documentation
|
|
51
|
+
- report potential vulnerabilities privately as described above
|
|
52
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
module.exports = {
|
|
2
|
+
parserPreset: {
|
|
3
|
+
parserOpts: {
|
|
4
|
+
headerPattern: /^([a-zA-Z0-9_\-\/]+):\s(.*)$/,
|
|
5
|
+
headerCorrespondence: ['scope', 'subject'],
|
|
6
|
+
},
|
|
7
|
+
},
|
|
8
|
+
|
|
9
|
+
plugins: [
|
|
10
|
+
{
|
|
11
|
+
rules: {
|
|
12
|
+
'scope-subject-format': ({ header }) => {
|
|
13
|
+
const scopeSubjectRegex = /^[A-Za-z0-9_./\-]+:\s[A-Z].*\.$/;
|
|
14
|
+
|
|
15
|
+
return [
|
|
16
|
+
scopeSubjectRegex.test(header),
|
|
17
|
+
`Commit message must match style:\n` +
|
|
18
|
+
` Expected: "path/to/file: Capitalized sentence description."\n` +
|
|
19
|
+
` Received: "${header}"`,
|
|
20
|
+
];
|
|
21
|
+
},
|
|
22
|
+
|
|
23
|
+
'signed-off-by': ({ raw }) => {
|
|
24
|
+
const signoffRegex = /(?:^|\n)Signed-off-by:\s.+<.+>\s*$/m;
|
|
25
|
+
|
|
26
|
+
return [
|
|
27
|
+
signoffRegex.test(raw),
|
|
28
|
+
'Commit message must include a Signed-off-by trailer.',
|
|
29
|
+
];
|
|
30
|
+
},
|
|
31
|
+
},
|
|
32
|
+
},
|
|
33
|
+
],
|
|
34
|
+
|
|
35
|
+
rules: {
|
|
36
|
+
'scope-subject-format': [2, 'always'],
|
|
37
|
+
'signed-off-by': [2, 'always'],
|
|
38
|
+
'header-max-length': [2, 'always', 78],
|
|
39
|
+
},
|
|
40
|
+
};
|