orangehack 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.
@@ -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,23 @@
1
+ orangehack/__init__.py,sha256=mdLp8NsfpN_oLE64EbtnonJKDb6z7YNvZrCkPutMQ_Y,479
2
+ orangehack/__main__.py,sha256=CnXNTEvTGzcH7oL7CozD_C3vDVuBfMWH6V93GuaEaDQ,29
3
+ orangehack/client.py,sha256=_tlSGBKPApOrPnK-gLe5Bf6v2xGf5iM7MknFcVaVrGA,10137
4
+ orangehack/config.py,sha256=qzFjxY0XX__AUuiibU6FLuS6ssS56bHfwlJwwURSB_s,7335
5
+ orangehack/errors.py,sha256=Enm_4O1b2EEw8VLf3mU0jk86sL5AjAMoHjNjU3PVw5o,4632
6
+ orangehack/main.py,sha256=nibxRc67NIH7lDCwI8mzQH-L7moRRZckExIf2oa4GI4,3267
7
+ orangehack/output.py,sha256=ZaTqh-ndoZT0hbQT8-AHWqyKIizGm8XV2-oUE9ifg6Q,3775
8
+ orangehack/resolve.py,sha256=8pJRRn5vJsc30HxEHJuZWngvFrmvpz2EUXg__SZiSns,5906
9
+ orangehack/session.py,sha256=V9pdCV5RbkQYULX-dt5rKMpIpKobYs4re9-u8vM7n2M,4244
10
+ orangehack/transfer.py,sha256=-je2lowPrXglHOHgI3XD4IKciQ6D9xH9k4kPoP9x1lM,16774
11
+ orangehack/version_check.py,sha256=EpyaevCJNw1lZPuwz5zc_88j5CpivhGteGff--YY0A0,3540
12
+ orangehack/commands/__init__.py,sha256=5ONYUAw_tiKxfRHOOcJ_0WnH8QG4b0qrLsfbE2-hNkY,66
13
+ orangehack/commands/api.py,sha256=SzT1OwBtAEainc7mnV8_nzkX1mDC_o-Tiz_YU32FvKE,14158
14
+ orangehack/commands/attempts.py,sha256=i1PKcGfbRhU3lhkkq6lMOqZ_DF1ayKGC8LuL8fZNt0M,10214
15
+ orangehack/commands/auth.py,sha256=RDD0M5q6YtbKyVwJyx7dNkMlpzLmoavNpvnNMgEEfnY,9622
16
+ orangehack/commands/competitions.py,sha256=HLeGjC3Gq1R9NixPADh5_2YAVbL0i7EwB4fEAemmvjY,8131
17
+ orangehack/commands/download.py,sha256=6z3123flZbiyOtm7FVacvnVLo9nLyXlDH-xsPQTTLg8,5765
18
+ orangehack/commands/leaderboard.py,sha256=R14RyZV3DA-lWbMXPQSN5WO2BMWONqmrWZ7WIZN8GNI,4960
19
+ orangehack/commands/submit.py,sha256=m4iSY0hE20Mjqq2R4vQW_O1v1Q5Hj5-3VAPUtuqP44I,15638
20
+ orangehack-0.1.0.dist-info/METADATA,sha256=XnKVdSIagQhSdnF7Tg0CmJ06ZYb0adv2tJlGlGTkd0I,10147
21
+ orangehack-0.1.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
22
+ orangehack-0.1.0.dist-info/entry_points.txt,sha256=QfKjLT-UbPC5R0HI-RKW8IP5XMF4-mEuXUl9b2W95AM,51
23
+ orangehack-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: hatchling 1.33.0
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ orangehack = orangehack.main:run