orangehack 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.
- orangehack-0.1.0/.gitignore +25 -0
- orangehack-0.1.0/PKG-INFO +145 -0
- orangehack-0.1.0/README.md +119 -0
- orangehack-0.1.0/pyproject.toml +74 -0
- orangehack-0.1.0/src/orangehack/__init__.py +15 -0
- orangehack-0.1.0/src/orangehack/__main__.py +3 -0
- orangehack-0.1.0/src/orangehack/client.py +239 -0
- orangehack-0.1.0/src/orangehack/commands/__init__.py +1 -0
- orangehack-0.1.0/src/orangehack/commands/api.py +347 -0
- orangehack-0.1.0/src/orangehack/commands/attempts.py +253 -0
- orangehack-0.1.0/src/orangehack/commands/auth.py +224 -0
- orangehack-0.1.0/src/orangehack/commands/competitions.py +215 -0
- orangehack-0.1.0/src/orangehack/commands/download.py +145 -0
- orangehack-0.1.0/src/orangehack/commands/leaderboard.py +114 -0
- orangehack-0.1.0/src/orangehack/commands/submit.py +372 -0
- orangehack-0.1.0/src/orangehack/config.py +221 -0
- orangehack-0.1.0/src/orangehack/errors.py +109 -0
- orangehack-0.1.0/src/orangehack/main.py +98 -0
- orangehack-0.1.0/src/orangehack/output.py +105 -0
- orangehack-0.1.0/src/orangehack/resolve.py +172 -0
- orangehack-0.1.0/src/orangehack/session.py +127 -0
- orangehack-0.1.0/src/orangehack/transfer.py +442 -0
- orangehack-0.1.0/src/orangehack/version_check.py +104 -0
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
node_modules/
|
|
2
|
+
.DS_Store
|
|
3
|
+
*.log
|
|
4
|
+
|
|
5
|
+
# CodeGraph index, rebuilt per machine
|
|
6
|
+
.codegraph/
|
|
7
|
+
|
|
8
|
+
# Python
|
|
9
|
+
__pycache__/
|
|
10
|
+
.venv/
|
|
11
|
+
.pytest_cache/
|
|
12
|
+
.mypy_cache/
|
|
13
|
+
.ruff_cache/
|
|
14
|
+
backend/staticfiles/
|
|
15
|
+
.env
|
|
16
|
+
|
|
17
|
+
# Generated from the backend schema (apps/web)
|
|
18
|
+
apps/web/src/api/schema.d.ts
|
|
19
|
+
apps/web/dist/
|
|
20
|
+
apps/web/storybook-static/
|
|
21
|
+
apps/web/src/api/openapi.json
|
|
22
|
+
apps/web/test-results/
|
|
23
|
+
apps/web/playwright-report/
|
|
24
|
+
backend/media/
|
|
25
|
+
backend/var/
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: orangehack
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Hand in, follow attempts and the leaderboard of OrangeHack competitions from a terminal.
|
|
5
|
+
Project-URL: Homepage, https://app.orangehack.ru
|
|
6
|
+
Project-URL: Documentation, https://app.orangehack.ru/docs/cli
|
|
7
|
+
Author: OrangeHack
|
|
8
|
+
Keywords: cli,competition,hackathon,orangehack,submission
|
|
9
|
+
Classifier: Environment :: Console
|
|
10
|
+
Classifier: Intended Audience :: Science/Research
|
|
11
|
+
Classifier: License :: Other/Proprietary License
|
|
12
|
+
Classifier: Operating System :: OS Independent
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
+
Requires-Python: >=3.10
|
|
19
|
+
Requires-Dist: httpx<1,>=0.28
|
|
20
|
+
Requires-Dist: platformdirs<5,>=4
|
|
21
|
+
Requires-Dist: tomli>=2; python_version < '3.11'
|
|
22
|
+
Requires-Dist: typer<1,>=0.15
|
|
23
|
+
Provides-Extra: keyring
|
|
24
|
+
Requires-Dist: keyring>=25; extra == 'keyring'
|
|
25
|
+
Description-Content-Type: text/markdown
|
|
26
|
+
|
|
27
|
+
# orangehack
|
|
28
|
+
|
|
29
|
+
Сдача решений на платформу [OrangeHack](https://app.orangehack.ru) из терминала, скрипта или CI: сдать файл, дождаться оценки, посмотреть попытки и таблицу, скачать материалы кейса.
|
|
30
|
+
|
|
31
|
+
Подробное руководство: https://app.orangehack.ru/docs/cli
|
|
32
|
+
|
|
33
|
+
## Установка
|
|
34
|
+
|
|
35
|
+
Нужен Python 3.10 или новее.
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
pipx install orangehack
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
или
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
uv tool install orangehack
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Вход
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
orangehack login
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Откроется браузер: подтвердите код, который показал терминал. Токен хранится на этом компьютере (в системном хранилище ключей, если поставить `orangehack[keyring]`, иначе в файле, который читает только ваш пользователь). Отозвать токен можно на сайте, в разделе «Доступ по API».
|
|
54
|
+
|
|
55
|
+
## Первая сдача
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
orangehack submit org/contest submission.csv --wait
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Если в соревновании открыта одна сдача, больше ничего указывать не нужно. Иначе — `--case <кейс>` или `--deliverable <ключ>`.
|
|
62
|
+
|
|
63
|
+
## Папка и несколько файлов
|
|
64
|
+
|
|
65
|
+
Папку или несколько путей CLI упакует в zip, покажет число файлов и первые десять имён и спросит «Сдать этот архив?» (`--yes` — не спрашивать). Если путей несколько, каждая папка лежит в архиве под своим именем; два файла с одним именем в архиве — ошибка (код 2).
|
|
66
|
+
|
|
67
|
+
В архив не попадают:
|
|
68
|
+
|
|
69
|
+
- `.git`, `__pycache__`, `.venv`, `venv`, `.ipynb_checkpoints`, `.DS_Store`;
|
|
70
|
+
- файлы и папки, похожие на секреты (`SECRET_NAMES` и `SECRET_DIRS` в `src/orangehack/transfer.py`, этот список повторяет их):
|
|
71
|
+
- файлы окружения: `.env`, `.env.*`, `*.env`, `.envrc`;
|
|
72
|
+
- ключи и сертификаты: `*.pem`, `*.key`, `*.p12`, `*.pfx`, `id_rsa*`, `id_ed25519*`, `id_ecdsa*`, `id_dsa*`;
|
|
73
|
+
- учётные данные инструментов: `.netrc`, `.npmrc`, `.pypirc`, `credentials*`, `kaggle.json`;
|
|
74
|
+
- папки `.ssh`, `.aws`, `.kube`, `.gnupg` на любой глубине;
|
|
75
|
+
- символические ссылки (и на файлы, и на папки): ссылка может вести за пределы папки;
|
|
76
|
+
- то, что перечислено в `.orangehackignore` в корне папки.
|
|
77
|
+
|
|
78
|
+
Синтаксис `.orangehackignore` — по шаблону на строку, `#` — комментарий:
|
|
79
|
+
|
|
80
|
+
| Шаблон | Что исключает |
|
|
81
|
+
|---|---|
|
|
82
|
+
| `data` или `data/` | файл или папку `data` на любой глубине |
|
|
83
|
+
| `/data` | только `data` в корне папки |
|
|
84
|
+
| `lib/data` | путь от корня папки |
|
|
85
|
+
| `*.csv` | по маске `*`, `?`, `[...]` на любой глубине |
|
|
86
|
+
|
|
87
|
+
Отрицание `!` не поддерживается. Пропущенные секреты и ссылки CLI называет в stderr. Если файл или папку не получается прочитать, CLI ничего не сдаёт и называет путь (код 2): неполный архив не уходит.
|
|
88
|
+
|
|
89
|
+
## Команды
|
|
90
|
+
|
|
91
|
+
| Команда | Что делает |
|
|
92
|
+
|---|---|
|
|
93
|
+
| `login`, `logout`, `whoami` | вход по коду, выход, кто вошёл |
|
|
94
|
+
| `competitions [--all]` | мои соревнования или весь каталог |
|
|
95
|
+
| `cases <соревнование>` | этапы, кейсы и что ещё не сдано |
|
|
96
|
+
| `deliverables <соревнование>` | что сдавать, сроки, сколько версий осталось |
|
|
97
|
+
| `submit <соревнование> <файл…>` | сдать файл, папку, `--text` или `--url`; `--wait` ждёт оценку |
|
|
98
|
+
| `attempts <соревнование>`, `status <соревнование> <попытка>` | мои попытки и лимит на сегодня |
|
|
99
|
+
| `leaderboard <соревнование> [--case] [--overall]` | таблица и моё место |
|
|
100
|
+
| `download <соревнование> [--case] [--mine] [--overwrite]` | материалы кейса или свои файлы; обрыв докачивается; локальный файл с другим содержимым не заменяется, новый ложится рядом как `имя-2` (`--overwrite` — заменить) |
|
|
101
|
+
| `api [метод] <путь>` | любой запрос к API платформы с вашим токеном, как `gh api` (ниже) |
|
|
102
|
+
|
|
103
|
+
Соревнование называется адресом с сайта (`организация/соревнование`) или его id.
|
|
104
|
+
|
|
105
|
+
## В скрипте и CI
|
|
106
|
+
|
|
107
|
+
```bash
|
|
108
|
+
export ORANGEHACK_TOKEN=oh_pat_... # токен из «Доступ по API»
|
|
109
|
+
orangehack --json submit org/contest submission.csv --wait
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
С `--json` в stdout выходит ровно один JSON-документ, прогресс — в stderr. `ORANGEHACK_URL` меняет адрес платформы (только `https://`; `http://` — для localhost), `--profile` выбирает профиль из конфигурации, `--proxy` и `HTTPS_PROXY` задают прокси (к платформе на этом компьютере — localhost, 127.0.0.1, ::1 — команда идёт напрямую, мимо прокси, и токен не уходит с машины), `--ca-bundle` — свои корневые сертификаты.
|
|
113
|
+
|
|
114
|
+
| Код выхода | Значение |
|
|
115
|
+
|---|---|
|
|
116
|
+
| 0 | готово |
|
|
117
|
+
| 1 | платформа отклонила попытку, или оценка не удалась |
|
|
118
|
+
| 2 | неверный вызов: не хватает аргумента, неоднозначный кейс |
|
|
119
|
+
| 3 | не выполнен вход, или токен больше не действует |
|
|
120
|
+
| 4 | нет прав (например, токен без права `submit`) |
|
|
121
|
+
| 5 | нужно принять документы платформы на сайте |
|
|
122
|
+
| 6 | лимит или окно приёма |
|
|
123
|
+
| 7 | сеть или сервер после повторов |
|
|
124
|
+
| 8 | версия CLI устарела |
|
|
125
|
+
|
|
126
|
+
Коды не меняют значения в пределах основной версии.
|
|
127
|
+
|
|
128
|
+
## Прямой вызов API
|
|
129
|
+
|
|
130
|
+
Для запросов, которых нет среди команд, есть `orangehack api`: он вызывает любой адрес API платформы с вашим токеном, как `gh api` у GitHub. Путь пишется от `/api/v1/`, метод по умолчанию GET, а с полями или телом — POST.
|
|
131
|
+
|
|
132
|
+
```bash
|
|
133
|
+
orangehack api accounts/tokens/current
|
|
134
|
+
orangehack api competitions/catalog -f q=ИИ
|
|
135
|
+
orangehack api POST competitions/listings/import --input listings.json
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
- `-f ключ=значение` — поле-строка, `-F ключ=значение` — целое число, `true`, `false` или `null`; у GET поля уходят в адрес. `--input файл` (или `-` для stdin) отправляет тело целиком.
|
|
139
|
+
- `-H 'Имя: значение'` добавляет заголовок, `-i` показывает код и заголовки ответа, `--json` оборачивает ответ в один JSON-документ (`ok`, `status`, `body`).
|
|
140
|
+
- Токен уходит только на эту платформу: адрес другого сайта и путь вне `/api/v1/` команда не примет, по перенаправлениям не ходит. На перенаправление (например, на файл в хранилище) команда выходит с кодом 0 и печатает адрес в stderr (в `--json` — поле `location`): скачайте его без токена, например `curl -o файл 'адрес'`. Заголовки `Authorization`, `Cookie`, `Host` и `X-OrangeHack-Client` задать нельзя.
|
|
141
|
+
- Что можно токену, решает платформа. На ответ 400 и выше команда печатает тело ответа и выходит с кодом из таблицы выше. GET повторяется при сбоях сети, POST и другие методы — никогда.
|
|
142
|
+
|
|
143
|
+
## Обновление
|
|
144
|
+
|
|
145
|
+
CLI раз в день проверяет, не вышла ли новая версия (`ORANGEHACK_NO_UPDATE_CHECK=1` или `CI=true` отключают проверку). Обновить: `pipx upgrade orangehack` или `uv tool upgrade orangehack`.
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# orangehack
|
|
2
|
+
|
|
3
|
+
Сдача решений на платформу [OrangeHack](https://app.orangehack.ru) из терминала, скрипта или CI: сдать файл, дождаться оценки, посмотреть попытки и таблицу, скачать материалы кейса.
|
|
4
|
+
|
|
5
|
+
Подробное руководство: https://app.orangehack.ru/docs/cli
|
|
6
|
+
|
|
7
|
+
## Установка
|
|
8
|
+
|
|
9
|
+
Нужен Python 3.10 или новее.
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
pipx install orangehack
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
или
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
uv tool install orangehack
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Вход
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
orangehack login
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Откроется браузер: подтвердите код, который показал терминал. Токен хранится на этом компьютере (в системном хранилище ключей, если поставить `orangehack[keyring]`, иначе в файле, который читает только ваш пользователь). Отозвать токен можно на сайте, в разделе «Доступ по API».
|
|
28
|
+
|
|
29
|
+
## Первая сдача
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
orangehack submit org/contest submission.csv --wait
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Если в соревновании открыта одна сдача, больше ничего указывать не нужно. Иначе — `--case <кейс>` или `--deliverable <ключ>`.
|
|
36
|
+
|
|
37
|
+
## Папка и несколько файлов
|
|
38
|
+
|
|
39
|
+
Папку или несколько путей CLI упакует в zip, покажет число файлов и первые десять имён и спросит «Сдать этот архив?» (`--yes` — не спрашивать). Если путей несколько, каждая папка лежит в архиве под своим именем; два файла с одним именем в архиве — ошибка (код 2).
|
|
40
|
+
|
|
41
|
+
В архив не попадают:
|
|
42
|
+
|
|
43
|
+
- `.git`, `__pycache__`, `.venv`, `venv`, `.ipynb_checkpoints`, `.DS_Store`;
|
|
44
|
+
- файлы и папки, похожие на секреты (`SECRET_NAMES` и `SECRET_DIRS` в `src/orangehack/transfer.py`, этот список повторяет их):
|
|
45
|
+
- файлы окружения: `.env`, `.env.*`, `*.env`, `.envrc`;
|
|
46
|
+
- ключи и сертификаты: `*.pem`, `*.key`, `*.p12`, `*.pfx`, `id_rsa*`, `id_ed25519*`, `id_ecdsa*`, `id_dsa*`;
|
|
47
|
+
- учётные данные инструментов: `.netrc`, `.npmrc`, `.pypirc`, `credentials*`, `kaggle.json`;
|
|
48
|
+
- папки `.ssh`, `.aws`, `.kube`, `.gnupg` на любой глубине;
|
|
49
|
+
- символические ссылки (и на файлы, и на папки): ссылка может вести за пределы папки;
|
|
50
|
+
- то, что перечислено в `.orangehackignore` в корне папки.
|
|
51
|
+
|
|
52
|
+
Синтаксис `.orangehackignore` — по шаблону на строку, `#` — комментарий:
|
|
53
|
+
|
|
54
|
+
| Шаблон | Что исключает |
|
|
55
|
+
|---|---|
|
|
56
|
+
| `data` или `data/` | файл или папку `data` на любой глубине |
|
|
57
|
+
| `/data` | только `data` в корне папки |
|
|
58
|
+
| `lib/data` | путь от корня папки |
|
|
59
|
+
| `*.csv` | по маске `*`, `?`, `[...]` на любой глубине |
|
|
60
|
+
|
|
61
|
+
Отрицание `!` не поддерживается. Пропущенные секреты и ссылки CLI называет в stderr. Если файл или папку не получается прочитать, CLI ничего не сдаёт и называет путь (код 2): неполный архив не уходит.
|
|
62
|
+
|
|
63
|
+
## Команды
|
|
64
|
+
|
|
65
|
+
| Команда | Что делает |
|
|
66
|
+
|---|---|
|
|
67
|
+
| `login`, `logout`, `whoami` | вход по коду, выход, кто вошёл |
|
|
68
|
+
| `competitions [--all]` | мои соревнования или весь каталог |
|
|
69
|
+
| `cases <соревнование>` | этапы, кейсы и что ещё не сдано |
|
|
70
|
+
| `deliverables <соревнование>` | что сдавать, сроки, сколько версий осталось |
|
|
71
|
+
| `submit <соревнование> <файл…>` | сдать файл, папку, `--text` или `--url`; `--wait` ждёт оценку |
|
|
72
|
+
| `attempts <соревнование>`, `status <соревнование> <попытка>` | мои попытки и лимит на сегодня |
|
|
73
|
+
| `leaderboard <соревнование> [--case] [--overall]` | таблица и моё место |
|
|
74
|
+
| `download <соревнование> [--case] [--mine] [--overwrite]` | материалы кейса или свои файлы; обрыв докачивается; локальный файл с другим содержимым не заменяется, новый ложится рядом как `имя-2` (`--overwrite` — заменить) |
|
|
75
|
+
| `api [метод] <путь>` | любой запрос к API платформы с вашим токеном, как `gh api` (ниже) |
|
|
76
|
+
|
|
77
|
+
Соревнование называется адресом с сайта (`организация/соревнование`) или его id.
|
|
78
|
+
|
|
79
|
+
## В скрипте и CI
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
export ORANGEHACK_TOKEN=oh_pat_... # токен из «Доступ по API»
|
|
83
|
+
orangehack --json submit org/contest submission.csv --wait
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
С `--json` в stdout выходит ровно один JSON-документ, прогресс — в stderr. `ORANGEHACK_URL` меняет адрес платформы (только `https://`; `http://` — для localhost), `--profile` выбирает профиль из конфигурации, `--proxy` и `HTTPS_PROXY` задают прокси (к платформе на этом компьютере — localhost, 127.0.0.1, ::1 — команда идёт напрямую, мимо прокси, и токен не уходит с машины), `--ca-bundle` — свои корневые сертификаты.
|
|
87
|
+
|
|
88
|
+
| Код выхода | Значение |
|
|
89
|
+
|---|---|
|
|
90
|
+
| 0 | готово |
|
|
91
|
+
| 1 | платформа отклонила попытку, или оценка не удалась |
|
|
92
|
+
| 2 | неверный вызов: не хватает аргумента, неоднозначный кейс |
|
|
93
|
+
| 3 | не выполнен вход, или токен больше не действует |
|
|
94
|
+
| 4 | нет прав (например, токен без права `submit`) |
|
|
95
|
+
| 5 | нужно принять документы платформы на сайте |
|
|
96
|
+
| 6 | лимит или окно приёма |
|
|
97
|
+
| 7 | сеть или сервер после повторов |
|
|
98
|
+
| 8 | версия CLI устарела |
|
|
99
|
+
|
|
100
|
+
Коды не меняют значения в пределах основной версии.
|
|
101
|
+
|
|
102
|
+
## Прямой вызов API
|
|
103
|
+
|
|
104
|
+
Для запросов, которых нет среди команд, есть `orangehack api`: он вызывает любой адрес API платформы с вашим токеном, как `gh api` у GitHub. Путь пишется от `/api/v1/`, метод по умолчанию GET, а с полями или телом — POST.
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
orangehack api accounts/tokens/current
|
|
108
|
+
orangehack api competitions/catalog -f q=ИИ
|
|
109
|
+
orangehack api POST competitions/listings/import --input listings.json
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
- `-f ключ=значение` — поле-строка, `-F ключ=значение` — целое число, `true`, `false` или `null`; у GET поля уходят в адрес. `--input файл` (или `-` для stdin) отправляет тело целиком.
|
|
113
|
+
- `-H 'Имя: значение'` добавляет заголовок, `-i` показывает код и заголовки ответа, `--json` оборачивает ответ в один JSON-документ (`ok`, `status`, `body`).
|
|
114
|
+
- Токен уходит только на эту платформу: адрес другого сайта и путь вне `/api/v1/` команда не примет, по перенаправлениям не ходит. На перенаправление (например, на файл в хранилище) команда выходит с кодом 0 и печатает адрес в stderr (в `--json` — поле `location`): скачайте его без токена, например `curl -o файл 'адрес'`. Заголовки `Authorization`, `Cookie`, `Host` и `X-OrangeHack-Client` задать нельзя.
|
|
115
|
+
- Что можно токену, решает платформа. На ответ 400 и выше команда печатает тело ответа и выходит с кодом из таблицы выше. GET повторяется при сбоях сети, POST и другие методы — никогда.
|
|
116
|
+
|
|
117
|
+
## Обновление
|
|
118
|
+
|
|
119
|
+
CLI раз в день проверяет, не вышла ли новая версия (`ORANGEHACK_NO_UPDATE_CHECK=1` или `CI=true` отключают проверку). Обновить: `pipx upgrade orangehack` или `uv tool upgrade orangehack`.
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "orangehack"
|
|
3
|
+
version = "0.1.0"
|
|
4
|
+
description = "Hand in, follow attempts and the leaderboard of OrangeHack competitions from a terminal."
|
|
5
|
+
readme = "README.md"
|
|
6
|
+
requires-python = ">=3.10"
|
|
7
|
+
authors = [{ name = "OrangeHack" }]
|
|
8
|
+
keywords = ["orangehack", "hackathon", "competition", "cli", "submission"]
|
|
9
|
+
classifiers = [
|
|
10
|
+
"Environment :: Console",
|
|
11
|
+
"Intended Audience :: Science/Research",
|
|
12
|
+
"License :: Other/Proprietary License",
|
|
13
|
+
"Operating System :: OS Independent",
|
|
14
|
+
"Programming Language :: Python :: 3",
|
|
15
|
+
"Programming Language :: Python :: 3.10",
|
|
16
|
+
"Programming Language :: Python :: 3.11",
|
|
17
|
+
"Programming Language :: Python :: 3.12",
|
|
18
|
+
"Programming Language :: Python :: 3.13",
|
|
19
|
+
]
|
|
20
|
+
dependencies = [
|
|
21
|
+
"httpx>=0.28,<1",
|
|
22
|
+
"typer>=0.15,<1",
|
|
23
|
+
"platformdirs>=4,<5",
|
|
24
|
+
"tomli>=2; python_version < '3.11'",
|
|
25
|
+
]
|
|
26
|
+
|
|
27
|
+
[project.optional-dependencies]
|
|
28
|
+
# The system keyring fails on headless servers, so it is opt-in; without it the token goes to a
|
|
29
|
+
# file only the user can read.
|
|
30
|
+
keyring = ["keyring>=25"]
|
|
31
|
+
|
|
32
|
+
[project.urls]
|
|
33
|
+
Homepage = "https://app.orangehack.ru"
|
|
34
|
+
Documentation = "https://app.orangehack.ru/docs/cli"
|
|
35
|
+
|
|
36
|
+
[project.scripts]
|
|
37
|
+
orangehack = "orangehack.main:run"
|
|
38
|
+
|
|
39
|
+
[dependency-groups]
|
|
40
|
+
dev = ["pytest>=9.2.0", "jsonschema>=4.23", "types-jsonschema", "mypy>=1.18", "ruff>=0.14"]
|
|
41
|
+
|
|
42
|
+
[build-system]
|
|
43
|
+
requires = ["hatchling"]
|
|
44
|
+
build-backend = "hatchling.build"
|
|
45
|
+
|
|
46
|
+
[tool.hatch.build.targets.wheel]
|
|
47
|
+
packages = ["src/orangehack"]
|
|
48
|
+
|
|
49
|
+
[tool.hatch.build.targets.sdist]
|
|
50
|
+
# What PyPI gets: the code and its page, not the tests, the recorded answers or the recorder.
|
|
51
|
+
include = ["src/orangehack", "README.md", "pyproject.toml"]
|
|
52
|
+
|
|
53
|
+
[tool.pytest.ini_options]
|
|
54
|
+
testpaths = ["tests"]
|
|
55
|
+
pythonpath = ["src"]
|
|
56
|
+
|
|
57
|
+
[tool.mypy]
|
|
58
|
+
strict = true
|
|
59
|
+
files = ["src", "tests", "scripts"]
|
|
60
|
+
python_version = "3.10"
|
|
61
|
+
|
|
62
|
+
[[tool.mypy.overrides]]
|
|
63
|
+
module = ["keyring", "keyring.*", "tomli", "django", "django.*", "apps.*"]
|
|
64
|
+
ignore_missing_imports = true
|
|
65
|
+
|
|
66
|
+
[tool.ruff]
|
|
67
|
+
line-length = 100
|
|
68
|
+
target-version = "py310"
|
|
69
|
+
src = ["src", "tests"]
|
|
70
|
+
|
|
71
|
+
[tool.ruff.lint]
|
|
72
|
+
select = ["E", "F", "W", "I", "UP", "B", "SIM", "RUF"]
|
|
73
|
+
# The interface is in Russian: Cyrillic letters in strings and comments are meant.
|
|
74
|
+
ignore = ["RUF001", "RUF002", "RUF003", "E501"] # E501: the formatter owns length; it keeps long strings whole
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"""The official command-line client of the OrangeHack platform."""
|
|
2
|
+
|
|
3
|
+
from importlib.metadata import PackageNotFoundError, version
|
|
4
|
+
|
|
5
|
+
try:
|
|
6
|
+
__version__ = version("orangehack")
|
|
7
|
+
except PackageNotFoundError: # running from a source tree that was never installed
|
|
8
|
+
__version__ = "0.0.0"
|
|
9
|
+
|
|
10
|
+
CLIENT_HEADER = "X-OrangeHack-Client"
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
def client_value() -> str:
|
|
14
|
+
"""What `submission-channels` reads to record an attempt with source `cli`."""
|
|
15
|
+
return f"orangehack-cli/{__version__}"
|
|
@@ -0,0 +1,239 @@
|
|
|
1
|
+
"""The HTTP client: base address, the token, the client header, retries and error mapping.
|
|
2
|
+
|
|
3
|
+
Retries (exponential backoff with jitter, 0.5 s … 8 s) cover connection errors, 502, 503 (except
|
|
4
|
+
`channel_unavailable`), 504 and 429 (waiting `Retry-After`, at most 60 s). A request marked
|
|
5
|
+
`once=True` (the hand-in itself) is never sent twice: a connection that broke after it was sent, any
|
|
6
|
+
5xx answer (except `channel_unavailable`) and a 2xx answer that is not JSON raise `LostAnswer`, and
|
|
7
|
+
the caller reads the history instead.
|
|
8
|
+
"""
|
|
9
|
+
|
|
10
|
+
from __future__ import annotations
|
|
11
|
+
|
|
12
|
+
import random
|
|
13
|
+
import ssl
|
|
14
|
+
import sys
|
|
15
|
+
import time
|
|
16
|
+
from collections.abc import Callable
|
|
17
|
+
from typing import Any
|
|
18
|
+
|
|
19
|
+
import httpx
|
|
20
|
+
|
|
21
|
+
from . import CLIENT_HEADER, __version__, client_value
|
|
22
|
+
from .config import LOCAL_HOSTS
|
|
23
|
+
from .errors import ApiError, CliError, Exit, LostAnswer, from_api
|
|
24
|
+
|
|
25
|
+
DELAYS = (0.5, 1.0, 2.0, 4.0, 8.0)
|
|
26
|
+
MAX_RETRY_AFTER = 60.0
|
|
27
|
+
RETRY_STATUS = {502, 503, 504, 429}
|
|
28
|
+
TIMEOUT = httpx.Timeout(60.0, connect=15.0)
|
|
29
|
+
# Errors raised before a byte of the request left: safe to resend even a hand-in.
|
|
30
|
+
NOT_SENT = (httpx.ConnectError, httpx.ConnectTimeout, httpx.PoolTimeout)
|
|
31
|
+
# A platform on this machine is reached directly: neither HTTP(S)_PROXY nor --proxy ever sees its
|
|
32
|
+
# requests, so the token of a local platform never leaves the machine through a proxy. Other loopback
|
|
33
|
+
# spellings (127.0.0.2, 0.0.0.0) are refused for http:// by `config.checked_url`, and over https://
|
|
34
|
+
# a proxy sees only CONNECT.
|
|
35
|
+
DIRECT = {f"all://[{host}]" if ":" in host else f"all://{host}": None for host in LOCAL_HOSTS}
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
def _redact(headers: httpx.Headers) -> dict[str, str]:
|
|
39
|
+
return {
|
|
40
|
+
name: ("<скрыт>" if name.lower() in ("authorization", "cookie") else value)
|
|
41
|
+
for name, value in headers.items()
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
def error_of(response: httpx.Response) -> ApiError:
|
|
46
|
+
body: dict[str, Any] = {}
|
|
47
|
+
try:
|
|
48
|
+
parsed = response.json()
|
|
49
|
+
if isinstance(parsed, dict):
|
|
50
|
+
body = parsed
|
|
51
|
+
except ValueError:
|
|
52
|
+
pass
|
|
53
|
+
code = str(body.get("code", "")) or f"http_{response.status_code}"
|
|
54
|
+
detail = str(body.get("detail", "")) if body.get("detail") is not None else ""
|
|
55
|
+
return ApiError(response.status_code, code, detail, body)
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
def _context(ca_bundle: str) -> ssl.SSLContext:
|
|
59
|
+
try:
|
|
60
|
+
return ssl.create_default_context(cafile=ca_bundle)
|
|
61
|
+
except (OSError, ssl.SSLError) as exc:
|
|
62
|
+
raise CliError(
|
|
63
|
+
Exit.USAGE,
|
|
64
|
+
f"Не удалось прочитать файл сертификатов {ca_bundle}.",
|
|
65
|
+
"Проверьте путь в --ca-bundle или ORANGEHACK_CA_BUNDLE: нужен файл PEM.",
|
|
66
|
+
code="ca_bundle",
|
|
67
|
+
) from exc
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
class Client:
|
|
71
|
+
def __init__(
|
|
72
|
+
self,
|
|
73
|
+
base_url: str,
|
|
74
|
+
token: str = "",
|
|
75
|
+
*,
|
|
76
|
+
proxy: str | None = None,
|
|
77
|
+
ca_bundle: str | None = None,
|
|
78
|
+
verbose: bool = False,
|
|
79
|
+
transport: httpx.BaseTransport | None = None,
|
|
80
|
+
sleep: Callable[[float], None] = time.sleep,
|
|
81
|
+
) -> None:
|
|
82
|
+
self.base_url = base_url.rstrip("/")
|
|
83
|
+
self.token = token
|
|
84
|
+
self.verbose = verbose
|
|
85
|
+
self.sleep = sleep
|
|
86
|
+
verify: Any = _context(ca_bundle) if ca_bundle else True
|
|
87
|
+
options: dict[str, Any] = {
|
|
88
|
+
"timeout": TIMEOUT,
|
|
89
|
+
"verify": verify,
|
|
90
|
+
"follow_redirects": True,
|
|
91
|
+
"mounts": DIRECT,
|
|
92
|
+
}
|
|
93
|
+
if proxy:
|
|
94
|
+
options["proxy"] = proxy
|
|
95
|
+
if transport is not None:
|
|
96
|
+
options["transport"] = transport
|
|
97
|
+
# trust_env (the default) honours HTTPS_PROXY, NO_PROXY and SSL_CERT_FILE; DIRECT wins over both proxies.
|
|
98
|
+
self._http = httpx.Client(
|
|
99
|
+
base_url=self.base_url,
|
|
100
|
+
headers={CLIENT_HEADER: client_value(), "User-Agent": f"orangehack-cli/{__version__}"},
|
|
101
|
+
**options,
|
|
102
|
+
)
|
|
103
|
+
# Signed storage addresses get neither the token nor the client header; --verbose shows
|
|
104
|
+
# them without the query, which holds the signature.
|
|
105
|
+
hooks = {"response": [self._log_storage]} if verbose else {}
|
|
106
|
+
self._storage = httpx.Client(event_hooks=hooks, **options)
|
|
107
|
+
|
|
108
|
+
def close(self) -> None:
|
|
109
|
+
self._http.close()
|
|
110
|
+
self._storage.close()
|
|
111
|
+
|
|
112
|
+
# --- logging ---------------------------------------------------------------------------------
|
|
113
|
+
|
|
114
|
+
def _log(self, request: httpx.Request, response: httpx.Response | None, note: str = "") -> None:
|
|
115
|
+
if not self.verbose:
|
|
116
|
+
return
|
|
117
|
+
status = response.status_code if response is not None else "-"
|
|
118
|
+
address = str(request.url)
|
|
119
|
+
if self.token: # `orangehack api` sends PATH as given, and a person may put the token there
|
|
120
|
+
address = address.replace(self.token, "<скрыт>")
|
|
121
|
+
print(f"> {request.method} {address} -> {status} {note}".rstrip(), file=sys.stderr)
|
|
122
|
+
print(f" {_redact(request.headers)}", file=sys.stderr)
|
|
123
|
+
|
|
124
|
+
def _log_storage(self, response: httpx.Response) -> None:
|
|
125
|
+
request = response.request
|
|
126
|
+
address = request.url.copy_with(query=None, fragment=None)
|
|
127
|
+
print(f"> {request.method} {address} -> {response.status_code}", file=sys.stderr)
|
|
128
|
+
|
|
129
|
+
# --- retries ---------------------------------------------------------------------------------
|
|
130
|
+
|
|
131
|
+
def _wait(self, attempt: int, response: httpx.Response | None) -> None:
|
|
132
|
+
delay = DELAYS[attempt]
|
|
133
|
+
if response is not None and response.status_code == 429:
|
|
134
|
+
header = response.headers.get("Retry-After", "")
|
|
135
|
+
try:
|
|
136
|
+
delay = min(float(header), MAX_RETRY_AFTER)
|
|
137
|
+
except ValueError:
|
|
138
|
+
pass
|
|
139
|
+
else:
|
|
140
|
+
self.sleep(delay)
|
|
141
|
+
return
|
|
142
|
+
self.sleep(delay * (1 + random.random() / 2))
|
|
143
|
+
|
|
144
|
+
def send(
|
|
145
|
+
self,
|
|
146
|
+
method: str,
|
|
147
|
+
path: str,
|
|
148
|
+
*,
|
|
149
|
+
auth: bool = True,
|
|
150
|
+
once: bool = False,
|
|
151
|
+
storage: bool = False,
|
|
152
|
+
retries: bool = True,
|
|
153
|
+
raw: bool = False,
|
|
154
|
+
**kwargs: Any,
|
|
155
|
+
) -> httpx.Response:
|
|
156
|
+
"""Send with retries; returns a 2xx (or a 206/416 for ranges) or raises.
|
|
157
|
+
|
|
158
|
+
`retries=False` sends once (the version check, which must never hold a command up).
|
|
159
|
+
`raw=True` (`orangehack api`) returns the last answer of any status and never follows a
|
|
160
|
+
redirect, so the token cannot travel to the address a redirect names.
|
|
161
|
+
"""
|
|
162
|
+
http = self._storage if storage else self._http
|
|
163
|
+
final = len(DELAYS) if retries else 0
|
|
164
|
+
headers = dict(kwargs.pop("headers", None) or {})
|
|
165
|
+
if auth and not storage and self.token:
|
|
166
|
+
headers["Authorization"] = f"Bearer {self.token}"
|
|
167
|
+
sending: dict[str, Any] = {"follow_redirects": False} if raw else {}
|
|
168
|
+
last: httpx.Response | None = None
|
|
169
|
+
for attempt in range(final + 1):
|
|
170
|
+
request = http.build_request(method, path, headers=headers, **kwargs)
|
|
171
|
+
try:
|
|
172
|
+
response = http.send(request, **sending)
|
|
173
|
+
except NOT_SENT as exc:
|
|
174
|
+
self._log(request, None, type(exc).__name__)
|
|
175
|
+
if attempt == final:
|
|
176
|
+
raise CliError(
|
|
177
|
+
Exit.NETWORK,
|
|
178
|
+
f"Нет соединения с {self.base_url}.",
|
|
179
|
+
"Проверьте сеть, прокси (--proxy, HTTPS_PROXY) и адрес (--url).",
|
|
180
|
+
) from exc
|
|
181
|
+
self._wait(attempt, None)
|
|
182
|
+
continue
|
|
183
|
+
except httpx.TransportError as exc:
|
|
184
|
+
self._log(request, None, type(exc).__name__)
|
|
185
|
+
if once:
|
|
186
|
+
raise LostAnswer(str(exc)) from exc
|
|
187
|
+
if attempt == final:
|
|
188
|
+
raise CliError(Exit.NETWORK, "Соединение обрывается. Повторите позже.") from exc
|
|
189
|
+
self._wait(attempt, None)
|
|
190
|
+
continue
|
|
191
|
+
self._log(request, response)
|
|
192
|
+
last = response
|
|
193
|
+
if response.status_code < 400:
|
|
194
|
+
return response
|
|
195
|
+
if response.status_code >= 500 and error_of(response).code == "channel_unavailable":
|
|
196
|
+
break
|
|
197
|
+
if once and not raw and response.status_code >= 500:
|
|
198
|
+
# The hand-in may have been stored before the server or the gateway failed.
|
|
199
|
+
raise LostAnswer(f"{response.status_code}")
|
|
200
|
+
if response.status_code in RETRY_STATUS and attempt < final:
|
|
201
|
+
self._wait(attempt, response)
|
|
202
|
+
continue
|
|
203
|
+
break
|
|
204
|
+
assert last is not None
|
|
205
|
+
if raw:
|
|
206
|
+
return last
|
|
207
|
+
raise error_of(last)
|
|
208
|
+
|
|
209
|
+
def call(self, method: str, path: str, **kwargs: Any) -> Any:
|
|
210
|
+
"""A JSON call to the API; platform errors become `CliError`."""
|
|
211
|
+
try:
|
|
212
|
+
response = self.send(method, path, **kwargs)
|
|
213
|
+
except ApiError as error:
|
|
214
|
+
raise from_api(error, base_url=self.base_url) from error
|
|
215
|
+
if not response.content:
|
|
216
|
+
return None
|
|
217
|
+
try:
|
|
218
|
+
return response.json()
|
|
219
|
+
except ValueError as exc:
|
|
220
|
+
if kwargs.get("once"):
|
|
221
|
+
# Something between us and the platform answered; the hand-in may still be stored.
|
|
222
|
+
raise LostAnswer("not json") from exc
|
|
223
|
+
raise CliError(
|
|
224
|
+
Exit.NETWORK,
|
|
225
|
+
f"Вместо ответа платформы пришла чужая страница ({self.base_url}).",
|
|
226
|
+
"Похоже, сеть требует входа (Wi-Fi с авторизацией) или прокси подменяет ответы. "
|
|
227
|
+
"Войдите в сеть в браузере, проверьте --proxy и --url и повторите.",
|
|
228
|
+
code="not_json",
|
|
229
|
+
) from exc
|
|
230
|
+
|
|
231
|
+
def get(self, path: str, **kwargs: Any) -> Any:
|
|
232
|
+
return self.call("GET", path, **kwargs)
|
|
233
|
+
|
|
234
|
+
def post(self, path: str, body: Any = None, **kwargs: Any) -> Any:
|
|
235
|
+
return self.call("POST", path, json=body if body is not None else {}, **kwargs)
|
|
236
|
+
|
|
237
|
+
@property
|
|
238
|
+
def storage(self) -> httpx.Client:
|
|
239
|
+
return self._storage
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"""One module per group of commands; `main.py` registers them."""
|