pyrig-opensource 0.1.0__py3-none-any.whl
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.
- pyrig_opensource/__init__.py +1 -0
- pyrig_opensource/py.typed +0 -0
- pyrig_opensource/rig/__init__.py +5 -0
- pyrig_opensource/rig/cli/__init__.py +1 -0
- pyrig_opensource/rig/cli/commands/__init__.py +6 -0
- pyrig_opensource/rig/cli/commands/plugins.py +45 -0
- pyrig_opensource/rig/cli/subcommands.py +19 -0
- pyrig_opensource-0.1.0.dist-info/METADATA +121 -0
- pyrig_opensource-0.1.0.dist-info/RECORD +12 -0
- pyrig_opensource-0.1.0.dist-info/WHEEL +4 -0
- pyrig_opensource-0.1.0.dist-info/entry_points.txt +3 -0
- pyrig_opensource-0.1.0.dist-info/licenses/LICENSE +21 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"""Pyrig plugin that combines other pyrig plugins for open-source projects."""
|
|
File without changes
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"""Additional CLI commands contributed by this plugin."""
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
"""Backend implementations for this plugin's CLI commands.
|
|
2
|
+
|
|
3
|
+
Each module implements exactly one command as a plain callable, decoupled from
|
|
4
|
+
the CLI registration layer. This separation lets the registration layer import
|
|
5
|
+
commands lazily, loading each module only when its command is invoked.
|
|
6
|
+
"""
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
"""Backend implementation for the `plugins` CLI command.
|
|
2
|
+
|
|
3
|
+
Declares the fixed set of pyrig plugins this package bundles together, and
|
|
4
|
+
prints them to let users confirm what got installed.
|
|
5
|
+
"""
|
|
6
|
+
|
|
7
|
+
from types import ModuleType
|
|
8
|
+
|
|
9
|
+
import pyrig
|
|
10
|
+
import pyrig_codecov
|
|
11
|
+
import pyrig_codeql
|
|
12
|
+
import pyrig_fixtures
|
|
13
|
+
import pyrig_public
|
|
14
|
+
import pyrig_pypi
|
|
15
|
+
import typer
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
def show_plugins() -> None:
|
|
19
|
+
"""Print every plugin bundled by this plugin, one per line.
|
|
20
|
+
|
|
21
|
+
Each line is the `str()` of the plugin's module object, e.g.
|
|
22
|
+
`<module 'pyrig' from '...'>`.
|
|
23
|
+
"""
|
|
24
|
+
for plugin in plugins():
|
|
25
|
+
typer.echo(plugin)
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
def plugins() -> tuple[ModuleType, ...]:
|
|
29
|
+
"""Return every pyrig plugin bundled together by this plugin.
|
|
30
|
+
|
|
31
|
+
Returns:
|
|
32
|
+
Tuple of the imported plugin modules, in dependency order.
|
|
33
|
+
|
|
34
|
+
Note:
|
|
35
|
+
This list is maintained by hand, not discovered automatically. Keep
|
|
36
|
+
it in sync with this package's own runtime dependencies.
|
|
37
|
+
"""
|
|
38
|
+
return (
|
|
39
|
+
pyrig,
|
|
40
|
+
pyrig_codecov,
|
|
41
|
+
pyrig_codeql,
|
|
42
|
+
pyrig_fixtures,
|
|
43
|
+
pyrig_public,
|
|
44
|
+
pyrig_pypi,
|
|
45
|
+
)
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"""Project-specific CLI commands.
|
|
2
|
+
|
|
3
|
+
Functions defined directly in this module are registered as top-level CLI
|
|
4
|
+
commands. Module-level `typer.Typer` instances are registered as command
|
|
5
|
+
groups, with each group's name derived from the kebab-case form of the
|
|
6
|
+
variable name.
|
|
7
|
+
"""
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def plugins() -> None:
|
|
11
|
+
"""List the pyrig plugins bundled together by this plugin.
|
|
12
|
+
|
|
13
|
+
Prints one plugin per line, each shown as its module object's `str()`
|
|
14
|
+
(e.g. `<module 'pyrig' from '...'>`). Useful for confirming which plugins
|
|
15
|
+
were pulled in by installing this package.
|
|
16
|
+
"""
|
|
17
|
+
from pyrig_opensource.rig.cli.commands.plugins import show_plugins # noqa: PLC0415
|
|
18
|
+
|
|
19
|
+
show_plugins()
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: pyrig-opensource
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: A pyrig plugin that combines other pyrig plugins for open-source projects.
|
|
5
|
+
Keywords: pyrig
|
|
6
|
+
Author: Winipedia
|
|
7
|
+
Author-email: Winipedia <winipedia@gmx.de>
|
|
8
|
+
License-Expression: MIT
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Classifier: Operating System :: OS Independent
|
|
11
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
15
|
+
Classifier: Typing :: Typed
|
|
16
|
+
Requires-Dist: pyrig>=18.95.1
|
|
17
|
+
Requires-Dist: pyrig-codecov>=3.17.46
|
|
18
|
+
Requires-Dist: pyrig-codeql>=1.1.11
|
|
19
|
+
Requires-Dist: pyrig-fixtures>=2.25.3
|
|
20
|
+
Requires-Dist: pyrig-public>=1.1.1
|
|
21
|
+
Requires-Dist: pyrig-pypi>=3.20.47
|
|
22
|
+
Requires-Dist: pyrig-runtime>=3.24.3
|
|
23
|
+
Requires-Dist: typer>=0.27.2
|
|
24
|
+
Maintainer: Winipedia
|
|
25
|
+
Maintainer-email: Winipedia <winipedia@gmx.de>
|
|
26
|
+
Requires-Python: >=3.12
|
|
27
|
+
Project-URL: Changelog, https://github.com/Winipedia/pyrig-opensource/releases
|
|
28
|
+
Project-URL: Documentation, https://Winipedia.github.io/pyrig-opensource
|
|
29
|
+
Project-URL: Homepage, https://github.com/Winipedia/pyrig-opensource
|
|
30
|
+
Project-URL: Issues, https://github.com/Winipedia/pyrig-opensource/issues
|
|
31
|
+
Project-URL: Source, https://github.com/Winipedia/pyrig-opensource
|
|
32
|
+
Description-Content-Type: text/markdown
|
|
33
|
+
|
|
34
|
+
# pyrig-opensource
|
|
35
|
+
|
|
36
|
+
<!-- project-status -->
|
|
37
|
+
[](https://github.com/Winipedia/pyrig-opensource/actions/workflows/health_check.yml)
|
|
38
|
+
[](https://github.com/Winipedia/pyrig-opensource/actions/workflows/release.yml)
|
|
39
|
+
[](https://codecov.io/gh/Winipedia/pyrig-opensource)
|
|
40
|
+
<!-- code-quality -->
|
|
41
|
+
[](https://github.com/pre-commit/pre-commit-hooks)
|
|
42
|
+
[](https://github.com/rhysd/actionlint)
|
|
43
|
+
[](https://github.com/zizmorcore/zizmor)
|
|
44
|
+
[](https://github.com/pre-commit/pre-commit-hooks)
|
|
45
|
+
[](https://github.com/osprey-oss/deptry)
|
|
46
|
+
[](https://github.com/pre-commit/pre-commit-hooks)
|
|
47
|
+
[](https://github.com/pre-commit/pre-commit-hooks)
|
|
48
|
+
[](https://github.com/pre-commit/pre-commit-hooks)
|
|
49
|
+
[](https://github.com/pre-commit/pre-commit-hooks)
|
|
50
|
+
[](https://github.com/pre-commit/pre-commit-hooks)
|
|
51
|
+
[](https://github.com/rvben/rumdl)
|
|
52
|
+
[](https://github.com/pre-commit/pre-commit-hooks)
|
|
53
|
+
[](https://github.com/pre-commit/pre-commit-hooks)
|
|
54
|
+
[](https://github.com/astral-sh/ruff)
|
|
55
|
+
[](https://github.com/Yelp/detect-secrets)
|
|
56
|
+
[](https://github.com/PyCQA/bandit)
|
|
57
|
+
[](https://github.com/mvdan/sh)
|
|
58
|
+
[](https://github.com/koalaman/shellcheck)
|
|
59
|
+
[](https://github.com/crate-ci/typos)
|
|
60
|
+
[](https://github.com/tombi-toml/tombi)
|
|
61
|
+
[](https://github.com/pre-commit/pre-commit-hooks)
|
|
62
|
+
[](https://github.com/astral-sh/ty)
|
|
63
|
+
[](https://github.com/owenlamont/ryl)
|
|
64
|
+
<!-- tooling -->
|
|
65
|
+
[](https://github.com/astral-sh/uv)
|
|
66
|
+
[](https://github.com/Winipedia/pyrig)
|
|
67
|
+
[](https://github.com/Winipedia/pyrig-opensource)
|
|
68
|
+
[](https://github.com/j178/prek)
|
|
69
|
+
[](https://git-scm.com)
|
|
70
|
+
<!-- project-info -->
|
|
71
|
+
[](https://Winipedia.github.io/pyrig-opensource)
|
|
72
|
+
[](https://pypi.org/project/pyrig-opensource)
|
|
73
|
+
[](https://www.python.org)
|
|
74
|
+
[](https://github.com/Winipedia/pyrig-opensource/blob/main/LICENSE)
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
> A pyrig plugin that combines other pyrig plugins for open-source projects.
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## Overview
|
|
83
|
+
|
|
84
|
+
pyrig-opensource is a [pyrig](https://github.com/Winipedia/pyrig) plugin that
|
|
85
|
+
bundles the plugins recommended for a public, open-source project into a
|
|
86
|
+
single dependency:
|
|
87
|
+
|
|
88
|
+
- [`pyrig-codecov`](https://github.com/Winipedia/pyrig-codecov) — uploads
|
|
89
|
+
coverage reports to Codecov.
|
|
90
|
+
- [`pyrig-codeql`](https://github.com/Winipedia/pyrig-codeql) — enables
|
|
91
|
+
GitHub CodeQL security scanning.
|
|
92
|
+
- [`pyrig-fixtures`](https://github.com/Winipedia/pyrig-fixtures) — shares
|
|
93
|
+
pytest fixtures across dependent packages.
|
|
94
|
+
- [`pyrig-public`](https://github.com/Winipedia/pyrig-public) — configures
|
|
95
|
+
GitHub features for public repositories.
|
|
96
|
+
- [`pyrig-pypi`](https://github.com/Winipedia/pyrig-pypi) — publishes
|
|
97
|
+
releases to PyPI.
|
|
98
|
+
|
|
99
|
+
## What it adds
|
|
100
|
+
|
|
101
|
+
- **One dependency instead of five** — installing pyrig-opensource pulls in
|
|
102
|
+
and activates all of the plugins above, instead of adding each one
|
|
103
|
+
individually.
|
|
104
|
+
- **A `plugins` CLI command** — prints every bundled plugin so you can
|
|
105
|
+
confirm what got installed.
|
|
106
|
+
|
|
107
|
+
## Usage
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
uv add pyrig-opensource --dev
|
|
111
|
+
uv run pyrig sync
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
uv run pyrig-opensource plugins
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## Documentation
|
|
119
|
+
|
|
120
|
+
Full documentation, including the auto-generated API reference, is available on
|
|
121
|
+
the [documentation site](https://Winipedia.github.io/pyrig-opensource).
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
pyrig_opensource/__init__.py,sha256=Ogr7eQJoD-GTS3rWmTSysz1kvDrZv-YYXFVLehujbgs,79
|
|
2
|
+
pyrig_opensource/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
3
|
+
pyrig_opensource/rig/__init__.py,sha256=9A8Dd8HP7dHoWp5uOsPociQEuD7SOT6U-lYx3eTsm9w,209
|
|
4
|
+
pyrig_opensource/rig/cli/__init__.py,sha256=KKH9bcB_rgReZtkSoSlqPJBd4KxWyQ0Kffau7emV5cs,58
|
|
5
|
+
pyrig_opensource/rig/cli/commands/__init__.py,sha256=JOj_jBCwzORrpgJEXlqx5M7Am4GITm7UcAK4umTLg8g,293
|
|
6
|
+
pyrig_opensource/rig/cli/commands/plugins.py,sha256=KnGsBRtGGtc_Fw9iPhHDCame_WYuSGolHZHxkiDx1m8,1102
|
|
7
|
+
pyrig_opensource/rig/cli/subcommands.py,sha256=E6ayrtWas1dBYS58zssTMoj-7r2vEi1lIQxYqkNiq5c,676
|
|
8
|
+
pyrig_opensource-0.1.0.dist-info/licenses/LICENSE,sha256=bq9F9vtTB9CLiLEiaapOI_7SyICeXX4ZcI-DHOH1bv0,1066
|
|
9
|
+
pyrig_opensource-0.1.0.dist-info/WHEEL,sha256=VOHKyukui3UMeyUkkBf5F7N5xN_6X6W7zHVvalNVVvI,81
|
|
10
|
+
pyrig_opensource-0.1.0.dist-info/entry_points.txt,sha256=469dh--7KRlUyY6baCYjHr8LkUFUIrG8ICbbxyBaJ_I,70
|
|
11
|
+
pyrig_opensource-0.1.0.dist-info/METADATA,sha256=bkiQqsZvdbSEZV2Ses1-1GGHLoKKv0Wd-HRJghj2WkM,7541
|
|
12
|
+
pyrig_opensource-0.1.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Winipedia
|
|
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.
|