optophi 0.0.1__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.
- optophi-0.0.1/MANIFEST.in +13 -0
- optophi-0.0.1/PKG-INFO +39 -0
- optophi-0.0.1/docs/distribution-description.md +27 -0
- optophi-0.0.1/docs/onboarding-distribution-migration.md +69 -0
- optophi-0.0.1/docs/onboarding-package.md +557 -0
- optophi-0.0.1/docs/onboarding-release.md +49 -0
- optophi-0.0.1/optophi/LICENSE +202 -0
- optophi-0.0.1/optophi/NOTICE +7 -0
- optophi-0.0.1/optophi/__init__.py +1 -0
- optophi-0.0.1/optophi/__main__.py +3 -0
- optophi-0.0.1/optophi/charter.py +141 -0
- optophi-0.0.1/optophi/cli.py +352 -0
- optophi-0.0.1/optophi/data/pycharter.zip +0 -0
- optophi-0.0.1/optophi/plugin.py +328 -0
- optophi-0.0.1/optophi/preparation.py +398 -0
- optophi-0.0.1/optophi/project.py +939 -0
- optophi-0.0.1/optophi/reference_update.py +303 -0
- optophi-0.0.1/optophi/status.py +317 -0
- optophi-0.0.1/optophi.egg-info/SOURCES.txt +23 -0
- optophi-0.0.1/pyproject.toml +42 -0
- optophi-0.0.1/setup.cfg +4 -0
- optophi-0.0.1/tests/fixtures/devops-preparation/preview-b8ce700.json +1 -0
- optophi-0.0.1/tests/fixtures/devops-preparation/provenance.json +25 -0
- optophi-0.0.1/tests/onboarding/requirements.txt +10 -0
- optophi-0.0.1/tests/onboarding/test_distribution.py +2456 -0
- optophi-0.0.1/tests/onboarding/ui-project-v1.json +12 -0
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
global-exclude *
|
|
2
|
+
include pyproject.toml MANIFEST.in
|
|
3
|
+
include docs/distribution-description.md
|
|
4
|
+
include docs/onboarding-package.md
|
|
5
|
+
include docs/onboarding-distribution-migration.md docs/onboarding-release.md
|
|
6
|
+
include tests/onboarding/requirements.txt
|
|
7
|
+
include tests/onboarding/test_distribution.py
|
|
8
|
+
include optophi/*.py
|
|
9
|
+
include optophi/LICENSE optophi/NOTICE
|
|
10
|
+
include optophi/data/pycharter.zip
|
|
11
|
+
include tests/onboarding/ui-project-v1.json
|
|
12
|
+
include tests/fixtures/devops-preparation/preview-b8ce700.json
|
|
13
|
+
include tests/fixtures/devops-preparation/provenance.json
|
optophi-0.0.1/PKG-INFO
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: optophi
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: Local Optophi project guidance and native-artifact references
|
|
5
|
+
Author-email: Optophi <contact@optophi.com>
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Requires-Python: >=3.11
|
|
8
|
+
Description-Content-Type: text/markdown
|
|
9
|
+
License-File: optophi/LICENSE
|
|
10
|
+
License-File: optophi/NOTICE
|
|
11
|
+
Dynamic: license-file
|
|
12
|
+
|
|
13
|
+
# Optophi CLI
|
|
14
|
+
|
|
15
|
+
Optophi helps a coding agent find the pipeline and data contract files you
|
|
16
|
+
already maintain in a local project. You select the files and review the
|
|
17
|
+
proposed setup before applying it.
|
|
18
|
+
|
|
19
|
+
Use these commands after installing the `optophi` distribution.
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
optophi --help
|
|
23
|
+
optophi --version
|
|
24
|
+
optophi status --project /path/to/project
|
|
25
|
+
optophi init --help
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
`status` inspects a project without editing it. `init` previews changes unless
|
|
29
|
+
you choose to apply a reviewed plan. The setup writes local Optophi guidance
|
|
30
|
+
and, if selected, a pointer in your coding client's instruction file. Your
|
|
31
|
+
pipeline and contract files stay where you keep them.
|
|
32
|
+
|
|
33
|
+
The CLI requires Python 3.11 or later and has no runtime dependencies. Local
|
|
34
|
+
project operations require POSIX filesystem support and are tested on Linux.
|
|
35
|
+
The package includes an exportable PyCharter coding plugin. Export puts the
|
|
36
|
+
plugin files in a directory you select. Client installation and provisioning a
|
|
37
|
+
PyCharter runtime are separate actions.
|
|
38
|
+
|
|
39
|
+
The CLI and bundled plugin use the Apache License, Version 2.0.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Optophi CLI
|
|
2
|
+
|
|
3
|
+
Optophi helps a coding agent find the pipeline and data contract files you
|
|
4
|
+
already maintain in a local project. You select the files and review the
|
|
5
|
+
proposed setup before applying it.
|
|
6
|
+
|
|
7
|
+
Use these commands after installing the `optophi` distribution.
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
optophi --help
|
|
11
|
+
optophi --version
|
|
12
|
+
optophi status --project /path/to/project
|
|
13
|
+
optophi init --help
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
`status` inspects a project without editing it. `init` previews changes unless
|
|
17
|
+
you choose to apply a reviewed plan. The setup writes local Optophi guidance
|
|
18
|
+
and, if selected, a pointer in your coding client's instruction file. Your
|
|
19
|
+
pipeline and contract files stay where you keep them.
|
|
20
|
+
|
|
21
|
+
The CLI requires Python 3.11 or later and has no runtime dependencies. Local
|
|
22
|
+
project operations require POSIX filesystem support and are tested on Linux.
|
|
23
|
+
The package includes an exportable PyCharter coding plugin. Export puts the
|
|
24
|
+
plugin files in a directory you select. Client installation and provisioning a
|
|
25
|
+
PyCharter runtime are separate actions.
|
|
26
|
+
|
|
27
|
+
The CLI and bundled plugin use the Apache License, Version 2.0.
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# Move an Optophi installation to a separate environment
|
|
2
|
+
|
|
3
|
+
Use this procedure with two independently reviewed local wheels. Keep the
|
|
4
|
+
existing `optophi-onboarding` environment available throughout the change.
|
|
5
|
+
That name was used for the unpublished `0.0.0.dev0` wheel. The replacement
|
|
6
|
+
uses `optophi` as its distribution, import package and console command.
|
|
7
|
+
The project directory, `.optophi` setup, native files, and separately exported
|
|
8
|
+
plugin stay in their existing locations.
|
|
9
|
+
|
|
10
|
+
## Why the environments must be separate
|
|
11
|
+
|
|
12
|
+
Both distributions own `bin/optophi`. Installing both can replace the launcher
|
|
13
|
+
while preserving both sets of package metadata. Removing either distribution
|
|
14
|
+
can then delete the launcher while the other still appears installed.
|
|
15
|
+
|
|
16
|
+
If an environment already contains both names, preserve it and stage a reviewed
|
|
17
|
+
wheel in a different environment. Current Optophi commands refuse operations
|
|
18
|
+
and version queries when both distributions claim the same installation.
|
|
19
|
+
Command help stays available. Older releases may still run from a shared
|
|
20
|
+
installation. Keep an independently known working wheel and environment
|
|
21
|
+
available for recovery.
|
|
22
|
+
|
|
23
|
+
## Stage and check the replacement
|
|
24
|
+
|
|
25
|
+
Record the version and read-only project status of the current command.
|
|
26
|
+
Compare the replacement wheel's SHA-256 with its reviewed artifact record.
|
|
27
|
+
From a trusted Platform checkout, choose a new virtual environment path.
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
old=/absolute/path/to/current-venv
|
|
31
|
+
replacement=/absolute/path/to/new-venv
|
|
32
|
+
project=/absolute/path/to/existing-project
|
|
33
|
+
wheel=/absolute/path/to/reviewed-replacement.whl
|
|
34
|
+
|
|
35
|
+
"$old/bin/optophi" --version
|
|
36
|
+
"$old/bin/optophi" status --project "$project"
|
|
37
|
+
sha256sum "$wheel"
|
|
38
|
+
|
|
39
|
+
test ! -e "$replacement" && test ! -L "$replacement" &&
|
|
40
|
+
python3 -m venv "$replacement" &&
|
|
41
|
+
"$replacement/bin/python" -I -B scripts/check-onboarding-migration.py
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Continue after the preflight exits zero and prints `"status": "ready"`.
|
|
45
|
+
It reports claims from installed distribution metadata, console entry points and
|
|
46
|
+
RECORD files. Both absolute and distribution-relative RECORD paths can
|
|
47
|
+
establish a claim even when the files are missing. The preflight also checks
|
|
48
|
+
for launcher and import leftovers without distribution metadata. An installed
|
|
49
|
+
distribution with a missing, unreadable, or empty RECORD produces a JSON
|
|
50
|
+
refusal because its file ownership cannot be checked. Choose a separate path
|
|
51
|
+
if the preflight reports existing claims or cannot inspect the environment.
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
"$replacement/bin/python" -I -m pip --isolated install --no-index --no-deps "$wheel"
|
|
55
|
+
"$replacement/bin/optophi" --help
|
|
56
|
+
"$replacement/bin/optophi" --version
|
|
57
|
+
"$replacement/bin/optophi" status --project "$project"
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Verify the expected version and intact project status using the reviewed
|
|
61
|
+
candidate record. If a check fails, keep using the existing absolute command
|
|
62
|
+
path. Setup and export are unnecessary for projects with intact v1 setup.
|
|
63
|
+
|
|
64
|
+
After validation, select the replacement command explicitly in your shell or
|
|
65
|
+
caller. To roll back, select the original absolute command path again. A change
|
|
66
|
+
of launcher needs no changes to the project or exported plugin. Retire the old
|
|
67
|
+
environment only after the replacement is accepted. Package removal leaves
|
|
68
|
+
project data, exported plugins, and separately configured client permissions
|
|
69
|
+
under their existing owners.
|