pluginator 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.
- pluginator-0.0.0/.github/workflows/docs.yml +26 -0
- pluginator-0.0.0/.github/workflows/lint.yml +17 -0
- pluginator-0.0.0/.github/workflows/new_version.yml +21 -0
- pluginator-0.0.0/.github/workflows/publish.yml +17 -0
- pluginator-0.0.0/.github/workflows/strictacode.yml +43 -0
- pluginator-0.0.0/.github/workflows/tests.yml +10 -0
- pluginator-0.0.0/.gitignore +210 -0
- pluginator-0.0.0/.qarium/ai/employees/devops.md +32 -0
- pluginator-0.0.0/.qarium/ai/employees/lead.md +36 -0
- pluginator-0.0.0/.qarium/ai/employees/qa.md +40 -0
- pluginator-0.0.0/.qarium/ai/employees/tech-writer.md +25 -0
- pluginator-0.0.0/.strictacode.yml +3 -0
- pluginator-0.0.0/PKG-INFO +53 -0
- pluginator-0.0.0/README.md +26 -0
- pluginator-0.0.0/docs/api-reference.md +1 -0
- pluginator-0.0.0/docs/configuration.md +1 -0
- pluginator-0.0.0/docs/examples.md +1 -0
- pluginator-0.0.0/docs/getting-started.md +1 -0
- pluginator-0.0.0/docs/index.md +3 -0
- pluginator-0.0.0/docs/overrides/main.html +68 -0
- pluginator-0.0.0/mkdocs.yml +40 -0
- pluginator-0.0.0/pluginator/__init__.py +16 -0
- pluginator-0.0.0/pluginator/actions.py +92 -0
- pluginator-0.0.0/pluginator/define.py +87 -0
- pluginator-0.0.0/pluginator/pytest.py +339 -0
- pluginator-0.0.0/pluginator/utils.py +8 -0
- pluginator-0.0.0/pluginator.egg-info/PKG-INFO +53 -0
- pluginator-0.0.0/pluginator.egg-info/SOURCES.txt +37 -0
- pluginator-0.0.0/pluginator.egg-info/dependency_links.txt +1 -0
- pluginator-0.0.0/pluginator.egg-info/requires.txt +14 -0
- pluginator-0.0.0/pluginator.egg-info/top_level.txt +1 -0
- pluginator-0.0.0/pyproject.toml +72 -0
- pluginator-0.0.0/setup.cfg +4 -0
- pluginator-0.0.0/tests/__init__.py +0 -0
- pluginator-0.0.0/tests/conftest.py +94 -0
- pluginator-0.0.0/tests/test_actions.py +253 -0
- pluginator-0.0.0/tests/test_define.py +33 -0
- pluginator-0.0.0/tests/test_pytest.py +563 -0
- pluginator-0.0.0/tests/test_utils.py +12 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
name: Release docs
|
|
2
|
+
on:
|
|
3
|
+
push:
|
|
4
|
+
branches:
|
|
5
|
+
- 0.0.x
|
|
6
|
+
|
|
7
|
+
permissions:
|
|
8
|
+
contents: write
|
|
9
|
+
|
|
10
|
+
jobs:
|
|
11
|
+
deploy:
|
|
12
|
+
runs-on: ubuntu-latest
|
|
13
|
+
steps:
|
|
14
|
+
- uses: actions/checkout@v4
|
|
15
|
+
|
|
16
|
+
- name: Configure Python
|
|
17
|
+
uses: actions/setup-python@v5
|
|
18
|
+
with:
|
|
19
|
+
python-version: 3.x
|
|
20
|
+
|
|
21
|
+
- name: Install dependencies
|
|
22
|
+
run: |
|
|
23
|
+
pip install -e ".[docs]"
|
|
24
|
+
|
|
25
|
+
- name: Build and Deploy
|
|
26
|
+
run: mkdocs gh-deploy --force
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
name: Lint
|
|
2
|
+
on:
|
|
3
|
+
push:
|
|
4
|
+
branches: [0.0.x]
|
|
5
|
+
pull_request:
|
|
6
|
+
branches: [0.0.x]
|
|
7
|
+
jobs:
|
|
8
|
+
lint:
|
|
9
|
+
runs-on: ubuntu-latest
|
|
10
|
+
steps:
|
|
11
|
+
- uses: actions/checkout@v4
|
|
12
|
+
- uses: astral-sh/ruff-action@v3
|
|
13
|
+
with:
|
|
14
|
+
args: check pluginator/ tests/
|
|
15
|
+
- uses: astral-sh/ruff-action@v3
|
|
16
|
+
with:
|
|
17
|
+
args: format --check pluginator/ tests/
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
name: Open New Version
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
workflow_dispatch:
|
|
5
|
+
inputs:
|
|
6
|
+
type:
|
|
7
|
+
description: "New version type"
|
|
8
|
+
required: true
|
|
9
|
+
type: choice
|
|
10
|
+
options: [minor, major]
|
|
11
|
+
|
|
12
|
+
permissions:
|
|
13
|
+
contents: write
|
|
14
|
+
|
|
15
|
+
jobs:
|
|
16
|
+
create-branch:
|
|
17
|
+
uses: qarium/ci/.github/workflows/library-new-version.yml@0.0.x
|
|
18
|
+
with:
|
|
19
|
+
type: ${{ inputs.type }}
|
|
20
|
+
secrets:
|
|
21
|
+
GH_TOKEN: ${{ secrets.GH_TOKEN }}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
name: Publish Release
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
workflow_dispatch:
|
|
5
|
+
|
|
6
|
+
permissions:
|
|
7
|
+
contents: write
|
|
8
|
+
id-token: write
|
|
9
|
+
|
|
10
|
+
jobs:
|
|
11
|
+
release:
|
|
12
|
+
uses: qarium/ci/.github/workflows/library-publish.yml@0.0.x
|
|
13
|
+
with:
|
|
14
|
+
src-package: 'pluginator'
|
|
15
|
+
secrets:
|
|
16
|
+
PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
|
|
17
|
+
ZAI_TOKEN: ${{ secrets.ZAI_TOKEN }}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
name: Strictacode
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches:
|
|
6
|
+
- 0.0.x
|
|
7
|
+
pull_request:
|
|
8
|
+
branches:
|
|
9
|
+
- 0.0.x
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
analyze:
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v4
|
|
16
|
+
with:
|
|
17
|
+
fetch-depth: 0
|
|
18
|
+
|
|
19
|
+
- uses: actions/setup-python@v5
|
|
20
|
+
with:
|
|
21
|
+
python-version: "3.13"
|
|
22
|
+
|
|
23
|
+
- uses: actions/cache@v4
|
|
24
|
+
with:
|
|
25
|
+
path: ~/.cache/pip
|
|
26
|
+
key: ${{ runner.os }}-pip-${{ hashFiles('**/pyproject.toml') }}
|
|
27
|
+
restore-keys: |
|
|
28
|
+
${{ runner.os }}-pip-
|
|
29
|
+
|
|
30
|
+
- uses: qarium/strictacode/.github/actions/analyze@0.0.x
|
|
31
|
+
with:
|
|
32
|
+
install-cmd: pip install strictacode
|
|
33
|
+
working-directory: pluginator
|
|
34
|
+
env:
|
|
35
|
+
STRICTACODE_SCORE: 40
|
|
36
|
+
STRICTACODE_RP: 40
|
|
37
|
+
STRICTACODE_SCORE_DIFF: 3
|
|
38
|
+
STRICTACODE_RP_DIFF: 5
|
|
39
|
+
STRICTACODE_OP: 40
|
|
40
|
+
STRICTACODE_IMB: 35
|
|
41
|
+
STRICTACODE_DENSITY: 30
|
|
42
|
+
STRICTACODE_OP_DIFF: 5
|
|
43
|
+
STRICTACODE_DENSITY_DIFF: 3
|
|
@@ -0,0 +1,210 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[codz]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
share/python-wheels/
|
|
24
|
+
*.egg-info/
|
|
25
|
+
.installed.cfg
|
|
26
|
+
*.egg
|
|
27
|
+
MANIFEST
|
|
28
|
+
|
|
29
|
+
# PyInstaller
|
|
30
|
+
# Usually these files are written by a python script from a template
|
|
31
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
32
|
+
*.manifest
|
|
33
|
+
*.spec
|
|
34
|
+
|
|
35
|
+
# Installer logs
|
|
36
|
+
pip-log.txt
|
|
37
|
+
pip-delete-this-directory.txt
|
|
38
|
+
|
|
39
|
+
# Unit test / coverage reports
|
|
40
|
+
htmlcov/
|
|
41
|
+
.tox/
|
|
42
|
+
.nox/
|
|
43
|
+
.coverage
|
|
44
|
+
.coverage.*
|
|
45
|
+
.cache
|
|
46
|
+
nosetests.xml
|
|
47
|
+
coverage.xml
|
|
48
|
+
*.cover
|
|
49
|
+
*.py.cover
|
|
50
|
+
.hypothesis/
|
|
51
|
+
.pytest_cache/
|
|
52
|
+
cover/
|
|
53
|
+
|
|
54
|
+
# Translations
|
|
55
|
+
*.mo
|
|
56
|
+
*.pot
|
|
57
|
+
|
|
58
|
+
# Django stuff:
|
|
59
|
+
*.log
|
|
60
|
+
local_settings.py
|
|
61
|
+
db.sqlite3
|
|
62
|
+
db.sqlite3-journal
|
|
63
|
+
|
|
64
|
+
# Flask stuff:
|
|
65
|
+
instance/
|
|
66
|
+
.webassets-cache
|
|
67
|
+
|
|
68
|
+
# Scrapy stuff:
|
|
69
|
+
.scrapy
|
|
70
|
+
|
|
71
|
+
# Sphinx documentation
|
|
72
|
+
docs/_build/
|
|
73
|
+
|
|
74
|
+
# PyBuilder
|
|
75
|
+
.pybuilder/
|
|
76
|
+
target/
|
|
77
|
+
|
|
78
|
+
# Jupyter Notebook
|
|
79
|
+
.ipynb_checkpoints
|
|
80
|
+
|
|
81
|
+
# IPython
|
|
82
|
+
profile_default/
|
|
83
|
+
ipython_config.py
|
|
84
|
+
|
|
85
|
+
# pyenv
|
|
86
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
87
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
88
|
+
# .python-version
|
|
89
|
+
|
|
90
|
+
# pipenv
|
|
91
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
92
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
93
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
94
|
+
# install all needed dependencies.
|
|
95
|
+
#Pipfile.lock
|
|
96
|
+
|
|
97
|
+
# UV
|
|
98
|
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
|
99
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
100
|
+
# commonly ignored for libraries.
|
|
101
|
+
#uv.lock
|
|
102
|
+
|
|
103
|
+
# poetry
|
|
104
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
105
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
106
|
+
# commonly ignored for libraries.
|
|
107
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
108
|
+
#poetry.lock
|
|
109
|
+
#poetry.toml
|
|
110
|
+
|
|
111
|
+
# pdm
|
|
112
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
113
|
+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
|
|
114
|
+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
|
|
115
|
+
#pdm.lock
|
|
116
|
+
#pdm.toml
|
|
117
|
+
.pdm-python
|
|
118
|
+
.pdm-build/
|
|
119
|
+
|
|
120
|
+
# pixi
|
|
121
|
+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
|
|
122
|
+
#pixi.lock
|
|
123
|
+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
|
|
124
|
+
# in the .venv directory. It is recommended not to include this directory in version control.
|
|
125
|
+
.pixi
|
|
126
|
+
|
|
127
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
128
|
+
__pypackages__/
|
|
129
|
+
|
|
130
|
+
# Celery stuff
|
|
131
|
+
celerybeat-schedule
|
|
132
|
+
celerybeat.pid
|
|
133
|
+
|
|
134
|
+
# SageMath parsed files
|
|
135
|
+
*.sage.py
|
|
136
|
+
|
|
137
|
+
# Environments
|
|
138
|
+
.env
|
|
139
|
+
.envrc
|
|
140
|
+
.venv
|
|
141
|
+
env/
|
|
142
|
+
venv/
|
|
143
|
+
ENV/
|
|
144
|
+
env.bak/
|
|
145
|
+
venv.bak/
|
|
146
|
+
|
|
147
|
+
# Spyder project settings
|
|
148
|
+
.spyderproject
|
|
149
|
+
.spyproject
|
|
150
|
+
|
|
151
|
+
# Rope project settings
|
|
152
|
+
.ropeproject
|
|
153
|
+
|
|
154
|
+
# mkdocs documentation
|
|
155
|
+
/site
|
|
156
|
+
|
|
157
|
+
# mypy
|
|
158
|
+
.mypy_cache/
|
|
159
|
+
.dmypy.json
|
|
160
|
+
dmypy.json
|
|
161
|
+
|
|
162
|
+
# Pyre type checker
|
|
163
|
+
.pyre/
|
|
164
|
+
|
|
165
|
+
# pytype static type analyzer
|
|
166
|
+
.pytype/
|
|
167
|
+
|
|
168
|
+
# Cython debug symbols
|
|
169
|
+
cython_debug/
|
|
170
|
+
|
|
171
|
+
# PyCharm
|
|
172
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
173
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
174
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
175
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
176
|
+
.idea/
|
|
177
|
+
|
|
178
|
+
# Abstra
|
|
179
|
+
# Abstra is an AI-powered process automation framework.
|
|
180
|
+
# Ignore directories containing user credentials, local state, and settings.
|
|
181
|
+
# Learn more at https://abstra.io/docs
|
|
182
|
+
.abstra/
|
|
183
|
+
|
|
184
|
+
# Visual Studio Code
|
|
185
|
+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
|
|
186
|
+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
|
187
|
+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
|
|
188
|
+
# you could uncomment the following to ignore the entire vscode folder
|
|
189
|
+
# .vscode/
|
|
190
|
+
|
|
191
|
+
# Ruff stuff:
|
|
192
|
+
.ruff_cache/
|
|
193
|
+
|
|
194
|
+
# PyPI configuration file
|
|
195
|
+
.pypirc
|
|
196
|
+
|
|
197
|
+
# Cursor
|
|
198
|
+
# Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
|
|
199
|
+
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
|
|
200
|
+
# refer to https://docs.cursor.com/context/ignore-files
|
|
201
|
+
.cursorignore
|
|
202
|
+
.cursorindexingignore
|
|
203
|
+
|
|
204
|
+
# Marimo
|
|
205
|
+
marimo/_static/
|
|
206
|
+
marimo/_lsp/
|
|
207
|
+
__marimo__/
|
|
208
|
+
|
|
209
|
+
# Agents
|
|
210
|
+
.claude/
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# DevOps
|
|
2
|
+
|
|
3
|
+
## Config
|
|
4
|
+
|
|
5
|
+
| Key | Value | Description |
|
|
6
|
+
|----------------|------------------|---------------------------------------------|
|
|
7
|
+
| ci_provider | github-actions | CI provider |
|
|
8
|
+
| trigger_branch | 0.0.x | Default branch for triggers |
|
|
9
|
+
| diff_range | HEAD~5 | Git diff range for auto-analysis in feature |
|
|
10
|
+
|
|
11
|
+
## Rules
|
|
12
|
+
|
|
13
|
+
### Workflow Registry
|
|
14
|
+
|
|
15
|
+
| Workflow | File | Trigger | Purpose |
|
|
16
|
+
|-------------|-------------------|-----------------------------------------------|----------------------------------------------|
|
|
17
|
+
| Lint | lint.yml | push/PR to 0.0.x | Ruff lint + format check |
|
|
18
|
+
| Tests | tests.yml | push/PR to 0.0.x | Pytest across Python 3.10–3.14 |
|
|
19
|
+
| Docs | docs.yml | push to 0.0.x | MkDocs build + deploy to GitHub Pages |
|
|
20
|
+
| Publish | publish.yml | workflow_dispatch from X.Y.x branch | Build, publish to PyPI, create GitHub Release|
|
|
21
|
+
| New Version | new_version.yml | workflow_dispatch from default branch | Create X.Y.x branch, set as default |
|
|
22
|
+
| Strictacode | strictacode.yml | push/PR to 0.0.x | Code quality analysis |
|
|
23
|
+
|
|
24
|
+
### Conventions
|
|
25
|
+
|
|
26
|
+
- `tests.yml`, `publish.yml`, `new_version.yml` — caller-паттерн (`uses: qarium/ci`), не содержат steps
|
|
27
|
+
- `lint.yml`, `docs.yml`, `strictacode.yml` — project-specific, полная реализация
|
|
28
|
+
|
|
29
|
+
## Lessons
|
|
30
|
+
|
|
31
|
+
| Problem | Why | How to prevent |
|
|
32
|
+
|---------|-----|----------------|
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Lead
|
|
2
|
+
|
|
3
|
+
## Config
|
|
4
|
+
|
|
5
|
+
| Key | Value | Description |
|
|
6
|
+
|----------------|--------|----------------------------------------------|
|
|
7
|
+
| default_branch | master | Default branch for CI triggers and diff base |
|
|
8
|
+
|
|
9
|
+
## Architecture & Decisions
|
|
10
|
+
- **Plugin framework for pytest with decorator DSL** — `@plugin()` class decorator + `option()` factory define plugins with config, actions, CLI options, env vars, and dependency checking
|
|
11
|
+
- **Descriptor-based multi-source option resolution** — PluginOption uses `__get__`/`__set_name__` with priority: plugin_config_key > env_var > command_line > default_from
|
|
12
|
+
- **Metaclass wraps pytest_addoption with called_once** — BasePluginMeta prevents duplicate CLI option registration
|
|
13
|
+
- **Action pattern with lazy evaluation** — supports both immediate and lazy action execution via deepcopy of ActionContext
|
|
14
|
+
|
|
15
|
+
## Project Structure
|
|
16
|
+
- **define.py — public API decorators** — `@plugin()` and `option()` are the main user-facing entry points
|
|
17
|
+
- **pytest.py — pytest integration layer** — BasePlugin, PluginMeta, CommandLine, PluginOption, install_pytest_plugins
|
|
18
|
+
- **actions.py — action execution engine** — Action, ActionContext, ActionManager with configure/execute lifecycle
|
|
19
|
+
- **utils.py — introspection utility** — `call_context()` accesses caller's globals via `inspect.stack()` for transparent pytest hook injection
|
|
20
|
+
|
|
21
|
+
## Code Patterns
|
|
22
|
+
- **PyHamcrest for test assertions** — `h.assert_that` with matchers, not plain assert or pytest.raises
|
|
23
|
+
- **Pytest internal APIs** — imports from `_pytest.main`, `_pytest.config` for tight pytest integration (not the public API)
|
|
24
|
+
- **typing.Optional for nullable types** — `t.Optional[X]` everywhere, not `X | None` (Python 3.10 compat)
|
|
25
|
+
- **Relative package imports** — `from .module import Class` consistently across the package
|
|
26
|
+
|
|
27
|
+
## TODO
|
|
28
|
+
<!-- empty -->
|
|
29
|
+
|
|
30
|
+
## LLM Directives
|
|
31
|
+
<!-- empty -->
|
|
32
|
+
|
|
33
|
+
## Lessons
|
|
34
|
+
|
|
35
|
+
| Problem | Why | How to prevent |
|
|
36
|
+
|---------|-----|----------------|
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
## Config
|
|
2
|
+
|
|
3
|
+
| Setting | Value |
|
|
4
|
+
|------------------|------------------------------------------|
|
|
5
|
+
| run_tests_cmd | pytest --tb=short |
|
|
6
|
+
| lint_cmd | ruff check pluginator/ tests/ |
|
|
7
|
+
| lint_fix_cmd | ruff check --fix pluginator/ tests/ |
|
|
8
|
+
| format_cmd | ruff format --check pluginator/ tests/ |
|
|
9
|
+
| format_fix_cmd | ruff format pluginator/ tests/ |
|
|
10
|
+
|
|
11
|
+
## Rules
|
|
12
|
+
|
|
13
|
+
Project test configuration. Used by the `qarium:employees:qa:feature` skill.
|
|
14
|
+
|
|
15
|
+
### Mapping
|
|
16
|
+
|
|
17
|
+
| Source path pattern | Test directory | Notes |
|
|
18
|
+
|-----------------------|----------------------|---------------|
|
|
19
|
+
| `pluginator/**/*.py` | `tests/` | Mirror layout |
|
|
20
|
+
|
|
21
|
+
### Mock Patterns
|
|
22
|
+
|
|
23
|
+
| Pattern | Example |
|
|
24
|
+
|---------|---------|
|
|
25
|
+
|
|
26
|
+
### Helpers
|
|
27
|
+
|
|
28
|
+
| Helper | Location | Purpose |
|
|
29
|
+
|--------|----------|---------|
|
|
30
|
+
|
|
31
|
+
### Conventions
|
|
32
|
+
|
|
33
|
+
- Naming: `test_<what>_<scenario>`
|
|
34
|
+
- Never mock `builtins.open` — use `tmp_path` fixture
|
|
35
|
+
- Integration tests use `pytest.mark.skipif` when external tools unavailable
|
|
36
|
+
|
|
37
|
+
## Lessons
|
|
38
|
+
|
|
39
|
+
| Problem | Why | How to prevent |
|
|
40
|
+
|---------|-----|----------------|
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Tech Writer Config
|
|
2
|
+
|
|
3
|
+
## Config
|
|
4
|
+
|
|
5
|
+
| Key | Value | Description |
|
|
6
|
+
|---------------|------------------------------------------|-------------------------------------|
|
|
7
|
+
| build_cmd | mkdocs build | Build validation command |
|
|
8
|
+
| deploy_cmd | mkdocs gh-deploy --force | Deploy command |
|
|
9
|
+
| examples_file | docs/examples.md | File for usage examples |
|
|
10
|
+
| logo_url | https://avatars.githubusercontent.com/u/262344922?s=200&v=4 | Standard qarium logo |
|
|
11
|
+
| base_branch | 0.0.x | Base branch for git diff comparison |
|
|
12
|
+
|
|
13
|
+
## Rules
|
|
14
|
+
|
|
15
|
+
### Mapping
|
|
16
|
+
|
|
17
|
+
| Source path | Documentation files |
|
|
18
|
+
|-------------|---------------------|
|
|
19
|
+
|
|
20
|
+
### Conventions
|
|
21
|
+
|
|
22
|
+
## Lessons
|
|
23
|
+
|
|
24
|
+
| Problem | Why | How to prevent |
|
|
25
|
+
|---------|-----|----------------|
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: pluginator
|
|
3
|
+
Version: 0.0.0
|
|
4
|
+
Summary: Plugin management system
|
|
5
|
+
License: MIT
|
|
6
|
+
Classifier: Development Status :: 3 - Alpha
|
|
7
|
+
Classifier: Intended Audience :: Developers
|
|
8
|
+
Classifier: Programming Language :: Python :: 3
|
|
9
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
10
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
13
|
+
Requires-Python: >=3.10
|
|
14
|
+
Description-Content-Type: text/markdown
|
|
15
|
+
Requires-Dist: pyyaml>=6.0
|
|
16
|
+
Requires-Dist: qools>=0.0.0
|
|
17
|
+
Provides-Extra: test
|
|
18
|
+
Requires-Dist: pytest>=8.0; extra == "test"
|
|
19
|
+
Requires-Dist: pytest-cov>=5.0; extra == "test"
|
|
20
|
+
Requires-Dist: pytest-mock>=3.0; extra == "test"
|
|
21
|
+
Requires-Dist: ruff>=0.15.0; extra == "test"
|
|
22
|
+
Requires-Dist: pyhamcrest>=2.0; extra == "test"
|
|
23
|
+
Provides-Extra: docs
|
|
24
|
+
Requires-Dist: mkdocs>=1.5; extra == "docs"
|
|
25
|
+
Requires-Dist: mkdocs-material>=9.0; extra == "docs"
|
|
26
|
+
Requires-Dist: mkdocstrings[python]>=0.24; extra == "docs"
|
|
27
|
+
|
|
28
|
+
# pluginator
|
|
29
|
+
|
|
30
|
+
Plugin management system
|
|
31
|
+
|
|
32
|
+
## Installation
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
pip install pluginator
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Quick Start
|
|
39
|
+
|
|
40
|
+
```python
|
|
41
|
+
from pluginator import define
|
|
42
|
+
|
|
43
|
+
@define.plugin('my-plugin', config='config.yml')
|
|
44
|
+
class MyPlugin:
|
|
45
|
+
name = define.option(str, required=True, env_var='PLUGIN_NAME')
|
|
46
|
+
|
|
47
|
+
def configure(self):
|
|
48
|
+
print(f'Configured: {self.name}')
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Documentation
|
|
52
|
+
|
|
53
|
+
Full documentation: https://qarium.github.io/pluginator/
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# pluginator
|
|
2
|
+
|
|
3
|
+
Plugin management system
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pip install pluginator
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Quick Start
|
|
12
|
+
|
|
13
|
+
```python
|
|
14
|
+
from pluginator import define
|
|
15
|
+
|
|
16
|
+
@define.plugin('my-plugin', config='config.yml')
|
|
17
|
+
class MyPlugin:
|
|
18
|
+
name = define.option(str, required=True, env_var='PLUGIN_NAME')
|
|
19
|
+
|
|
20
|
+
def configure(self):
|
|
21
|
+
print(f'Configured: {self.name}')
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Documentation
|
|
25
|
+
|
|
26
|
+
Full documentation: https://qarium.github.io/pluginator/
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
# API Reference
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
# Configuration
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
# Examples
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
# Getting Started
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
{% extends "base.html" %}
|
|
2
|
+
|
|
3
|
+
{% block extrahead %}
|
|
4
|
+
{{ super() }}
|
|
5
|
+
<style>
|
|
6
|
+
/* Dark navbar — override palette in both themes */
|
|
7
|
+
[data-md-color-scheme=default][data-md-color-primary=custom],
|
|
8
|
+
[data-md-color-scheme=slate][data-md-color-primary=custom] {
|
|
9
|
+
--md-primary-fg-color: #0a0a13;
|
|
10
|
+
--md-primary-fg-color--light: #0a0a13cc;
|
|
11
|
+
--md-primary-bg-color: #ffffff;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
.md-header__button.md-logo img,
|
|
15
|
+
.md-header__button.md-logo svg {
|
|
16
|
+
width: 32px;
|
|
17
|
+
height: 32px;
|
|
18
|
+
border-radius: 50%;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
/* Search form — visible on dark header */
|
|
22
|
+
.md-search__overlay {
|
|
23
|
+
background-color: transparent !important;
|
|
24
|
+
}
|
|
25
|
+
[data-md-toggle=search]:checked~.md-header .md-search__overlay {
|
|
26
|
+
background-color: #0000008a !important;
|
|
27
|
+
}
|
|
28
|
+
.md-search__inner {
|
|
29
|
+
background-color: transparent !important;
|
|
30
|
+
}
|
|
31
|
+
.md-search__form {
|
|
32
|
+
background-color: #3a3a3a !important;
|
|
33
|
+
border-radius: 0.5rem;
|
|
34
|
+
}
|
|
35
|
+
.md-search__form:hover {
|
|
36
|
+
background-color: #4a4a4a !important;
|
|
37
|
+
}
|
|
38
|
+
.md-search__input {
|
|
39
|
+
color: #e0e0e0 !important;
|
|
40
|
+
}
|
|
41
|
+
.md-search__input::placeholder {
|
|
42
|
+
color: #999999 !important;
|
|
43
|
+
}
|
|
44
|
+
.md-search__icon {
|
|
45
|
+
color: #999999 !important;
|
|
46
|
+
}
|
|
47
|
+
.md-search__form:hover .md-search__icon,
|
|
48
|
+
.md-search__input:focus-visible ~ .md-search__icon {
|
|
49
|
+
color: #e0e0e0 !important;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/* Links in dark theme — readable on dark background */
|
|
53
|
+
[data-md-color-scheme=slate] .md-nav__link,
|
|
54
|
+
[data-md-color-scheme=slate] .md-toc__link,
|
|
55
|
+
[data-md-color-scheme=slate] article a {
|
|
56
|
+
color: #cbd5e0 !important;
|
|
57
|
+
}
|
|
58
|
+
[data-md-color-scheme=slate] .md-nav__link--passed,
|
|
59
|
+
[data-md-color-scheme=slate] .md-toc__link--passed {
|
|
60
|
+
color: #718096 !important;
|
|
61
|
+
}
|
|
62
|
+
[data-md-color-scheme=slate] .md-nav__link:hover,
|
|
63
|
+
[data-md-color-scheme=slate] .md-toc__link:hover,
|
|
64
|
+
[data-md-color-scheme=slate] article a:hover {
|
|
65
|
+
color: var(--md-accent-fg-color) !important;
|
|
66
|
+
}
|
|
67
|
+
</style>
|
|
68
|
+
{% endblock %}
|