lupaxa-github-intel 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.
- lupaxa/github_intel/__init__.py +13 -0
- lupaxa/github_intel/__main__.py +8 -0
- lupaxa/github_intel/app.py +493 -0
- lupaxa/github_intel/checks/__init__.py +1 -0
- lupaxa/github_intel/checks/base.py +17 -0
- lupaxa/github_intel/checks/releases.py +59 -0
- lupaxa/github_intel/checks/workflows.py +34 -0
- lupaxa/github_intel/cli.py +699 -0
- lupaxa/github_intel/config/__init__.py +1 -0
- lupaxa/github_intel/config/defaults.py +150 -0
- lupaxa/github_intel/config/editor.py +316 -0
- lupaxa/github_intel/config/loader.py +412 -0
- lupaxa/github_intel/config/models.py +310 -0
- lupaxa/github_intel/config/paths.py +84 -0
- lupaxa/github_intel/config/profiles.py +143 -0
- lupaxa/github_intel/constants.py +54 -0
- lupaxa/github_intel/dates.py +179 -0
- lupaxa/github_intel/errors.py +72 -0
- lupaxa/github_intel/github/__init__.py +1 -0
- lupaxa/github_intel/github/auth.py +40 -0
- lupaxa/github_intel/github/client.py +239 -0
- lupaxa/github_intel/github/rate_limit.py +107 -0
- lupaxa/github_intel/layout.py +141 -0
- lupaxa/github_intel/logging_setup.py +51 -0
- lupaxa/github_intel/present.py +361 -0
- lupaxa/github_intel/reports/__init__.py +1 -0
- lupaxa/github_intel/reports/render.py +113 -0
- lupaxa/github_intel/storage/__init__.py +1 -0
- lupaxa/github_intel/storage/database.py +419 -0
- lupaxa/github_intel/sync/__init__.py +1 -0
- lupaxa/github_intel/sync/engine.py +671 -0
- lupaxa/github_intel/sync/summary.py +308 -0
- lupaxa/github_intel/tui/__init__.py +1 -0
- lupaxa/github_intel/tui/application.py +487 -0
- lupaxa/github_intel/views.py +896 -0
- lupaxa_github_intel-0.1.0.dist-info/METADATA +180 -0
- lupaxa_github_intel-0.1.0.dist-info/RECORD +41 -0
- lupaxa_github_intel-0.1.0.dist-info/WHEEL +5 -0
- lupaxa_github_intel-0.1.0.dist-info/entry_points.txt +2 -0
- lupaxa_github_intel-0.1.0.dist-info/licenses/LICENCE +21 -0
- lupaxa_github_intel-0.1.0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: lupaxa-github-intel
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Monitor an explicit collection of GitHub repositories from the local machine.
|
|
5
|
+
Author: The Lupaxa Project
|
|
6
|
+
Maintainer: The Lupaxa Project
|
|
7
|
+
License-Expression: MIT
|
|
8
|
+
Project-URL: Homepage, https://github.com/lupaxa-gh-toolbox/github-intel
|
|
9
|
+
Project-URL: Documentation, https://github-intel.thelupaxaproject.org/
|
|
10
|
+
Project-URL: Repository, https://github.com/lupaxa-gh-toolbox/github-intel
|
|
11
|
+
Project-URL: Issues, https://github.com/lupaxa-gh-toolbox/github-intel/issues
|
|
12
|
+
Keywords: cli,github,github-intel,python,toolbox
|
|
13
|
+
Classifier: Development Status :: 2 - Pre-Alpha
|
|
14
|
+
Classifier: Environment :: Console
|
|
15
|
+
Classifier: Intended Audience :: Developers
|
|
16
|
+
Classifier: Natural Language :: English
|
|
17
|
+
Classifier: Operating System :: MacOS
|
|
18
|
+
Classifier: Operating System :: Microsoft :: Windows
|
|
19
|
+
Classifier: Operating System :: POSIX
|
|
20
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
21
|
+
Classifier: Programming Language :: Python
|
|
22
|
+
Classifier: Programming Language :: Python :: 3
|
|
23
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
24
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
25
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
26
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
27
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
28
|
+
Classifier: Topic :: Software Development
|
|
29
|
+
Requires-Python: >=3.11
|
|
30
|
+
Description-Content-Type: text/markdown
|
|
31
|
+
License-File: LICENCE
|
|
32
|
+
Requires-Dist: aiosqlite<1,>=0.20
|
|
33
|
+
Requires-Dist: httpx<1,>=0.28
|
|
34
|
+
Requires-Dist: platformdirs<5,>=4
|
|
35
|
+
Requires-Dist: pydantic<3,>=2.10
|
|
36
|
+
Requires-Dist: rich<15,>=14
|
|
37
|
+
Requires-Dist: ruamel.yaml<0.19,>=0.18
|
|
38
|
+
Requires-Dist: textual<9,>=3
|
|
39
|
+
Requires-Dist: typer<1,>=0.15
|
|
40
|
+
Provides-Extra: dev
|
|
41
|
+
Requires-Dist: build<2.0.0,>=1.2.2; extra == "dev"
|
|
42
|
+
Requires-Dist: mkdocs==1.6.1; extra == "dev"
|
|
43
|
+
Requires-Dist: mkdocs-material==9.7.7; extra == "dev"
|
|
44
|
+
Requires-Dist: mypy<2.0.0,>=1.17.0; extra == "dev"
|
|
45
|
+
Requires-Dist: pre-commit<5.0.0,>=4.2.0; extra == "dev"
|
|
46
|
+
Requires-Dist: pytest<9.0.0,>=8.4.0; extra == "dev"
|
|
47
|
+
Requires-Dist: pytest-asyncio<2,>=1.5; extra == "dev"
|
|
48
|
+
Requires-Dist: pytest-cov<7.0.0,>=6.2.0; extra == "dev"
|
|
49
|
+
Requires-Dist: respx<1,>=0.22; extra == "dev"
|
|
50
|
+
Requires-Dist: ruff<1.0.0,>=0.12.0; extra == "dev"
|
|
51
|
+
Requires-Dist: twine<7.0.0,>=6.1.0; extra == "dev"
|
|
52
|
+
Requires-Dist: types-setuptools<81.0.0,>=80.1.7; extra == "dev"
|
|
53
|
+
Provides-Extra: test
|
|
54
|
+
Requires-Dist: pytest>=8.4; extra == "test"
|
|
55
|
+
Requires-Dist: pytest-asyncio<2,>=1.5; extra == "test"
|
|
56
|
+
Requires-Dist: pytest-cov>=5.0; extra == "test"
|
|
57
|
+
Requires-Dist: respx<1,>=0.22; extra == "test"
|
|
58
|
+
Dynamic: license-file
|
|
59
|
+
|
|
60
|
+
<p align="center">
|
|
61
|
+
<a href="https://github.com/lupaxa-gh-toolbox">
|
|
62
|
+
<img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/gh-toolbox/readme-logo.png" alt="The Lupaxa Project: GitHub Toolbox" />
|
|
63
|
+
</a>
|
|
64
|
+
</p>
|
|
65
|
+
|
|
66
|
+
<h1 align="center">GitHub Intel</h1>
|
|
67
|
+
|
|
68
|
+
**GitHub Intel** monitors an explicit list of GitHub repositories. It stores the results locally and can show them without a network connection. Groups organise the list. Profiles decide which checks run.
|
|
69
|
+
|
|
70
|
+
## Features
|
|
71
|
+
|
|
72
|
+
- An explicit repository list. Nothing is discovered.
|
|
73
|
+
- Profiles for releases, workflows, issues, pull requests, and quality.
|
|
74
|
+
- Profile inheritance. An explicit false overrides an inherited true.
|
|
75
|
+
- A local SQLite cache, so lists and reports work offline.
|
|
76
|
+
- Release and workflow checks, without a file inventory or an issues list.
|
|
77
|
+
- Human tables, JSON, CSV, and Markdown.
|
|
78
|
+
- A terminal interface for the same cached view.
|
|
79
|
+
- Dates in a configurable pattern. The default is `DD/MM/YYYY HH:mm UTC`.
|
|
80
|
+
- Authentication through the GitHub CLI. The token is not stored.
|
|
81
|
+
|
|
82
|
+
## Installation
|
|
83
|
+
|
|
84
|
+
Install the latest release from PyPI.
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
pip install lupaxa-github-intel
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Verify the installation.
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
github-intel --version
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Private repositories use the GitHub CLI login:
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
gh auth login
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
## Quick Start
|
|
103
|
+
|
|
104
|
+
The first `repo add` creates `~/.config/github-intel/`.
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
github-intel repo add owner/name --group examples --profile upstream
|
|
108
|
+
github-intel config validate
|
|
109
|
+
github-intel sync
|
|
110
|
+
github-intel repo list
|
|
111
|
+
github-intel repo show owner name
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
`github-intel` with no arguments opens the terminal interface when the terminal is interactive.
|
|
115
|
+
|
|
116
|
+
## Command-Line Interface
|
|
117
|
+
|
|
118
|
+
`github-intel repo list` reads the cache. `github-intel sync` is the command that calls GitHub.
|
|
119
|
+
|
|
120
|
+
### Repositories
|
|
121
|
+
|
|
122
|
+
| Command | Description |
|
|
123
|
+
| -------------------------------------------------- | ------------------------------------------------ |
|
|
124
|
+
| `github-intel repo add OWNER/NAME` | Add a repository. This does not call GitHub |
|
|
125
|
+
| `github-intel repo list` | Show the cached table |
|
|
126
|
+
| `github-intel repo show ORG REPO` | Show one repository |
|
|
127
|
+
| `github-intel repo set-profile OWNER/NAME PROFILE` | Choose the checks for one repository |
|
|
128
|
+
|
|
129
|
+
### Synchronisation and Reports
|
|
130
|
+
|
|
131
|
+
| Command | Description |
|
|
132
|
+
| -------------------------------- | ------------------------------------------------ |
|
|
133
|
+
| `github-intel sync` | Refresh stale or missing information |
|
|
134
|
+
| `github-intel sync --force` | Ignore cache freshness and `sync.interval` |
|
|
135
|
+
| `github-intel report` | Write a Markdown report |
|
|
136
|
+
| `github-intel audit` | Show repositories with failing checks |
|
|
137
|
+
|
|
138
|
+
### Configuration
|
|
139
|
+
|
|
140
|
+
| Command | Description |
|
|
141
|
+
| -------------------------------- | ------------------------------------------------ |
|
|
142
|
+
| `github-intel config init` | Write the default files. `--force` overwrites |
|
|
143
|
+
| `github-intel config validate` | Load the files and report the repository count |
|
|
144
|
+
| `github-intel config paths` | Print configuration and cache paths |
|
|
145
|
+
| `github-intel profile show NAME` | Show the effective checks |
|
|
146
|
+
|
|
147
|
+
> **Note:** `--config FILE` selects a different main file. Without it, the files are `config.yml`, `profiles.yml`, and `repositories.yml` in `~/.config/github-intel/`.
|
|
148
|
+
|
|
149
|
+
## Documentation
|
|
150
|
+
|
|
151
|
+
Online documentation:
|
|
152
|
+
|
|
153
|
+
[https://github-intel.thelupaxaproject.org/](https://github-intel.thelupaxaproject.org/)
|
|
154
|
+
|
|
155
|
+
Serve the docs locally:
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
make init
|
|
159
|
+
make python-install-dev
|
|
160
|
+
make mkdocs-serve
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
## Development
|
|
164
|
+
|
|
165
|
+
Install makefile skills, then the development extra:
|
|
166
|
+
|
|
167
|
+
```bash
|
|
168
|
+
make init
|
|
169
|
+
make python-install-dev
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
Lint, type-check, and test:
|
|
173
|
+
|
|
174
|
+
```bash
|
|
175
|
+
make python-check
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
<a href="https://github.com/the-lupaxa-project">
|
|
179
|
+
<img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
|
|
180
|
+
</a>
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
lupaxa/github_intel/__init__.py,sha256=HgC4ZGkwCNV0lAXcR80l7TjTvKs5dxMAq9lrf_3TUbY,159
|
|
2
|
+
lupaxa/github_intel/__main__.py,sha256=dHv6dXTtBZ9hPays9iNfJq07BkVMBH5Eb0M7CQSBIgA,163
|
|
3
|
+
lupaxa/github_intel/app.py,sha256=_Glw-atrDTZcs5Z1c6Do6Rr-0WZVOOmJ9sAJN9JQ_6M,14483
|
|
4
|
+
lupaxa/github_intel/cli.py,sha256=MTaxPWE_BBB8_CRXcOUYFBrvruZrjYbPmpW4I0sa2O0,20691
|
|
5
|
+
lupaxa/github_intel/constants.py,sha256=oa7OUT-0Y1jkAsPndRsqjT1RBYmdsJgwxVL-Ut98s2k,1211
|
|
6
|
+
lupaxa/github_intel/dates.py,sha256=caV-2aoPhfj1-tkIxMPL_jQ8VA1H5olwPXu0rKWrUms,5222
|
|
7
|
+
lupaxa/github_intel/errors.py,sha256=PmnNKk2AKNchhEn3KYbRTQa6vz-UzOiL71LcDklPw5o,1348
|
|
8
|
+
lupaxa/github_intel/layout.py,sha256=2RdPGFfci8F8hSN0MBcdfy2vQCMz75lNQeJyBq2Upz0,3392
|
|
9
|
+
lupaxa/github_intel/logging_setup.py,sha256=4wRtuJ8jkw1zpWWh3Xed1Re56btZ624Cu9ZS4Cj9lTA,1356
|
|
10
|
+
lupaxa/github_intel/present.py,sha256=sZfeb2VM4oj2NzIwGRxDaE_eYddKI69btOTqi2_MqTE,9732
|
|
11
|
+
lupaxa/github_intel/views.py,sha256=YxeLGxdAitf4_ZvbagT6IJFNPwS97nkDJErOBpoePjk,26529
|
|
12
|
+
lupaxa/github_intel/checks/__init__.py,sha256=tDdas3wRNFQG0Uk_rsvLUCtwq5x4RQt4FhnipPvCjy8,33
|
|
13
|
+
lupaxa/github_intel/checks/base.py,sha256=qEiZzC-b70u4srI99JFU7AptOpnXF67n327ypyxPSvc,281
|
|
14
|
+
lupaxa/github_intel/checks/releases.py,sha256=L5F3U4xRrLYhHJ4kGpNAajhbsy0HEWeDAXrgLHTl7zA,1827
|
|
15
|
+
lupaxa/github_intel/checks/workflows.py,sha256=RSw1xEOlEiIu9zkYfObWJb8oAIHIgqDaGid8Fbw26no,917
|
|
16
|
+
lupaxa/github_intel/config/__init__.py,sha256=SXidf0bFGX0vlWU0aAFCM4rCC9FLaccJq0dfFIs2MeQ,61
|
|
17
|
+
lupaxa/github_intel/config/defaults.py,sha256=hnpV0Wtz9jXagbnLyWooFrKr1iBYBbnPe20rZpYBf54,2929
|
|
18
|
+
lupaxa/github_intel/config/editor.py,sha256=GfGv0OlbhTXxSZiQ2kZZgQeSKDOALVzQ_WskmG4LSWY,9313
|
|
19
|
+
lupaxa/github_intel/config/loader.py,sha256=oHbjOcX_rJoeL9xCYVb884bKGo5KkOa29fhfyUBdP20,13407
|
|
20
|
+
lupaxa/github_intel/config/models.py,sha256=AN1QOY318SNGzV82dyEsu171UFiD04IlsZ4qqVeTBoo,9576
|
|
21
|
+
lupaxa/github_intel/config/paths.py,sha256=9CG3EduNbw-w0h9Lv-wxDOk7W1bJQR-St7kz5ECzVTc,2178
|
|
22
|
+
lupaxa/github_intel/config/profiles.py,sha256=dhfjsZJGr0iNKZXYZ9VBnJ4BbDqZTfGN1LtYnpp3tnU,3992
|
|
23
|
+
lupaxa/github_intel/github/__init__.py,sha256=_5wL49O8PyBvBW2zeirGZ3hzwRU-DBAFTwOYy-dsWHU,26
|
|
24
|
+
lupaxa/github_intel/github/auth.py,sha256=cwG7TCHYQGH0GKZx-vRRk50H4eSeQQKuepH22EoOZWk,1011
|
|
25
|
+
lupaxa/github_intel/github/client.py,sha256=ZZNrygUhBxX5nSNvps3Cy7AeZnjBeaiZ_vRoY6yJtbk,6960
|
|
26
|
+
lupaxa/github_intel/github/rate_limit.py,sha256=vbzQnDBBODJfyfQVX8BtnXCHIhNIbvkkMYOwBTtxvAQ,3088
|
|
27
|
+
lupaxa/github_intel/reports/__init__.py,sha256=zTNVfqMv9JYo-gRnOWhOjaIAwhkUsWhM-bXw2FXuf4A,15
|
|
28
|
+
lupaxa/github_intel/reports/render.py,sha256=9ZdIND2lylLmT7PapeQl6U8KiSeqe5JKkuxBECoLMGw,3061
|
|
29
|
+
lupaxa/github_intel/storage/__init__.py,sha256=nazm2HjSEtY20VleYZW0sbBz0EN_v2i7jpbwsuMNYWA,19
|
|
30
|
+
lupaxa/github_intel/storage/database.py,sha256=rYvuqFHVC58AeMW0yeuqFldIWWlRZNalzF6oPBPnbR8,11865
|
|
31
|
+
lupaxa/github_intel/sync/__init__.py,sha256=xJZgg-1-4qaudOP5OVYkOAutS1JkJz1ZuPCTTWW2Xmo,23
|
|
32
|
+
lupaxa/github_intel/sync/engine.py,sha256=7azisEmKsb6ldON1Wd6nmMsZzrf6jzqWDkM955kLZEY,17763
|
|
33
|
+
lupaxa/github_intel/sync/summary.py,sha256=9zdRtqMxtEB7tADOkTIwBaBZPdI2A9-cqP6oLYtfFDo,7783
|
|
34
|
+
lupaxa/github_intel/tui/__init__.py,sha256=sbhg4vGL1tpNBx86_0nUhsgN0lZih8CWHGOYvHnQKu4,38
|
|
35
|
+
lupaxa/github_intel/tui/application.py,sha256=Qee37aBAGj7YegKFWAQq1HbD5ueGrK8ETwCPNIHf6Fc,15417
|
|
36
|
+
lupaxa_github_intel-0.1.0.dist-info/licenses/LICENCE,sha256=RXShyrlT7e281QX54JLm3YrhOlC-TJxObadJl1gH5Es,1070
|
|
37
|
+
lupaxa_github_intel-0.1.0.dist-info/METADATA,sha256=n-6PDH5JZkD2F9rHnj363uSh1ojEb-FejMiBsPXKWaw,6908
|
|
38
|
+
lupaxa_github_intel-0.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
|
|
39
|
+
lupaxa_github_intel-0.1.0.dist-info/entry_points.txt,sha256=i6zpYlseeKSQaFPsOn4FVdEJf9XB-3lhXfF93tlVgCA,62
|
|
40
|
+
lupaxa_github_intel-0.1.0.dist-info/top_level.txt,sha256=enJZ4xGyTomypf_yq2pEZRa_69hF0ulc9sWjyYQV9I8,7
|
|
41
|
+
lupaxa_github_intel-0.1.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) The Lupaxa Project
|
|
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.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
lupaxa
|