Skip to content

Commit 81ac6e5

Browse files
diam0voidiam0voi
authored
Update README.ru.md
Signed-off-by: Ostap Baranov <wolfboomm7@mail.ru>
1 parent df38ab6 commit 81ac6e5

File tree

1 file changed

+38
-47
lines changed

1 file changed

+38
-47
lines changed

‎README.ru.md‎

Lines changed: 38 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -5,87 +5,83 @@ Switch to ENG ---> [![switch to ENG](https://img.shields.io/badge/lang-en-red.sv
55

66
### Информативное
77
| | |
8-
|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
9-
| **Стэк** | [![Python](https://img.shields.io/badge/Python-3776AB?style=flat-square&logo=python&logoColor=ffe770)](https://www.python.org/) [![Pytest](https://img.shields.io/badge/Pytest-gray?style=flat-square&logo=pytest&logoColor=0a9edc)](https://pytest.org/) [![Ruff](https://img.shields.io/badge/Ruff-gray?style=flat-square&logo=ruff&logoColor=d7ff64)](https://astral.sh/ruff) [![uv](https://img.shields.io/badge/uv-gray?style=flat-square&logo=uv&logoColor=de5fe9)](https://astral.sh/uv) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-fe5196?logo=conventionalcommits&logoColor=fe5196&style=flat-square)](https://conventionalcommits.org) <br> [![SemVer](https://img.shields.io/github/v/release/diam0voi/RGO-lib-parser?label=SemVer&color=3f4551&style=flat-square&logo=semver)](https://semver.org/) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=flat-square&logo=pre-commit&logoColor=#fab040)](https://pre-commit.com/) [![Commitizen](https://img.shields.io/badge/Commitizen-friendly-brightgreen?style=flat-square&)](https://commitizen-tools.github.io/commitizen/) |
8+
|:-----------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
9+
| **Технологии** | [![Python](https://img.shields.io/badge/Python-3776AB?style=flat-square&logo=python&logoColor=ffe770)](https://www.python.org/) [![Pytest](https://img.shields.io/badge/Pytest-gray?style=flat-square&logo=pytest&logoColor=0a9edc)](https://pytest.org/) [![Ruff](https://img.shields.io/badge/Ruff-gray?style=flat-square&logo=ruff&logoColor=d7ff64)](https://astral.sh/ruff) [![uv](https://img.shields.io/badge/uv-gray?style=flat-square&logo=uv&logoColor=de5fe9)](https://astral.sh/uv) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-fe5196?logo=conventionalcommits&logoColor=fe5196&style=flat-square)](https://conventionalcommits.org) <br> [![SemVer](https://img.shields.io/github/v/release/diam0voi/RGO-lib-parser?label=SemVer&color=3f4551&style=flat-square&logo=semver)](https://semver.org/) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=flat-square&logo=pre-commit&logoColor=#fab040)](https://pre-commit.com/) [![Commitizen](https://img.shields.io/badge/Commitizen-friendly-brightgreen?style=flat-square&)](https://commitizen-tools.github.io/commitizen/) |
1010
| **Метрики** | [![Test Status](https://img.shields.io/github/actions/workflow/status/diam0voi/RGO-lib-parser/ci.yml?branch=main&label=tests&logo=github&style=flat-square)](https://github.com/diam0voi/RGO-lib-parser/actions/workflows/ci.yml) [![codecov](https://codecov.io/gh/diam0voi/RGO-lib-parser/graph/badge.svg)](https://codecov.io/gh/diam0voi/RGO-lib-parser) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/e25b481825024b33864c2c7311ee7fa8)](https://app.codacy.com/gh/diam0voi/RGO-lib-parser/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/diam0voi/RGO-lib-parser/badge)](https://scorecard.dev/viewer/?uri=github.com/diam0voi/RGO-lib-parser)|
1111
| **Совместимость** | ![Python Version](https://img.shields.io/badge/python-3.9+-brightgreen?logo=python&logoColor=ffe770&style=flat-square) ![Windows X](https://img.shields.io/badge/Windows%20X%2010+-0078D6?style=flat-square) ![macOS X](https://img.shields.io/badge/MacOS%20X%2013+-000000?logo=macos&logoColor=white&style=flat-square&logoSize=auto) ![Ubuntu X](https://img.shields.io/badge/Ubuntu%20X%2022+-E95420?logo=ubuntu&logoColor=white&style=flat-square&logoSize=auto) |
12-
| **Другое** | [![GitHub last commit](https://img.shields.io/github/last-commit/diam0voi/RGO-lib-parser?style=flat-square)](https://github.com/diam0voi/RGO-lib-parser/commits/main) ![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/diam0voi/RGO-lib-parser/total?style=flat-square) [![GitHub repo size](https://img.shields.io/github/repo-size/diam0voi/RGO-lib-parser.svg?style=flat-square)](https://github.com/diam0voi/RGO-lib-parser/) [![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/diam0voi/RGO-lib-parser.svg?style=flat-square)](https://github.com/diam0voi/RGO-lib-parser/) |
13-
| | |
12+
| **Другое** | [![GitHub last commit](https://img.shields.io/github/last-commit/diam0voi/RGO-lib-parser?style=flat-square)](https://github.com/diam0voi/RGO-lib-parser/commits/main) ![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/diam0voi/RGO-lib-parser/total?style=flat-square) [![GitHub repo size](https://img.shields.io/github/repo-size/diam0voi/RGO-lib-parser.svg?style=flat-square)](https://github.com/diam0voi/RGO-lib-parser/) [![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/diam0voi/RGO-lib-parser.svg?style=flat-square)](https://github.com/diam0voi/RGO-lib-parser/) |
13+
| | |
1414

15+
### Простенькая штучка для непростенькой задачки
16+
Перед вами "парсер" - ПО, предназначенное для получения информации с конкретного сайта напрямую, из-за его причудливого формата хранения данных.
17+
Конкретно это приложение упрощает работу с библиотекой Российского Географического Общества. У них собраны сканы редких и очень нишевых экземпляров письменных исторических источников разных эпох, которые вам могут понадобится, скажем, для интерактивной панели на выставке.
18+
Но просто их не получить, по умолчанию можно только смотреть! Так родилась идея автоматизировать процесс создания целой горы скриншотов руками: я решил облегчить жизнь знакомым, которым пришлось этим заниматься.
19+
20+
Важно: я **НЕ ЯВЛЯЮСЬ** как владельцем сайта библиотеки, так и правообладателем публикуемого на нём материала, все права защищены и принадлежат текущим владельцам сайта!
1521

16-
### Простенькая штучка для простенькой задачки
17-
По своей сути - это парсер, предназначенный для конкретного сайта с его отчасти причудливым форматом хранения данных. На нём собраны сканы редких экземпляров очень нишевых исторических литературных источников, которые вам могут понадобится, скажем, для интерактивной панели на выставке. Но просто так вам их не получить! Вы можете только смотреть! Так родилась идея автоматизировать процесс ручного создания целой горы скриншотов: я решил облегчить жизнь знакомым, которым пришлось этим заниматься.
18-
19-
Это мой первый проект ТАКОГО уровня, так что не удивляйтесь коммитам в 2 строчки и совершенно нелепым косякам, со временем я точно освоюсь и чувство кринжа пройдёт (нет).
20-
21-
Важно: я НЕ ЯВЛЯЮСЬ как владельцем сайта библиотеки, так и правообладателем публикуемого на нём материала, все права защищены и принадлежат текущим владельцам сайта!
22+
_Для сторонних разработчиков: это мой первый проект ТАКОГО уровня, так что не удивляйтесь коммитам в 2 строчки и совершенно нелепым косякам, со временем я точно освоюсь и чувство стыда у вас пройдёт :3_
2223

2324

2425
## Примеры работы на разных этапах
26+
### GIF-демо
2527
![example-cycle-gif](https://github.com/user-attachments/assets/292932c0-d829-407f-b978-e20163b64dff)
2628

2729
---
30+
31+
### Галерея
2832
![Example-start](https://github.com/user-attachments/assets/4ec54270-8c15-4eb1-b83e-0956a8c59e79)
2933

3034
![Example-process](https://github.com/user-attachments/assets/6040a85c-3043-4d02-ad77-e4095adf2ec0)
3135

3236
![Example-result](https://github.com/user-attachments/assets/f57566c9-c692-4e68-91f5-5f2589cf34dc)
3337

34-
35-
## Как воспользоваться
36-
37-
Ниже привёл инструкции по непосредственно запуску ПО для различных операционнок после загрузки соответствующего файла из раздела **Assets** последнего релиза.
38-
Приложение сделано в формате Standalone Portable, строгое наличие языка разработки у вас (Python) **НЕ** требуется!
39-
40-
---
38+
## Установка
39+
Приложение выполнено в формате _Standalone Portable_, наличие языка разработки (Python) и прочего у вас **НЕ** требуется!
40+
В зависимости от вашей операционной системы, в блоке **Assets** последнего релиза скачайте один из файлов **RGO_lib_parser**:
41+
* Windows — `RGO_lib_parser_win64.exe`
42+
* macOS — `RGO_lib_parser_macOS.zip`
43+
* Linux (пока только Debian-based) — `RGO_lib_parser_ubuntu`
44+
Ниже для _каждого_ варианта описан _свой_ порядок действий при первом запуске.
4145

4246
### Windows (`RGO_lib_parser_win64.exe`)
43-
44-
1. **Скачивание:** скачайте файл `RGO_lib_parser_win64.exe` из релиза.
45-
2. **Запуск:** найдите у себя на компьютере этот файл и запустите.
46-
3. **Оповещение безопасности:** Встроенный защитник Windows 10+ SmartScreen наверняка покажет предупреждение ("Windows защитила ваш компьютер"), потому что я не имел оффициального (и дорогущего) сертификата подписи кода.
47+
1. **Запуск:** найдите у себя на компьютере этот файл и запустите.
48+
2. **Оповещение безопасности:** встроенный защитник Windows 10+ SmartScreen наверняка покажет предупреждение ("Windows защитила ваш компьютер"), потому что я не имел оффициального (и дорогущего) сертификата подписи кода.
4749
* Если оно вам встретилось, нажмите на **"Подробнее"**.
4850
* После этого появится кнопка **"Выполнить в любом случае"**, нажимайте.
4951
* Это нужно только при первом запуске. При желании отключите у себя насовсем, инструкции в интернете.
5052

51-
---
52-
5353
### macOS (`RGO_lib_parser_macOS.zip`)
54-
55-
1. **Скачивание:** скачайте файл `RGO_lib_parser_macOS.zip` из релиза.
56-
2. **Распаковка:** найдите у себя на компьютере этот архив `.zip` и распакуйте просто двойным кликом.
57-
3. **Запуск:**
54+
1. **Распаковка:** найдите у себя на компьютере этот `.zip` архив и распакуйте (например, просто двойным кликом).
55+
2. **Запуск:**
5856
* Найдите в распакованном архиве файл `RGO Lib Parser.app`.
5957
* Рекомендовано: перетащите этот файл из "Загрузки" в вашу папку "Приложения".
6058
* **Важно: правый клик (или `Control`-клик)** по иконке `RGO Lib Parser.app`.
61-
4. **Оповещение безопасности:** вы наверняка увидите предупреждение, что приложение у вас от неопределённого разработчика, потому что я не обладаю оффициальным (и дорогущим) Apple Developer ID. Но так как вы открываете через "расширенный доступ", вы увидите кнопку **"Открыть"** в диалоговом окне, нажимайте. После этого запуск доступен двойным кликом.
59+
3. **Оповещение безопасности:** вы наверняка увидите предупреждение, что приложение у вас от неопределённого разработчика, потому что я не обладаю оффициальным (и дорогущим) Apple Developer ID. Но так как вы открываете через "расширенный доступ", вы увидите кнопку **"Открыть"** в диалоговом окне, нажимайте. После этого запуск доступен просто двойным кликом.
6260

63-
---
6461

65-
### Linux (пока Debian-based - `RGO_lib_parser_ubuntu`)
62+
### Linux (`RGO_lib_parser_ubuntu`)
63+
1. **Работа в терминале:** запустите свой терминал.
64+
2. **Перемещение:** перейдите в директорию, где оказался скачанный файл (e.g., `cd ~/Downloads` or `cd ~/Загрузки`).
65+
3. **Флаг исполняемости:** предоставьте файлу разрешение на запуск командой: `chmod +x RGO_lib_parser_ubuntu`
66+
4. **Запуск:** запустите приложение командой: `./RGO_lib_parser_ubuntu`. После этого запуск будет доступен _этой_ командой или через GUI.
6667

67-
1. **Скачивание:** скачайте файл `RGO_lib_parser_ubuntu` (он без расширения) из релиза.
68-
2. **Работа в терминале:** запустите свой терминал.
69-
3. **Перемещение:** перейдите в директорию, где оказался скачанный файл (e.g., `cd ~/Downloads` or `cd ~/Загрузки`).
70-
4. **Флаг исполняемости:** предоставьте файлу разрешение на запуск командой: `chmod +x RGO_lib_parser_ubuntu`
71-
*(Обычно это нужно только при первом запуске).*
72-
5. **Запуск:** запустите приложение командой: `./RGO_lib_parser_ubuntu`
7368
---
7469

75-
## Основные инструкции
76-
1. Скачайте последнюю версию программы под свою ОС.
70+
## Инструкция по работе
71+
1. Запустите приложение.
7772
2. Откройте нужный вам документ на сайте библиотеки открытого Русского географического общества (в модуле защищенного просмотра (МЗП)).
7873
3. Убедитесь, что ссылка имеет вид "https://elib.rgo.ru/safe-view/123456789/.../.../.../":
7974
![Example-link](https://github.com/user-attachments/assets/5d3456be-0ecd-42a0-9f6c-de6912b13f45)
8075
4. Скопируйте имя файла на сайте (есть на само́й странице документа или в МЗП) и **реальное** кол-во страниц (в МЗП):
8176
![Example-what-to-copy](https://github.com/user-attachments/assets/1741be2b-ad76-4259-955c-d880832ebbcc)
8277
5. Кайфуйте!
83-
78+
ПО запоминает проблемы
8479

8580
## Идеи на будущее
86-
Думаю внедрить авто-распознавание пустых (несодержательных) разворотов, консольный интерфейс, прикреплять файлы SBOM и SLSA к релизам, покрыть уже интеграционными тестами и пофиксить всё-всё-всё!
81+
Думаю внедрить авто-распознавание пустых (несодержательных) разворотов и/или страниц, добавить консольный интерфейс и улучшить текущий (скорее всего с переходом на PySide для удобства внедрения ассетов и высокоуровневого тестирования), начать прикреплять файлы SBOM и SLSA к релизам, покрыть разные связки компонентов теперь уже интеграционными тестами и отладить всё-всё-всё, что мне помогли найти после мягкого запуска программы!
8782

88-
## Схемы-деревья репозитория и зависимостей проекта
83+
## Схемы-деревья:
84+
### Репозиторий
8985
```
9086
RGO-lib-parser v1.4
9187
├── .github/
@@ -106,17 +102,14 @@ RGO-lib-parser v1.4
106102
│ ├── CODEOWNERS(.bib)
107103
│ └── labels.yml
108104
│
109-
│
110105
├── assets/
111106
│ ├── macapp_lilacbook.icns
112107
│ ├── winapp_lilacbook.ico
113108
│ └── window_bnwbook.png
114109
│
115-
│
116110
├── scripts/
117111
│ └── run_app.py
118112
│
119-
│
120113
├── src/
121114
│ ├── __init__.py
122115
│ ├── app_state.py
@@ -131,7 +124,6 @@ RGO-lib-parser v1.4
131124
│ ├── ui_builder.py
132125
│ └── utils.py
133126
│
134-
│
135127
├── tests/
136128
│ ├── __init__.py
137129
│ ├── test_app_state.py
@@ -144,12 +136,10 @@ RGO-lib-parser v1.4
144136
│ ├── test_types.py
145137
│ └── test_utils.py
146138
│
147-
│
148139
├── v0.1 separated/
149140
│ ├── sdloady_RGO_lib.py
150141
│ └── spready_RGO_lib.py
151142
│
152-
│
153143
├── .codacy.yaml
154144
├── .gitattributes(.bib)
155145
├── .gitignore(.bib)
@@ -167,6 +157,7 @@ RGO-lib-parser v1.4
167157
└── uv.lock
168158
```
169159
---
160+
### Зависимости проекта
170161
```
171162
RGO-lib-parser v1.4
172163
├── pillow v11.2.1

0 commit comments

Comments
 (0)