augplot 0.1.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.
- augplot-0.1.0/.github/dependabot.yml +13 -0
- augplot-0.1.0/.github/workflows/codeql.yml +37 -0
- augplot-0.1.0/.github/workflows/release.yml +128 -0
- augplot-0.1.0/.github/workflows/tests.yml +53 -0
- augplot-0.1.0/.gitignore +21 -0
- augplot-0.1.0/AGENTS.md +69 -0
- augplot-0.1.0/CHANGELOG.md +16 -0
- augplot-0.1.0/CODE_OF_CONDUCT.md +46 -0
- augplot-0.1.0/CONTRIBUTING.md +52 -0
- augplot-0.1.0/LICENSE +201 -0
- augplot-0.1.0/NOTICE +3 -0
- augplot-0.1.0/PKG-INFO +157 -0
- augplot-0.1.0/README.md +119 -0
- augplot-0.1.0/SECURITY.md +34 -0
- augplot-0.1.0/docs/api.md +143 -0
- augplot-0.1.0/docs/assets/augplot-workflow.png +0 -0
- augplot-0.1.0/docs/generated-code-guardrails.md +70 -0
- augplot-0.1.0/docs/visualization-history.md +50 -0
- augplot-0.1.0/examples/quickstart.ipynb +841 -0
- augplot-0.1.0/pyproject.toml +56 -0
- augplot-0.1.0/src/augplot/__init__.py +25 -0
- augplot-0.1.0/src/augplot/core.py +307 -0
- augplot-0.1.0/src/augplot/datasets.py +51 -0
- augplot-0.1.0/src/augplot/errors.py +45 -0
- augplot-0.1.0/src/augplot/execution.py +1285 -0
- augplot-0.1.0/src/augplot/exporting.py +105 -0
- augplot-0.1.0/src/augplot/history.py +193 -0
- augplot-0.1.0/src/augplot/profiling.py +273 -0
- augplot-0.1.0/src/augplot/prompts.py +208 -0
- augplot-0.1.0/src/augplot/provider.py +57 -0
- augplot-0.1.0/tests/conftest.py +74 -0
- augplot-0.1.0/tests/notebook_charts.py +81 -0
- augplot-0.1.0/tests/test_datasets.py +66 -0
- augplot-0.1.0/tests/test_display.py +70 -0
- augplot-0.1.0/tests/test_execution.py +576 -0
- augplot-0.1.0/tests/test_export.py +92 -0
- augplot-0.1.0/tests/test_history.py +292 -0
- augplot-0.1.0/tests/test_live.py +14 -0
- augplot-0.1.0/tests/test_metadata.py +12 -0
- augplot-0.1.0/tests/test_notebook.py +156 -0
- augplot-0.1.0/tests/test_profiling.py +107 -0
- augplot-0.1.0/tests/test_prompts.py +97 -0
- augplot-0.1.0/tests/test_provider.py +87 -0
- augplot-0.1.0/tests/test_workflow.py +248 -0
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
name: CodeQL
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
branches: [main]
|
|
8
|
+
schedule:
|
|
9
|
+
- cron: '23 4 * * 1'
|
|
10
|
+
workflow_dispatch:
|
|
11
|
+
|
|
12
|
+
permissions:
|
|
13
|
+
contents: read
|
|
14
|
+
packages: read
|
|
15
|
+
security-events: write
|
|
16
|
+
|
|
17
|
+
jobs:
|
|
18
|
+
analyze:
|
|
19
|
+
name: Analyze Python
|
|
20
|
+
if: github.event.repository.private == false
|
|
21
|
+
runs-on: ubuntu-latest
|
|
22
|
+
timeout-minutes: 30
|
|
23
|
+
|
|
24
|
+
steps:
|
|
25
|
+
- name: Check out repository
|
|
26
|
+
uses: actions/checkout@v6
|
|
27
|
+
|
|
28
|
+
- name: Initialize CodeQL
|
|
29
|
+
uses: github/codeql-action/init@v4
|
|
30
|
+
with:
|
|
31
|
+
languages: python
|
|
32
|
+
build-mode: none
|
|
33
|
+
|
|
34
|
+
- name: Analyze
|
|
35
|
+
uses: github/codeql-action/analyze@v4
|
|
36
|
+
with:
|
|
37
|
+
category: /language:python
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
name: Publish to PyPI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
release:
|
|
5
|
+
types: [published]
|
|
6
|
+
workflow_dispatch:
|
|
7
|
+
|
|
8
|
+
permissions: {}
|
|
9
|
+
|
|
10
|
+
concurrency:
|
|
11
|
+
group: pypi-${{ github.event.release.tag_name || github.ref }}
|
|
12
|
+
cancel-in-progress: false
|
|
13
|
+
|
|
14
|
+
jobs:
|
|
15
|
+
build:
|
|
16
|
+
name: Build and verify distributions
|
|
17
|
+
if: >-
|
|
18
|
+
github.event_name == 'workflow_dispatch' ||
|
|
19
|
+
(github.event_name == 'release' &&
|
|
20
|
+
github.event.release.prerelease == false &&
|
|
21
|
+
startsWith(github.event.release.tag_name, 'v'))
|
|
22
|
+
runs-on: ubuntu-latest
|
|
23
|
+
permissions:
|
|
24
|
+
contents: read
|
|
25
|
+
|
|
26
|
+
steps:
|
|
27
|
+
- name: Check out source
|
|
28
|
+
uses: actions/checkout@v6
|
|
29
|
+
with:
|
|
30
|
+
persist-credentials: false
|
|
31
|
+
|
|
32
|
+
- name: Set up Python
|
|
33
|
+
uses: actions/setup-python@v7
|
|
34
|
+
with:
|
|
35
|
+
python-version: "3.12"
|
|
36
|
+
|
|
37
|
+
- name: Verify tag matches package version
|
|
38
|
+
if: github.event_name == 'release'
|
|
39
|
+
env:
|
|
40
|
+
RELEASE_TAG: ${{ github.event.release.tag_name }}
|
|
41
|
+
run: |
|
|
42
|
+
PACKAGE_VERSION=$(python -c 'import tomllib; print(tomllib.load(open("pyproject.toml", "rb"))["project"]["version"])')
|
|
43
|
+
test "$RELEASE_TAG" = "v$PACKAGE_VERSION"
|
|
44
|
+
|
|
45
|
+
- name: Install build tools
|
|
46
|
+
run: python -m pip install build twine
|
|
47
|
+
|
|
48
|
+
- name: Build wheel and source distribution
|
|
49
|
+
run: python -m build
|
|
50
|
+
|
|
51
|
+
- name: Check distribution metadata
|
|
52
|
+
run: python -m twine check --strict dist/*
|
|
53
|
+
|
|
54
|
+
- name: Check artifact names and contents
|
|
55
|
+
run: |
|
|
56
|
+
python - <<'PY'
|
|
57
|
+
import tarfile
|
|
58
|
+
import tomllib
|
|
59
|
+
import zipfile
|
|
60
|
+
from pathlib import Path
|
|
61
|
+
|
|
62
|
+
version = tomllib.loads(Path("pyproject.toml").read_text())["project"]["version"]
|
|
63
|
+
wheels = list(Path("dist").glob("*.whl"))
|
|
64
|
+
sdists = list(Path("dist").glob("*.tar.gz"))
|
|
65
|
+
expected = {f"augplot-{version}-py3-none-any.whl", f"augplot-{version}.tar.gz"}
|
|
66
|
+
actual = {path.name for path in Path("dist").iterdir() if path.is_file()}
|
|
67
|
+
|
|
68
|
+
if len(wheels) != 1 or len(sdists) != 1 or actual != expected:
|
|
69
|
+
raise SystemExit(f"Unexpected distribution artifacts: {sorted(actual)}")
|
|
70
|
+
|
|
71
|
+
with zipfile.ZipFile(wheels[0]) as archive:
|
|
72
|
+
wheel_files = archive.namelist()
|
|
73
|
+
with tarfile.open(sdists[0], "r:gz") as archive:
|
|
74
|
+
sdist_files = archive.getnames()
|
|
75
|
+
|
|
76
|
+
for filename in ("LICENSE", "NOTICE"):
|
|
77
|
+
if not any(path.endswith(f".dist-info/licenses/{filename}") for path in wheel_files):
|
|
78
|
+
raise SystemExit(f"Wheel is missing {filename}")
|
|
79
|
+
if not any(path.endswith(f"/{filename}") for path in sdist_files):
|
|
80
|
+
raise SystemExit(f"Source distribution is missing {filename}")
|
|
81
|
+
PY
|
|
82
|
+
|
|
83
|
+
- name: Install and import the wheel in a clean environment
|
|
84
|
+
run: |
|
|
85
|
+
PACKAGE_VERSION=$(python -c 'import tomllib; print(tomllib.load(open("pyproject.toml", "rb"))["project"]["version"])')
|
|
86
|
+
WHEEL_PATH=$(realpath dist/*.whl)
|
|
87
|
+
python -m venv /tmp/augplot-wheel
|
|
88
|
+
/tmp/augplot-wheel/bin/python -m pip install "$WHEEL_PATH"
|
|
89
|
+
cd /tmp
|
|
90
|
+
AUGPLOT_EXPECTED_VERSION="$PACKAGE_VERSION" /tmp/augplot-wheel/bin/python -c 'import os, augplot; assert augplot.__version__ == os.environ["AUGPLOT_EXPECTED_VERSION"]'
|
|
91
|
+
|
|
92
|
+
- name: Upload distributions
|
|
93
|
+
uses: actions/upload-artifact@v5
|
|
94
|
+
with:
|
|
95
|
+
name: python-package-distributions
|
|
96
|
+
path: dist/
|
|
97
|
+
if-no-files-found: error
|
|
98
|
+
retention-days: 7
|
|
99
|
+
|
|
100
|
+
publish:
|
|
101
|
+
name: Publish distributions to PyPI
|
|
102
|
+
needs: build
|
|
103
|
+
if: >-
|
|
104
|
+
github.event_name == 'release' &&
|
|
105
|
+
github.event.release.prerelease == false &&
|
|
106
|
+
startsWith(github.event.release.tag_name, 'v')
|
|
107
|
+
runs-on: ubuntu-latest
|
|
108
|
+
environment:
|
|
109
|
+
name: pypi
|
|
110
|
+
url: https://pypi.org/p/augplot
|
|
111
|
+
permissions:
|
|
112
|
+
id-token: write
|
|
113
|
+
|
|
114
|
+
steps:
|
|
115
|
+
- name: Download distributions
|
|
116
|
+
uses: actions/download-artifact@v6
|
|
117
|
+
with:
|
|
118
|
+
name: python-package-distributions
|
|
119
|
+
path: dist/
|
|
120
|
+
|
|
121
|
+
- name: Verify downloaded artifacts
|
|
122
|
+
run: |
|
|
123
|
+
test "$(find dist -maxdepth 1 -type f -name '*.whl' | wc -l)" -eq 1
|
|
124
|
+
test "$(find dist -maxdepth 1 -type f -name '*.tar.gz' | wc -l)" -eq 1
|
|
125
|
+
test "$(find dist -maxdepth 1 -type f | wc -l)" -eq 2
|
|
126
|
+
|
|
127
|
+
- name: Publish distributions with trusted publishing
|
|
128
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
name: Tests
|
|
2
|
+
on: [push, pull_request]
|
|
3
|
+
|
|
4
|
+
permissions:
|
|
5
|
+
contents: read
|
|
6
|
+
|
|
7
|
+
jobs:
|
|
8
|
+
test:
|
|
9
|
+
runs-on: ubuntu-latest
|
|
10
|
+
strategy:
|
|
11
|
+
matrix:
|
|
12
|
+
python: ['3.11', '3.12', '3.13', '3.14']
|
|
13
|
+
steps:
|
|
14
|
+
- uses: actions/checkout@v6
|
|
15
|
+
- uses: actions/setup-python@v7
|
|
16
|
+
with:
|
|
17
|
+
python-version: ${{ matrix.python }}
|
|
18
|
+
- run: python -m pip install -e '.[dev]'
|
|
19
|
+
- run: python -m ruff check .
|
|
20
|
+
- run: python -m pytest
|
|
21
|
+
env:
|
|
22
|
+
MPLBACKEND: Agg
|
|
23
|
+
- run: python -m build
|
|
24
|
+
- run: |
|
|
25
|
+
python -m venv /tmp/augplot-wheel
|
|
26
|
+
/tmp/augplot-wheel/bin/pip install dist/*.whl
|
|
27
|
+
cd /tmp
|
|
28
|
+
/tmp/augplot-wheel/bin/python -c "import augplot as ap; print(ap.plot)"
|
|
29
|
+
|
|
30
|
+
minimum-dependencies:
|
|
31
|
+
name: Minimum dependencies (Python 3.11)
|
|
32
|
+
runs-on: ubuntu-latest
|
|
33
|
+
steps:
|
|
34
|
+
- uses: actions/checkout@v6
|
|
35
|
+
- uses: actions/setup-python@v7
|
|
36
|
+
with:
|
|
37
|
+
python-version: '3.11'
|
|
38
|
+
- name: Install minimum runtime and test dependencies
|
|
39
|
+
run: |
|
|
40
|
+
python -m pip install -e . \
|
|
41
|
+
'numpy==1.26.0' \
|
|
42
|
+
'pandas==2.1.0' \
|
|
43
|
+
'matplotlib==3.8.0' \
|
|
44
|
+
'seaborn==0.13.0' \
|
|
45
|
+
'ipython==8.18.0' \
|
|
46
|
+
'litellm==1.60.0' \
|
|
47
|
+
'pytest==8.0.0' \
|
|
48
|
+
'nbclient==0.10.0' \
|
|
49
|
+
'nbformat==5.10.0' \
|
|
50
|
+
'ipykernel==6.29.0'
|
|
51
|
+
- run: python -m pytest
|
|
52
|
+
env:
|
|
53
|
+
MPLBACKEND: Agg
|
augplot-0.1.0/.gitignore
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
.venv/
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
.pytest_cache/
|
|
5
|
+
.ruff_cache/
|
|
6
|
+
*.egg-info/
|
|
7
|
+
dist/
|
|
8
|
+
build/
|
|
9
|
+
.ipynb_checkpoints/
|
|
10
|
+
.env
|
|
11
|
+
.env.*
|
|
12
|
+
!.env.example
|
|
13
|
+
vis_utils.py
|
|
14
|
+
examples/vis_utils.py
|
|
15
|
+
examples/.augplot
|
|
16
|
+
augplot_utils*.py
|
|
17
|
+
|
|
18
|
+
# Local inputs used to compose the README hero.
|
|
19
|
+
docs/assets/build_augplot_workflow.py
|
|
20
|
+
docs/assets/airline-lines-original.png
|
|
21
|
+
docs/assets/airline-heatmap-original.png
|
augplot-0.1.0/AGENTS.md
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# Repository Guidelines
|
|
2
|
+
|
|
3
|
+
## Project Structure & Module Organization
|
|
4
|
+
|
|
5
|
+
Augplot is a Python package using a `src/` layout. Product code lives in
|
|
6
|
+
`src/augplot/`; `core.py` owns the public notebook workflow, while profiling,
|
|
7
|
+
providers, execution, history, and exporting are separated into focused modules.
|
|
8
|
+
Tests live in `tests/` and generally mirror those responsibilities. Documentation is
|
|
9
|
+
under `docs/`, the runnable walkthrough is `examples/quickstart.ipynb`, and README
|
|
10
|
+
images belong in `docs/assets/`.
|
|
11
|
+
|
|
12
|
+
## Build, Test, and Development Commands
|
|
13
|
+
|
|
14
|
+
Create an isolated environment and install development dependencies:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
python3 -m venv .venv
|
|
18
|
+
source .venv/bin/activate
|
|
19
|
+
python -m pip install -e '.[dev]'
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Run the same core checks used by CI:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
python -m ruff check .
|
|
26
|
+
MPLBACKEND=Agg python -m pytest
|
|
27
|
+
python -m build
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
The first command checks style and imports, the second runs the offline suite with a
|
|
31
|
+
headless plotting backend, and the third validates source and wheel packaging.
|
|
32
|
+
|
|
33
|
+
## Coding Style & Naming Conventions
|
|
34
|
+
|
|
35
|
+
Use four-space indentation, Python 3.11-compatible syntax, and a 100-character line
|
|
36
|
+
limit. Ruff enforces `E`, `F`, `I`, `B`, and `UP` rules. Use `snake_case` for functions,
|
|
37
|
+
variables, and modules; `PascalCase` for classes; and descriptive exception types in
|
|
38
|
+
`errors.py`. Keep public workflow methods small and move provider, persistence, or code
|
|
39
|
+
execution concerns into their existing modules.
|
|
40
|
+
|
|
41
|
+
## Testing Guidelines
|
|
42
|
+
|
|
43
|
+
Pytest discovers `tests/test_*.py` and `test_*` functions. Add focused regression tests
|
|
44
|
+
for every behavior change; there is no numeric coverage threshold. Tests must not depend
|
|
45
|
+
on real credentials or shared `.augplot` history. Live provider tests are explicitly
|
|
46
|
+
opt-in and may incur costs:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
AUGPLOT_LIVE_TEST=1 python -m pytest -m live
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Commit & Pull Request Guidelines
|
|
53
|
+
|
|
54
|
+
Use short, imperative, sentence-case commit subjects, for example `Improve README quick
|
|
55
|
+
start` or `Add trusted PyPI release workflow`. `main` is protected: develop on a branch
|
|
56
|
+
and merge through a pull request; do not bypass protections with direct pushes. Keep PRs
|
|
57
|
+
focused, explain user-visible behavior, link relevant issues, and include screenshots for
|
|
58
|
+
notebook or plotting changes. Update tests and documentation when APIs, configuration,
|
|
59
|
+
persistence, or security boundaries change.
|
|
60
|
+
|
|
61
|
+
Every PR runs the required checks: Ruff, pytest, package build, and clean wheel import on
|
|
62
|
+
Python 3.11–3.14; a minimum-dependency test on Python 3.11; and CodeQL analysis. All
|
|
63
|
+
required checks must pass before merge.
|
|
64
|
+
|
|
65
|
+
## Security & Configuration
|
|
66
|
+
|
|
67
|
+
Never commit API keys, private datasets, generated environments, or notebook history
|
|
68
|
+
containing local paths. Generated Python is validated but is not OS-sandboxed; preserve
|
|
69
|
+
the execution guardrails and report vulnerabilities through `SECURITY.md`.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to Augplot are documented in this file.
|
|
4
|
+
|
|
5
|
+
## [0.1.0] - 2026-09-22
|
|
6
|
+
|
|
7
|
+
Initial beta release.
|
|
8
|
+
|
|
9
|
+
### Added
|
|
10
|
+
|
|
11
|
+
- Notebook-first `plot`, `refine`, `render`, and `to_python` workflow.
|
|
12
|
+
- Support for Pandas objects, NumPy arrays, lists, and nested dictionaries.
|
|
13
|
+
- Persistent visualization history for replaying and revising generated plots.
|
|
14
|
+
- Validated local execution of generated Matplotlib and Seaborn code.
|
|
15
|
+
- Strict JSON Schema model responses with explicit provider capability checks.
|
|
16
|
+
- Seaborn example-dataset loading and a quickstart notebook.
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our commitment
|
|
4
|
+
|
|
5
|
+
We are committed to making participation in Augplot welcoming and harassment-free for
|
|
6
|
+
everyone, regardless of age, body size, disability, ethnicity, sex characteristics,
|
|
7
|
+
gender identity and expression, experience level, education, socioeconomic status,
|
|
8
|
+
nationality, personal appearance, race, religion, or sexual identity and orientation.
|
|
9
|
+
|
|
10
|
+
## Expected behavior
|
|
11
|
+
|
|
12
|
+
Examples of behavior that contributes to a positive community include:
|
|
13
|
+
|
|
14
|
+
- Showing empathy and respect for different viewpoints and experiences.
|
|
15
|
+
- Giving and accepting constructive feedback gracefully.
|
|
16
|
+
- Focusing discussion on what is best for the project and its users.
|
|
17
|
+
- Taking responsibility, apologizing when mistakes affect others, and learning from them.
|
|
18
|
+
|
|
19
|
+
Unacceptable behavior includes:
|
|
20
|
+
|
|
21
|
+
- Sexualized language or imagery and unwelcome sexual attention or advances.
|
|
22
|
+
- Trolling, insulting or derogatory comments, and personal or political attacks.
|
|
23
|
+
- Public or private harassment.
|
|
24
|
+
- Publishing another person's private information without explicit permission.
|
|
25
|
+
- Other conduct that would reasonably be considered inappropriate in a professional setting.
|
|
26
|
+
|
|
27
|
+
## Scope
|
|
28
|
+
|
|
29
|
+
This policy applies in project spaces and when someone officially represents the project.
|
|
30
|
+
Project spaces include the repository, issue tracker, pull requests, reviews, discussions,
|
|
31
|
+
and other communication channels used by the project.
|
|
32
|
+
|
|
33
|
+
## Reporting and enforcement
|
|
34
|
+
|
|
35
|
+
To report a conduct concern, open an issue requesting a private contact channel without
|
|
36
|
+
including sensitive details. Maintainers will review reports promptly, respect the
|
|
37
|
+
reporter's privacy, and respond in a manner proportionate to the circumstances.
|
|
38
|
+
|
|
39
|
+
Maintainers may edit or remove contributions that violate this policy and may temporarily
|
|
40
|
+
or permanently restrict participation. Enforcement decisions will consider context, impact,
|
|
41
|
+
and patterns of behavior.
|
|
42
|
+
|
|
43
|
+
## Attribution
|
|
44
|
+
|
|
45
|
+
This policy is adapted from the
|
|
46
|
+
[Contributor Covenant, version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Contributing to Augplot
|
|
2
|
+
|
|
3
|
+
Thanks for helping improve Augplot. Bug reports, focused feature proposals, documentation
|
|
4
|
+
improvements, and tested code changes are welcome.
|
|
5
|
+
|
|
6
|
+
By participating, you agree to follow the [Code of Conduct](CODE_OF_CONDUCT.md).
|
|
7
|
+
|
|
8
|
+
## Before opening an issue
|
|
9
|
+
|
|
10
|
+
- Search existing issues to avoid duplicates.
|
|
11
|
+
- Use a minimal, reproducible example for bugs.
|
|
12
|
+
- Include the Augplot and Python versions, operating system, model provider, and complete
|
|
13
|
+
traceback where relevant.
|
|
14
|
+
- Remove credentials, personal data, and proprietary prompts or datasets.
|
|
15
|
+
- Report vulnerabilities privately according to the [security policy](SECURITY.md).
|
|
16
|
+
|
|
17
|
+
## Development setup
|
|
18
|
+
|
|
19
|
+
Augplot supports Python 3.11 through 3.14. Create an isolated environment, then install the
|
|
20
|
+
project with its development dependencies:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
python3 -m venv .venv
|
|
24
|
+
source .venv/bin/activate
|
|
25
|
+
python -m pip install -e '.[dev]'
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Run the local checks before submitting a pull request:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
python -m ruff check .
|
|
32
|
+
MPLBACKEND=Agg python -m pytest
|
|
33
|
+
python -m build
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Live model tests are opt-in because they use provider credentials and may incur costs:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
AUGPLOT_LIVE_TEST=1 python -m pytest -m live
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Pull requests
|
|
43
|
+
|
|
44
|
+
- Keep changes focused and explain the user-visible behavior.
|
|
45
|
+
- Add or update tests for behavior changes.
|
|
46
|
+
- Update documentation when public APIs, configuration, or security boundaries change.
|
|
47
|
+
- Do not commit generated environments, API credentials, notebook history containing local
|
|
48
|
+
paths, or private data.
|
|
49
|
+
- Confirm that tests, linting, and package builds pass.
|
|
50
|
+
|
|
51
|
+
Maintainers may ask for changes to keep the API small, preserve notebook usability, or
|
|
52
|
+
maintain the generated-code security boundary.
|
augplot-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
augplot-0.1.0/NOTICE
ADDED