dc-up 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.
- dc_up-0.1.0/.gitignore +189 -0
- dc_up-0.1.0/CHANGELOG.md +109 -0
- dc_up-0.1.0/CITATION.cff +43 -0
- dc_up-0.1.0/LICENSE +21 -0
- dc_up-0.1.0/PKG-INFO +150 -0
- dc_up-0.1.0/README.md +91 -0
- dc_up-0.1.0/pyproject.toml +203 -0
- dc_up-0.1.0/src/dc_up/__init__.py +1 -0
- dc_up-0.1.0/src/dc_up/__main__.py +6 -0
- dc_up-0.1.0/src/dc_up/_version.py +24 -0
- dc_up-0.1.0/src/dc_up/baseline.py +155 -0
- dc_up-0.1.0/src/dc_up/cli.py +145 -0
- dc_up-0.1.0/src/dc_up/commands/__init__.py +11 -0
- dc_up-0.1.0/src/dc_up/commands/todo.py +23 -0
- dc_up-0.1.0/src/dc_up/commands/update.py +50 -0
- dc_up-0.1.0/src/dc_up/detect.py +124 -0
- dc_up-0.1.0/src/dc_up/errors.py +38 -0
- dc_up-0.1.0/src/dc_up/fetch.py +329 -0
- dc_up-0.1.0/src/dc_up/plan.py +204 -0
- dc_up-0.1.0/src/dc_up/py.typed +0 -0
- dc_up-0.1.0/src/dc_up/render.py +35 -0
- dc_up-0.1.0/src/dc_up/todo.py +97 -0
- dc_up-0.1.0/src/dc_up/types.py +62 -0
dc_up-0.1.0/.gitignore
ADDED
|
@@ -0,0 +1,189 @@
|
|
|
1
|
+
# ============================================================
|
|
2
|
+
# .gitignore (ALL)
|
|
3
|
+
# ============================================================
|
|
4
|
+
# Updated: 2026-06-06
|
|
5
|
+
#
|
|
6
|
+
# REQ: All professional GitHub project repositories MUST include .gitignore.
|
|
7
|
+
# WHY: Keep generated artifacts, local state, secrets, and OS-specific files
|
|
8
|
+
# out of the repository.
|
|
9
|
+
# ALT: Repository may customize ignores, but MUST preserve universal safety rules.
|
|
10
|
+
# CUSTOM: Logs may be temporarily committed for verification; keep ignored for
|
|
11
|
+
# production use and security.
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
# === Private notes and local-only files ===
|
|
15
|
+
|
|
16
|
+
PRIVATE-NOTES.md
|
|
17
|
+
PRIVATE_NOTES.md
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
# === Environment variables and secrets ===
|
|
21
|
+
|
|
22
|
+
# WHY: Never commit credentials or environment-specific configuration.
|
|
23
|
+
*.env
|
|
24
|
+
.env
|
|
25
|
+
.env.*
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
# === Operating-system files ===
|
|
29
|
+
|
|
30
|
+
# WHY: OS-generated metadata files should never be tracked.
|
|
31
|
+
.AppleDouble
|
|
32
|
+
.DS_Store
|
|
33
|
+
.LSOverride
|
|
34
|
+
.Spotlight-V100/
|
|
35
|
+
.Trashes
|
|
36
|
+
._*
|
|
37
|
+
Icon\r
|
|
38
|
+
Thumbs.db
|
|
39
|
+
desktop.ini
|
|
40
|
+
ehthumbs.db
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
# === Editors and IDEs ===
|
|
44
|
+
|
|
45
|
+
# WHY: IDE metadata is machine-local and should not be tracked.
|
|
46
|
+
*.code-workspace
|
|
47
|
+
.idea/
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
# === VS Code ===
|
|
51
|
+
|
|
52
|
+
# WHY: Ignore editor state while allowing a shared baseline configuration.
|
|
53
|
+
.vscode/
|
|
54
|
+
|
|
55
|
+
# WHY: Commit shared VS Code project files for consistent extension development.
|
|
56
|
+
# NOTE: Share project configuration, not personal editor state or preferences.
|
|
57
|
+
!.vscode/extensions.json
|
|
58
|
+
!.vscode/launch.json
|
|
59
|
+
!.vscode/settings.json
|
|
60
|
+
!.vscode/tasks.json
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
# === Temporary and swap files ===
|
|
64
|
+
|
|
65
|
+
# WHY: Temporary and swap files are machine-local noise and create meaningless diffs.
|
|
66
|
+
*.swo
|
|
67
|
+
*.swp
|
|
68
|
+
*.tmp
|
|
69
|
+
*~
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
# === Markup and documentation ===
|
|
73
|
+
|
|
74
|
+
# WHY: Static site build output is generated.
|
|
75
|
+
site/
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
# === Generic caches ===
|
|
79
|
+
|
|
80
|
+
# WHY: Generic caches are machine-local and should not be tracked.
|
|
81
|
+
.cache/
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
# === Node dependencies ===
|
|
85
|
+
|
|
86
|
+
# WHY: Node dependencies are restored from package-lock.json with npm ci.
|
|
87
|
+
node_modules/
|
|
88
|
+
|
|
89
|
+
# REQ.NODE: Do NOT git ignore package-lock.json. Commit it and use it in CI/CD pipelines.
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
# === Node package-manager caches ===
|
|
93
|
+
|
|
94
|
+
# WHY: Package-manager caches are machine-local and should not be tracked.
|
|
95
|
+
.npm/
|
|
96
|
+
.pnpm-store/
|
|
97
|
+
.yarn/cache/
|
|
98
|
+
.yarn/unplugged/
|
|
99
|
+
.yarn/build-state.yml
|
|
100
|
+
.yarn/install-state.gz
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
# === TypeScript and JavaScript build output ===
|
|
104
|
+
|
|
105
|
+
# WHY: Compiled JavaScript output is generated from TypeScript source.
|
|
106
|
+
out/
|
|
107
|
+
|
|
108
|
+
# WHY: Distribution/build output is generated.
|
|
109
|
+
build/
|
|
110
|
+
dist/
|
|
111
|
+
|
|
112
|
+
# WHY: TypeScript incremental build metadata is generated.
|
|
113
|
+
*.tsbuildinfo
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
# === TypeScript and JavaScript tooling caches ===
|
|
117
|
+
|
|
118
|
+
# WHY: Tooling caches are generated and machine-local.
|
|
119
|
+
.eslintcache
|
|
120
|
+
.nyc_output/
|
|
121
|
+
coverage/
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
# === VS Code extension test and package output ===
|
|
125
|
+
|
|
126
|
+
# WHY: VS Code extension test host files are generated by @vscode/test-electron.
|
|
127
|
+
.vscode-test/
|
|
128
|
+
|
|
129
|
+
# WHY: VSIX packages are generated release artifacts.
|
|
130
|
+
*.vsix
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
# === Python environments ===
|
|
134
|
+
|
|
135
|
+
# WHY: Virtual environments are machine-local and reproducible.
|
|
136
|
+
.venv/
|
|
137
|
+
venv/
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
# === Python version files ===
|
|
141
|
+
|
|
142
|
+
# REQ.PYTHON: Do NOT git ignore uv.lock. Commit it and use it in CI/CD pipelines.
|
|
143
|
+
|
|
144
|
+
# WHY: Python version when using scm matches any repo depth and any package name.
|
|
145
|
+
**/src/**/_version.py
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
# === Python bytecode ===
|
|
149
|
+
|
|
150
|
+
# WHY: Python bytecode is generated.
|
|
151
|
+
*.pyc
|
|
152
|
+
*.pyd
|
|
153
|
+
*.pyo
|
|
154
|
+
__pycache__/
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
# === Python build and packaging artifacts ===
|
|
158
|
+
|
|
159
|
+
# WHY: Build and packaging artifacts are generated.
|
|
160
|
+
*.egg
|
|
161
|
+
*.egg-info/
|
|
162
|
+
*.whl
|
|
163
|
+
.eggs/
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
# === Python tooling caches ===
|
|
167
|
+
|
|
168
|
+
# WHY: Tooling caches should not be tracked.
|
|
169
|
+
.coverage
|
|
170
|
+
.coverage.*
|
|
171
|
+
.mypy_cache/
|
|
172
|
+
.pytest_cache/
|
|
173
|
+
.pytype/
|
|
174
|
+
.ruff_cache/
|
|
175
|
+
.tox/
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
# === Notebooks ===
|
|
179
|
+
|
|
180
|
+
# WHY: Notebook checkpoint state is generated.
|
|
181
|
+
.ipynb_checkpoints/
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
# === Logs and generated runtime output ===
|
|
185
|
+
|
|
186
|
+
# WHY: Logs are useful during debugging and verification.
|
|
187
|
+
# ALT: Comment if logs must be inspected or validated.
|
|
188
|
+
*.log
|
|
189
|
+
logs/
|
dc_up-0.1.0/CHANGELOG.md
ADDED
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
<!-- markdownlint-disable MD024 -->
|
|
4
|
+
|
|
5
|
+
All notable changes to this project will be documented in this file.
|
|
6
|
+
|
|
7
|
+
The format is based on **[Keep a Changelog](https://keepachangelog.com/en/1.1.0/)**
|
|
8
|
+
and this project adheres to **[Semantic Versioning](https://semver.org/spec/v2.0.0.html)**.
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## [Unreleased]
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## [0.1.0] - 2026-06-06
|
|
17
|
+
|
|
18
|
+
### Added
|
|
19
|
+
|
|
20
|
+
- Initial `dc-up` command-line package.
|
|
21
|
+
- Added dry-run default command: `dc-up`.
|
|
22
|
+
- Added write mode: `dc-up --write`.
|
|
23
|
+
- Added human review TODO command: `dc-up todo`.
|
|
24
|
+
- Added repository detection from the current working directory.
|
|
25
|
+
- Added additive template layer inference.
|
|
26
|
+
- Added managed-file planning for canonical baseline files.
|
|
27
|
+
- Added GitHub raw template fetching from `denisecase/templates`.
|
|
28
|
+
- Added optional local template source support.
|
|
29
|
+
- Added minimal repository identity token rendering.
|
|
30
|
+
- Added conservative write behavior for managed baseline files only.
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## Notes on Versioning and Releases
|
|
35
|
+
|
|
36
|
+
- We use **SemVer**:
|
|
37
|
+
- **MAJOR** - breaking changes
|
|
38
|
+
- **MINOR** - backward-compatible additions
|
|
39
|
+
- **PATCH** - fixes, documentation, tooling
|
|
40
|
+
- Versions are driven by git tags.
|
|
41
|
+
- Tag `vX.Y.Z` to release.
|
|
42
|
+
- Docs are deployed per version tag and aliased to **latest**.
|
|
43
|
+
|
|
44
|
+
## Release Procedure
|
|
45
|
+
|
|
46
|
+
Follow these steps when creating a new release.
|
|
47
|
+
|
|
48
|
+
### Task 1. Update release metadata
|
|
49
|
+
|
|
50
|
+
1. Update `CITATION.cff`: change `version` and `date-released`
|
|
51
|
+
2. Update `CHANGELOG.md`: move from unreleased, add entry, update links
|
|
52
|
+
3. Update `pyproject.toml`: update `[tool.hatch.version] fallback-version`
|
|
53
|
+
|
|
54
|
+
### Task 2. Validate
|
|
55
|
+
|
|
56
|
+
````shell
|
|
57
|
+
uv lock --upgrade
|
|
58
|
+
uv sync --extra dev --extra docs --upgrade
|
|
59
|
+
uvx pre-commit install
|
|
60
|
+
|
|
61
|
+
uv run dc-up
|
|
62
|
+
uv run dc-up todo
|
|
63
|
+
|
|
64
|
+
git add -A
|
|
65
|
+
uvx pre-commit run --all-files
|
|
66
|
+
# rerun if changes made
|
|
67
|
+
uvx pre-commit run --all-files
|
|
68
|
+
|
|
69
|
+
uv run python -m pytest
|
|
70
|
+
uv run python -m pyright
|
|
71
|
+
uv run python -m zensical build
|
|
72
|
+
|
|
73
|
+
uv run python -c "import shutil; from pathlib import Path; shutil.rmtree(Path('dist'), ignore_errors=True)"
|
|
74
|
+
|
|
75
|
+
uv build
|
|
76
|
+
uvx twine check dist/*
|
|
77
|
+
|
|
78
|
+
uvx --from dist/dc_up-0.1.0-py3-none-any.whl dc-up
|
|
79
|
+
uvx --from dist/dc_up-0.1.0-py3-none-any.whl dc-up todo
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Task 4. Commit, push, tag
|
|
83
|
+
|
|
84
|
+
```shell
|
|
85
|
+
git add -A
|
|
86
|
+
git commit -m "Prepare X.Y.Z"
|
|
87
|
+
git push -u origin main
|
|
88
|
+
````
|
|
89
|
+
|
|
90
|
+
Verify actions run on GitHub. After success:
|
|
91
|
+
|
|
92
|
+
```shell
|
|
93
|
+
git tag vX.Y.Z -m "X.Y.Z"
|
|
94
|
+
git push origin vX.Y.Z
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
## Only As Needed (delete a tag)
|
|
98
|
+
|
|
99
|
+
```shell
|
|
100
|
+
git tag -d vX.Z.Y
|
|
101
|
+
git push origin :refs/tags/vX.Z.Y
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## Links
|
|
105
|
+
|
|
106
|
+
[Unreleased]: https://github.com/denisecase/dc-up/compare/v0.1.0...HEAD
|
|
107
|
+
[0.1.0]: https://github.com/denisecase/dc-up/releases/tag/v0.1.0
|
|
108
|
+
|
|
109
|
+
<!-- markdownlint-enable MD024 -->
|
dc_up-0.1.0/CITATION.cff
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# ============================================================
|
|
2
|
+
# CITATION.cff (How to cite this project)
|
|
3
|
+
# ============================================================
|
|
4
|
+
|
|
5
|
+
# REQ.UNIVERSAL: Professional open projects SHOULD include this file.
|
|
6
|
+
# USAGE: See https://citation-file-format.github.io/ for details.
|
|
7
|
+
|
|
8
|
+
cff-version: "1.2.0"
|
|
9
|
+
type: software
|
|
10
|
+
|
|
11
|
+
title: "dc-up"
|
|
12
|
+
# Set version and date-released to match latest git tag or release.
|
|
13
|
+
version: "0.1.0"
|
|
14
|
+
date-released: "2026-06-06"
|
|
15
|
+
|
|
16
|
+
authors:
|
|
17
|
+
- family-names: Case
|
|
18
|
+
given-names: Denise M.
|
|
19
|
+
orcid: "https://orcid.org/0000-0001-6165-7389"
|
|
20
|
+
affiliation: "Northwest Missouri State University, School of Computer Science and Information Systems, Maryville, MO, USA"
|
|
21
|
+
|
|
22
|
+
repository-code: "https://github.com/denisecase/dc-up"
|
|
23
|
+
url: "https://github.com/denisecase/dc-up"
|
|
24
|
+
|
|
25
|
+
license: MIT
|
|
26
|
+
|
|
27
|
+
abstract: >
|
|
28
|
+
Command-line tool for bringing repositories up to a managed baseline using
|
|
29
|
+
layered canonical templates while preserving repository-specific work.
|
|
30
|
+
|
|
31
|
+
keywords:
|
|
32
|
+
- repository-baseline
|
|
33
|
+
- repository-templates
|
|
34
|
+
- template-management
|
|
35
|
+
- developer-tooling
|
|
36
|
+
- command-line-tool
|
|
37
|
+
- python
|
|
38
|
+
- uvx
|
|
39
|
+
- automation
|
|
40
|
+
- software-architecture
|
|
41
|
+
- accountable-repositories
|
|
42
|
+
|
|
43
|
+
message: "If you use this work, please cite it using the metadata in this file."
|
dc_up-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Denise Case
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
dc_up-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: dc-up
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Command-line tool for bringing repositories up to a managed baseline using layered canonical templates.
|
|
5
|
+
Project-URL: Homepage, https://github.com/denisecase/dc-up
|
|
6
|
+
Project-URL: Repository, https://github.com/denisecase/dc-up
|
|
7
|
+
Project-URL: Documentation, https://denisecase.github.io/dc-up/
|
|
8
|
+
Project-URL: Issues, https://github.com/denisecase/dc-up/issues
|
|
9
|
+
Project-URL: Changelog, https://github.com/denisecase/dc-up/blob/main/CHANGELOG.md
|
|
10
|
+
Author: Denise Case
|
|
11
|
+
License: MIT License
|
|
12
|
+
|
|
13
|
+
Copyright (c) 2026 Denise Case
|
|
14
|
+
|
|
15
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
16
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
17
|
+
in the Software without restriction, including without limitation the rights
|
|
18
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
19
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
20
|
+
furnished to do so, subject to the following conditions:
|
|
21
|
+
|
|
22
|
+
The above copyright notice and this permission notice shall be included in all
|
|
23
|
+
copies or substantial portions of the Software.
|
|
24
|
+
|
|
25
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
26
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
27
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
28
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
29
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
30
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
31
|
+
SOFTWARE.
|
|
32
|
+
License-File: LICENSE
|
|
33
|
+
Keywords: automation,command-line-tool,developer-tooling,python,repository-baseline,repository-templates,software-architecture,template-management,uvx
|
|
34
|
+
Classifier: Development Status :: 3 - Alpha
|
|
35
|
+
Classifier: Environment :: Console
|
|
36
|
+
Classifier: Intended Audience :: Developers
|
|
37
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
38
|
+
Classifier: Operating System :: OS Independent
|
|
39
|
+
Classifier: Programming Language :: Python :: 3
|
|
40
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
41
|
+
Classifier: Topic :: Software Development
|
|
42
|
+
Classifier: Topic :: Software Development :: Build Tools
|
|
43
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
44
|
+
Classifier: Topic :: Utilities
|
|
45
|
+
Classifier: Typing :: Typed
|
|
46
|
+
Requires-Python: >=3.14
|
|
47
|
+
Provides-Extra: dev
|
|
48
|
+
Requires-Dist: build; extra == 'dev'
|
|
49
|
+
Requires-Dist: pre-commit; extra == 'dev'
|
|
50
|
+
Requires-Dist: pyright; extra == 'dev'
|
|
51
|
+
Requires-Dist: pytest; extra == 'dev'
|
|
52
|
+
Requires-Dist: pytest-cov; extra == 'dev'
|
|
53
|
+
Requires-Dist: ruff; extra == 'dev'
|
|
54
|
+
Requires-Dist: twine; extra == 'dev'
|
|
55
|
+
Provides-Extra: docs
|
|
56
|
+
Requires-Dist: mkdocstrings[python]; extra == 'docs'
|
|
57
|
+
Requires-Dist: zensical; extra == 'docs'
|
|
58
|
+
Description-Content-Type: text/markdown
|
|
59
|
+
|
|
60
|
+
# dc-up
|
|
61
|
+
|
|
62
|
+
[](https://pypi.org/project/dc-up/)
|
|
63
|
+
[](https://denisecase.github.io/dc-up/)
|
|
64
|
+
[](https://github.com/denisecase/dc-up)
|
|
65
|
+
[](./pyproject.toml)
|
|
66
|
+
[](https://github.com/denisecase/dc-up/actions/workflows/python-315-ready.yml)
|
|
67
|
+
[](./LICENSE)
|
|
68
|
+
|
|
69
|
+
[](https://github.com/denisecase/dc-up/actions/workflows/ci-python-zensical.yml)
|
|
70
|
+
[](https://github.com/denisecase/dc-up/actions/workflows/deploy-zensical.yml)
|
|
71
|
+
[](https://github.com/denisecase/dc-up/actions/workflows/pre-release.yml)
|
|
72
|
+
[](https://github.com/denisecase/dc-up/actions/workflows/release-pypi.yml)
|
|
73
|
+
[](https://github.com/denisecase/dc-up/actions/workflows/links.yml)
|
|
74
|
+
[](https://github.com/denisecase/dc-up/security)
|
|
75
|
+
|
|
76
|
+
> Structural Explainability (SE) Manifest Schema
|
|
77
|
+
|
|
78
|
+
This repository defines the canonical `SE_MANIFEST.toml` schema
|
|
79
|
+
for the Structural Explainability ecosystem.
|
|
80
|
+
|
|
81
|
+
## Update a Repo based on Templates
|
|
82
|
+
|
|
83
|
+
```shell
|
|
84
|
+
uvx dc-up
|
|
85
|
+
uvx dc-up --write
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Developer Command Reference
|
|
89
|
+
|
|
90
|
+
<details>
|
|
91
|
+
<summary>Show command reference</summary>
|
|
92
|
+
|
|
93
|
+
### In a machine terminal
|
|
94
|
+
|
|
95
|
+
Open a machine terminal where you want the project:
|
|
96
|
+
|
|
97
|
+
```shell
|
|
98
|
+
git clone https://github.com/denisecase/dc-up
|
|
99
|
+
|
|
100
|
+
cd dc-up
|
|
101
|
+
code .
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### In a VS Code terminal
|
|
105
|
+
|
|
106
|
+
```shell
|
|
107
|
+
uv self update
|
|
108
|
+
uv python pin 3.14
|
|
109
|
+
uv lock --upgrade
|
|
110
|
+
uv sync --extra dev --extra docs --upgrade
|
|
111
|
+
|
|
112
|
+
uvx pre-commit install
|
|
113
|
+
|
|
114
|
+
git add -A
|
|
115
|
+
uvx pre-commit run --all-files
|
|
116
|
+
# repeat if changes were made
|
|
117
|
+
uvx pre-commit run --all-files
|
|
118
|
+
|
|
119
|
+
# repo-specific
|
|
120
|
+
uv run dc-up
|
|
121
|
+
uv run dc-up --write
|
|
122
|
+
|
|
123
|
+
# types, tests, docs
|
|
124
|
+
uv run python -m pyright
|
|
125
|
+
uv run python -m pytest
|
|
126
|
+
uv run python -m zensical build
|
|
127
|
+
|
|
128
|
+
# save progress
|
|
129
|
+
git add -A
|
|
130
|
+
git commit -m "update"
|
|
131
|
+
git push -u origin main
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
</details>
|
|
135
|
+
|
|
136
|
+
## Annotations
|
|
137
|
+
|
|
138
|
+
[.annotations/annotations.md](./.annotations/annotations.md)
|
|
139
|
+
|
|
140
|
+
## Authority Manifest
|
|
141
|
+
|
|
142
|
+
[.accountability/surfaces.toml](./.accountability/surfaces.toml)
|
|
143
|
+
|
|
144
|
+
## Citation
|
|
145
|
+
|
|
146
|
+
[CITATION.cff](./CITATION.cff)
|
|
147
|
+
|
|
148
|
+
## License
|
|
149
|
+
|
|
150
|
+
[MIT](./LICENSE)
|
dc_up-0.1.0/README.md
ADDED
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# dc-up
|
|
2
|
+
|
|
3
|
+
[](https://pypi.org/project/dc-up/)
|
|
4
|
+
[](https://denisecase.github.io/dc-up/)
|
|
5
|
+
[](https://github.com/denisecase/dc-up)
|
|
6
|
+
[](./pyproject.toml)
|
|
7
|
+
[](https://github.com/denisecase/dc-up/actions/workflows/python-315-ready.yml)
|
|
8
|
+
[](./LICENSE)
|
|
9
|
+
|
|
10
|
+
[](https://github.com/denisecase/dc-up/actions/workflows/ci-python-zensical.yml)
|
|
11
|
+
[](https://github.com/denisecase/dc-up/actions/workflows/deploy-zensical.yml)
|
|
12
|
+
[](https://github.com/denisecase/dc-up/actions/workflows/pre-release.yml)
|
|
13
|
+
[](https://github.com/denisecase/dc-up/actions/workflows/release-pypi.yml)
|
|
14
|
+
[](https://github.com/denisecase/dc-up/actions/workflows/links.yml)
|
|
15
|
+
[](https://github.com/denisecase/dc-up/security)
|
|
16
|
+
|
|
17
|
+
> Structural Explainability (SE) Manifest Schema
|
|
18
|
+
|
|
19
|
+
This repository defines the canonical `SE_MANIFEST.toml` schema
|
|
20
|
+
for the Structural Explainability ecosystem.
|
|
21
|
+
|
|
22
|
+
## Update a Repo based on Templates
|
|
23
|
+
|
|
24
|
+
```shell
|
|
25
|
+
uvx dc-up
|
|
26
|
+
uvx dc-up --write
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Developer Command Reference
|
|
30
|
+
|
|
31
|
+
<details>
|
|
32
|
+
<summary>Show command reference</summary>
|
|
33
|
+
|
|
34
|
+
### In a machine terminal
|
|
35
|
+
|
|
36
|
+
Open a machine terminal where you want the project:
|
|
37
|
+
|
|
38
|
+
```shell
|
|
39
|
+
git clone https://github.com/denisecase/dc-up
|
|
40
|
+
|
|
41
|
+
cd dc-up
|
|
42
|
+
code .
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### In a VS Code terminal
|
|
46
|
+
|
|
47
|
+
```shell
|
|
48
|
+
uv self update
|
|
49
|
+
uv python pin 3.14
|
|
50
|
+
uv lock --upgrade
|
|
51
|
+
uv sync --extra dev --extra docs --upgrade
|
|
52
|
+
|
|
53
|
+
uvx pre-commit install
|
|
54
|
+
|
|
55
|
+
git add -A
|
|
56
|
+
uvx pre-commit run --all-files
|
|
57
|
+
# repeat if changes were made
|
|
58
|
+
uvx pre-commit run --all-files
|
|
59
|
+
|
|
60
|
+
# repo-specific
|
|
61
|
+
uv run dc-up
|
|
62
|
+
uv run dc-up --write
|
|
63
|
+
|
|
64
|
+
# types, tests, docs
|
|
65
|
+
uv run python -m pyright
|
|
66
|
+
uv run python -m pytest
|
|
67
|
+
uv run python -m zensical build
|
|
68
|
+
|
|
69
|
+
# save progress
|
|
70
|
+
git add -A
|
|
71
|
+
git commit -m "update"
|
|
72
|
+
git push -u origin main
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
</details>
|
|
76
|
+
|
|
77
|
+
## Annotations
|
|
78
|
+
|
|
79
|
+
[.annotations/annotations.md](./.annotations/annotations.md)
|
|
80
|
+
|
|
81
|
+
## Authority Manifest
|
|
82
|
+
|
|
83
|
+
[.accountability/surfaces.toml](./.accountability/surfaces.toml)
|
|
84
|
+
|
|
85
|
+
## Citation
|
|
86
|
+
|
|
87
|
+
[CITATION.cff](./CITATION.cff)
|
|
88
|
+
|
|
89
|
+
## License
|
|
90
|
+
|
|
91
|
+
[MIT](./LICENSE)
|