brewsorted-cli 0.8.4__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.
- brewsorted_cli/__init__.py +5 -0
- brewsorted_cli/_skill/SKILL.md +201 -0
- brewsorted_cli/_skill/__init__.py +1 -0
- brewsorted_cli/_skill/agents/openai.yaml +6 -0
- brewsorted_cli/_skill/references/cli.md +471 -0
- brewsorted_cli/_skill/tests/acceptance_scenarios.json +946 -0
- brewsorted_cli/_skill/tests/test_skill.py +534 -0
- brewsorted_cli/auth_state.py +273 -0
- brewsorted_cli/client.py +482 -0
- brewsorted_cli/http.py +29 -0
- brewsorted_cli/main.py +851 -0
- brewsorted_cli/oauth_discovery.py +120 -0
- brewsorted_cli/oauth_login.py +277 -0
- brewsorted_cli/product_feedback.py +114 -0
- brewsorted_cli/skills.py +45 -0
- brewsorted_cli/updates.py +76 -0
- brewsorted_cli-0.8.4.dist-info/METADATA +172 -0
- brewsorted_cli-0.8.4.dist-info/RECORD +21 -0
- brewsorted_cli-0.8.4.dist-info/WHEEL +5 -0
- brewsorted_cli-0.8.4.dist-info/entry_points.txt +2 -0
- brewsorted_cli-0.8.4.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: brewsorted-cli
|
|
3
|
+
Version: 0.8.4
|
|
4
|
+
Summary: Portable HTTP client for the BrewSorted API
|
|
5
|
+
Project-URL: Homepage, https://brewsorted.com
|
|
6
|
+
Project-URL: Documentation, https://brewsorted.com/downloads.html
|
|
7
|
+
Requires-Python: >=3.11
|
|
8
|
+
Description-Content-Type: text/markdown
|
|
9
|
+
Requires-Dist: httpx<1,>=0.28
|
|
10
|
+
Requires-Dist: PyJWT[crypto]<3,>=2.14
|
|
11
|
+
Provides-Extra: dev
|
|
12
|
+
Requires-Dist: pytest<10,>=8; extra == "dev"
|
|
13
|
+
|
|
14
|
+
# BrewSorted client bundle
|
|
15
|
+
|
|
16
|
+
This archive contains the HTTP CLI and the canonical User skill. It is paired
|
|
17
|
+
with its immutable service release by version, commit and archive SHA-256.
|
|
18
|
+
Public downloads use `client-release.json` and the client-only `SHA256SUMS` at
|
|
19
|
+
`https://downloads.brewsorted.com/index.json`; choose `production_recommended`,
|
|
20
|
+
not the newest published version. The supported client target
|
|
21
|
+
is Linux x86-64 with Python 3.12 or 3.13. Python 3.11 remains an internal
|
|
22
|
+
compatibility target and is not publicly release-qualified.
|
|
23
|
+
|
|
24
|
+
## PyPI installation
|
|
25
|
+
|
|
26
|
+
For releases published to [PyPI](https://pypi.org/project/brewsorted-cli/), install
|
|
27
|
+
that exact production-recommended version using uv (or pipx). Do not infer a
|
|
28
|
+
recommendation from PyPI's latest version. If the exact registry release is not
|
|
29
|
+
available yet, use its verified website archive below. The CLI and complete skill
|
|
30
|
+
are packaged together; no private repository access is required.
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
client_version=0.8.4
|
|
34
|
+
uv tool install --python python3.12 "brewsorted-cli==$client_version"
|
|
35
|
+
# Alternative: pipx install --python python3.12 "brewsorted-cli==$client_version"
|
|
36
|
+
brewsorted skills install --destination "$HOME/.codex/skills/brewsorted"
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Python 3.13 is also supported. Choose your agent's actual discovery directory;
|
|
40
|
+
omitting `--destination` uses `~/.agents/skills/brewsorted`. Skill installation is
|
|
41
|
+
local and needs no sign-in or service access. It copies the complete matching
|
|
42
|
+
skill and records the executable version and file hashes in
|
|
43
|
+
`brewsorted-install.json`. Existing files, directories and symlinks are refused;
|
|
44
|
+
inspect and move an existing skill deliberately before installing a replacement.
|
|
45
|
+
After upgrading the executable, deliberately reinstall the matching skill.
|
|
46
|
+
Use the same protected credential-state setup and separate login described below,
|
|
47
|
+
invoking `brewsorted` from PATH for the PyPI installation.
|
|
48
|
+
|
|
49
|
+
PyPI Trusted Publishing uses our GitHub repository `bamx23/brewsorted`, workflow
|
|
50
|
+
`pypi-publish.yml` on `main`, and environment `pypi`. Publish attestations establish
|
|
51
|
+
publisher provenance; they do not certify code safety. Ordinary pip, pipx and uv
|
|
52
|
+
installs do not automatically verify those attestations. For explicit verification,
|
|
53
|
+
download the exact wheel, verify those bytes, then install that same local file:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
python3.12 -m venv verification-env
|
|
57
|
+
verification-env/bin/python -m pip install pypi-attestations==0.0.31
|
|
58
|
+
verification-env/bin/python -m pip download --only-binary=:all: --no-deps \
|
|
59
|
+
--dest verified "brewsorted-cli==$client_version"
|
|
60
|
+
verification-env/bin/python -m pypi_attestations verify pypi \
|
|
61
|
+
--repository https://github.com/bamx23/brewsorted \
|
|
62
|
+
"verified/brewsorted_cli-$client_version-py3-none-any.whl"
|
|
63
|
+
uv tool install --python python3.12 "verified/brewsorted_cli-$client_version-py3-none-any.whl"
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
This verifies the CLI artifact's repository provenance, not every dependency or
|
|
67
|
+
a security audit. Establish the expected repository identity independently of a
|
|
68
|
+
disputed website. The public download catalog remains the compatibility authority.
|
|
69
|
+
|
|
70
|
+
## Archive installation
|
|
71
|
+
|
|
72
|
+
After checking `SHA256SUMS`, retain the extracted immutable archive and install
|
|
73
|
+
both the CLI and its exact User skill. These commands use the Codex skill
|
|
74
|
+
directory; select the equivalent configured discovery directory for another
|
|
75
|
+
supported agent:
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
client_version=0.8.4
|
|
79
|
+
client_archive="brewsorted-client-${client_version}.tar.gz"
|
|
80
|
+
client_release_root="$HOME/.local/share/brewsorted/releases"
|
|
81
|
+
client_root="$client_release_root/brewsorted-client-${client_version}"
|
|
82
|
+
agent_skill_root="$HOME/.codex/skills"
|
|
83
|
+
sha256sum --check SHA256SUMS || exit 1
|
|
84
|
+
install -d -m 0700 "$client_release_root" "$agent_skill_root"
|
|
85
|
+
test ! -e "$client_root" && test ! -L "$client_root"
|
|
86
|
+
tar -xzf "$client_archive" -C "$client_release_root"
|
|
87
|
+
python3.13 -m venv "$client_root/.venv"
|
|
88
|
+
"$client_root/.venv/bin/python" -m pip install "$client_root"
|
|
89
|
+
test ! -e "$agent_skill_root/brewsorted" && test ! -L "$agent_skill_root/brewsorted"
|
|
90
|
+
ln -s "$client_root/skills/brewsorted" "$agent_skill_root/brewsorted"
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
For an upgrade from CoffeeTrack, remove the old `coffeetrack` skill link and
|
|
94
|
+
replace any shell or agent wrapper that invokes `coffeetrack` with the new
|
|
95
|
+
`$client_root/.venv/bin/brewsorted` path. Move the non-secret service-origin
|
|
96
|
+
setting from `COFFEETRACK_API_URL` to `BREWSORTED_API_URL`; use
|
|
97
|
+
`https://brewsorted.com` for production or `https://staging.brewsorted.com`
|
|
98
|
+
for synthetic staging. Use a separate credential file for each origin.
|
|
99
|
+
Do not copy an old `~/.local/state/coffeetrack/auth.json` or other OAuth state
|
|
100
|
+
into the BrewSorted state directory. The new realm has a different issuer and
|
|
101
|
+
requires fresh User setup, browser sign-in, and Connection authorization.
|
|
102
|
+
|
|
103
|
+
Do not copy only `SKILL.md`: the retained link keeps `references/cli.md` and the
|
|
104
|
+
acceptance scenarios paired with the installed executable source. If the target
|
|
105
|
+
link already exists, inspect and remove or rename it deliberately before linking
|
|
106
|
+
the new archive; do not overwrite an unknown directory.
|
|
107
|
+
|
|
108
|
+
Create the OAuth state directory explicitly and keep it user-owned mode `0700`.
|
|
109
|
+
The credential file becomes mode `0600` when login succeeds:
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
brewsorted_state_root="$HOME/.local/state/brewsorted"
|
|
113
|
+
install -d -m 0700 "$brewsorted_state_root"
|
|
114
|
+
export BREWSORTED_STATE_FILE="$brewsorted_state_root/auth.json"
|
|
115
|
+
export BREWSORTED_API_URL=https://brewsorted.com
|
|
116
|
+
unset COFFEETRACK_API_TOKEN COFFEETRACK_ACCESS_TOKEN COFFEETRACK_STATE_FILE
|
|
117
|
+
"$client_root/.venv/bin/brewsorted" status
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
Remove legacy `COFFEETRACK_*` assignments from shell profiles, agent wrappers,
|
|
121
|
+
and service configuration. `BREWSORTED_ACCESS_TOKEN` is only for an explicitly
|
|
122
|
+
configured transient agent session; it does not transfer an old Connection.
|
|
123
|
+
Configure the exact HTTPS service origin outside chat as described in the skill.
|
|
124
|
+
|
|
125
|
+
For a headless agent session, run
|
|
126
|
+
`"$client_root/.venv/bin/brewsorted" login --device` and keep that process
|
|
127
|
+
alive. Relay its exact verification URL and short code to the intended User, who
|
|
128
|
+
authorizes it in their own browser. The agent never asks for SSH access, a
|
|
129
|
+
password, access or refresh tokens, or a recovery link.
|
|
130
|
+
|
|
131
|
+
## HTTP proxy setup
|
|
132
|
+
|
|
133
|
+
For a VM that requires an HTTP proxy, configure the environment before login
|
|
134
|
+
and keep it available for subsequent commands:
|
|
135
|
+
|
|
136
|
+
```bash
|
|
137
|
+
export HTTPS_PROXY=http://proxy.example:8080
|
|
138
|
+
"$client_root/.venv/bin/brewsorted" login --device
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
`HTTPS_PROXY` routes HTTPS service requests through the HTTP proxy; use
|
|
142
|
+
`HTTP_PROXY` for loopback HTTP development or `ALL_PROXY` as a fallback.
|
|
143
|
+
Lowercase forms are also accepted. `NO_PROXY` lists destinations to reach
|
|
144
|
+
directly. Alternatively, pass the global option before each command:
|
|
145
|
+
`brewsorted --proxy http://proxy.example:8080 login --device`. This explicit
|
|
146
|
+
option overrides environment proxies and bypass rules for API and OAuth
|
|
147
|
+
requests, including refresh and signing keys. Proxy settings are not saved in
|
|
148
|
+
the Connection. TLS verification remains enabled; an environment with a private
|
|
149
|
+
CA can set `SSL_CERT_FILE` or `SSL_CERT_DIR` to its trusted certificate bundle.
|
|
150
|
+
Keep proxy credentials in the VM's protected environment, outside chat.
|
|
151
|
+
|
|
152
|
+
## Acceptance checks
|
|
153
|
+
|
|
154
|
+
Treat each check as different evidence:
|
|
155
|
+
|
|
156
|
+
1. `brewsorted status` proves anonymous service health and compatibility only.
|
|
157
|
+
2. `brewsorted context` proves the saved Connection can make an authenticated
|
|
158
|
+
read for the intended User.
|
|
159
|
+
3. After the initial access token expires, another `context` proves the saved
|
|
160
|
+
refresh grant can rotate; health alone does not prove refresh.
|
|
161
|
+
4. With explicit authorization, create a disposable Roastery, read it by the
|
|
162
|
+
complete returned Qualified ID, update and read it again, then delete that
|
|
163
|
+
exact ID. This proves write/read-back separately from authentication.
|
|
164
|
+
|
|
165
|
+
For recovery, deliberately select the production-recommended archive in the public
|
|
166
|
+
catalog, check its identity and SHA-256 before extraction, and reinstall into its
|
|
167
|
+
version-specific environment. An unavailable recommendation is a publication
|
|
168
|
+
incident: do not infer compatibility from version order or use a withdrawn archive.
|
|
169
|
+
The CLI's optional version hint is advisory, not an automatic updater. See
|
|
170
|
+
`https://brewsorted.com/downloads.html` for download and update steps. HTTPS and
|
|
171
|
+
matching hashes detect corruption but do not independently prove authenticity if
|
|
172
|
+
the publication origin is compromised.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
brewsorted_cli/__init__.py,sha256=yhMBvtXBAm7NucFUuaenhvnZrM81-c2Ncfk85axoNNQ,117
|
|
2
|
+
brewsorted_cli/auth_state.py,sha256=K99kzWNkccH4cHWx_mseoDG28FZy9RjVACVWrkptR3c,11641
|
|
3
|
+
brewsorted_cli/client.py,sha256=YpqhJBr57UexKy5z5uuDWhggMHV7dBAmSeJOp3E0HkU,20787
|
|
4
|
+
brewsorted_cli/http.py,sha256=x4WCcimOm_5gY8J86J-ivGAPFPdPHMgIkJRJQS2j6Pw,1126
|
|
5
|
+
brewsorted_cli/main.py,sha256=M_Mh9e0ka27zzO6E_TUZNkzkpzcR5p1bZkUC-9XYPlM,38368
|
|
6
|
+
brewsorted_cli/oauth_discovery.py,sha256=CP26VQWrfyYfcI0ZRvQZqQwZBX2ZRxKKw_fS6xqfxno,4752
|
|
7
|
+
brewsorted_cli/oauth_login.py,sha256=clPTgEc_oK8GFW9MkdnWF4wi4yZy4LMCPFwa0F14Z4s,14091
|
|
8
|
+
brewsorted_cli/product_feedback.py,sha256=QfJmpYY_2FDeIeCSlnmPHUSUchcYVuWAhPkI56aMFp4,4054
|
|
9
|
+
brewsorted_cli/skills.py,sha256=WCn8p-eZCmhSKL9O31y6fnXwhHt9N5UDA_KkmVfobRw,1634
|
|
10
|
+
brewsorted_cli/updates.py,sha256=EDSg0S1Uj6aMRzyzrybB2h5sN0EkIh7ND-gJPh450Kc,3024
|
|
11
|
+
brewsorted_cli/_skill/SKILL.md,sha256=oUMa494ZG8weUxkFDRZey7kQ-JJg0iC0dAwApFItAmo,14604
|
|
12
|
+
brewsorted_cli/_skill/__init__.py,sha256=lwcvy4MigS-oDpnVLkB5iZ_2VnonFwX6KaHRwv5wNy8,77
|
|
13
|
+
brewsorted_cli/_skill/agents/openai.yaml,sha256=nABhiE0gpaxMF3xXFHUkjb0ONHGRUUAHU3Ws-8T2q8Q,233
|
|
14
|
+
brewsorted_cli/_skill/references/cli.md,sha256=LPyhJumucAy4G72VxhXRJm_jod6c87Np-v1Qp4mjoAk,24006
|
|
15
|
+
brewsorted_cli/_skill/tests/acceptance_scenarios.json,sha256=Qbm70LAUL3BRG5x-6v6q8-ZQrc9PC3JkglnAXaxd2tk,39863
|
|
16
|
+
brewsorted_cli/_skill/tests/test_skill.py,sha256=-MgTqd7aVNbYoaXlqRUzvnx7R6_KN26iIVhxv3HtdXo,21733
|
|
17
|
+
brewsorted_cli-0.8.4.dist-info/METADATA,sha256=mL15dNPLqFOzUfE6fOUTe1_zxL-D6SYFEdbX14sCIW0,8808
|
|
18
|
+
brewsorted_cli-0.8.4.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
|
|
19
|
+
brewsorted_cli-0.8.4.dist-info/entry_points.txt,sha256=WjQtu1DVuhbNjO_kYG8e8ml6Tx_ayIvSdCmLpvh6xxY,56
|
|
20
|
+
brewsorted_cli-0.8.4.dist-info/top_level.txt,sha256=B83nHQxhKmiQ-qXNjYBIZ50svqgn8-VZ1Yqa-l6lEfY,15
|
|
21
|
+
brewsorted_cli-0.8.4.dist-info/RECORD,,
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
brewsorted_cli
|