article-backup 0.2.3__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,315 @@
1
+ Metadata-Version: 2.4
2
+ Name: article-backup
3
+ Version: 0.2.3
4
+ Summary: Локальный бэкап статей с Sponsr.ru и Boosty.to в Markdown с Hugo-интеграцией
5
+ Author-email: Eugene Chaykin <eugene@chayk.in>
6
+ License: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/strannick-ru/article-backup
8
+ Project-URL: Repository, https://github.com/strannick-ru/article-backup
9
+ Project-URL: Bug Tracker, https://github.com/strannick-ru/article-backup/issues
10
+ Project-URL: Changelog, https://github.com/strannick-ru/article-backup/blob/main/CHANGELOG.md
11
+ Keywords: backup,markdown,sponsr,boosty,archiver,hugo
12
+ Classifier: Development Status :: 4 - Beta
13
+ Classifier: Intended Audience :: End Users/Desktop
14
+ Classifier: License :: OSI Approved :: Apache Software License
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
20
+ Classifier: Topic :: System :: Archiving :: Backup
21
+ Requires-Python: >=3.10
22
+ Description-Content-Type: text/markdown
23
+ License-File: LICENSE
24
+ Requires-Dist: requests
25
+ Requires-Dist: beautifulsoup4
26
+ Requires-Dist: lxml
27
+ Requires-Dist: html2text
28
+ Requires-Dist: python-slugify
29
+ Requires-Dist: pyyaml
30
+ Dynamic: license-file
31
+
32
+ # Article Backup
33
+
34
+ [![PyPI version](https://img.shields.io/pypi/v/article-backup.svg)](https://pypi.org/project/article-backup/)
35
+ [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
36
+ [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
37
+
38
+ Скрипт для локального бэкапа статей с платформ **Sponsr.ru** и **Boosty.to**.
39
+
40
+ Конвертирует статьи в Markdown с YAML-метаданными, скачивает изображения и другие медиафайлы, поддерживает инкрементальную синхронизацию.
41
+
42
+ ## Возможности
43
+
44
+ - Полный архив статей одного или нескольких авторов
45
+ - Инкрементальные обновления — скачивает только новые статьи
46
+ - Конвертация в Markdown с frontmatter (title, date, tags, source)
47
+ - Локальное сохранение изображений, видео, аудио, PDF
48
+ - Гибкая фильтрация типов скачиваемых файлов (image, video, audio, document)
49
+ - Сохранение ссылок на встроенные видео (Rutube, YouTube, Vimeo, VK, OK.ru)
50
+ - Нормализация сложной разметки Sponsr (вложенный em/strong, кавычки, bidi-маркеры)
51
+ - Исправление внутренних ссылок между статьями
52
+ - Интеграция с Hugo для просмотра в браузере (поддержка тем, улучшенная типографика)
53
+ - SQLite-индекс для быстрого поиска
54
+
55
+ ## Установка
56
+
57
+ Требуется **Python 3.10+**
58
+
59
+ ### Вариант 1: Через pip (рекомендуется)
60
+
61
+ ```bash
62
+ pip install article-backup
63
+ ```
64
+
65
+ ### Вариант 2: Из исходников
66
+
67
+ ```bash
68
+ git clone https://github.com/strannick-ru/article-backup.git
69
+ cd article-backup
70
+ python -m venv venv
71
+ source venv/bin/activate # Linux/macOS
72
+ # venv\Scripts\activate # Windows
73
+ pip install -r requirements.txt
74
+ ```
75
+
76
+ ## Настройка
77
+
78
+ ### 1. Создайте конфиг
79
+
80
+ ```bash
81
+ cp config.yaml.example config.yaml
82
+ ```
83
+
84
+ ### 2. Заполните `config.yaml`
85
+
86
+ ```yaml
87
+ output_dir: ./backup
88
+
89
+ hugo:
90
+ base_url: "https://example.com/"
91
+ title: "Бэкап статей"
92
+ language_code: "ru"
93
+
94
+ auth:
95
+ sponsr_cookie_file: ./sponsr_cookie.txt
96
+ boosty_cookie_file: ./boosty_cookie.txt
97
+ boosty_auth_file: ./boosty_auth.txt
98
+
99
+ sources:
100
+ - platform: sponsr
101
+ author: pushkin
102
+ display_name: "Пушкин. Проза"
103
+ asset_types: ["image", "document"] # Скачивать только картинки и документы
104
+
105
+ - platform: boosty
106
+ author: lermontov
107
+ display_name: "Лермонтов. Стихи"
108
+ ```
109
+
110
+ ### 3. Получите токены авторизации
111
+
112
+ #### Sponsr
113
+
114
+ 1. Войдите на sponsr.ru
115
+ 2. Откройте DevTools (F12) → Network
116
+ 3. Перезагрузите страницу
117
+ 4. Найдите любой запрос → Headers → Cookie
118
+ 5. Скопируйте значение в `sponsr_cookie.txt`
119
+
120
+ #### Boosty
121
+
122
+ 1. Войдите на boosty.to
123
+ 2. Откройте DevTools (F12) → Console
124
+ 3. Вставьте код:
125
+ ```javascript
126
+ const cookie = document.cookie;
127
+ const auth = JSON.parse(decodeURIComponent(document.cookie.match(/auth=([^;]+)/)[1]));
128
+ console.log("Cookie:\n" + cookie + "\n\nAuthorization:\nBearer " + auth.accessToken);
129
+ ```
130
+ 4. Скопируйте Cookie в `boosty_cookie.txt`
131
+ 5. Скопируйте Authorization в `boosty_auth.txt`
132
+
133
+ ## Использование
134
+
135
+ ### Синхронизация всех авторов
136
+
137
+ ```bash
138
+ # Если установлено через pip
139
+ article-backup
140
+
141
+ # Или из исходников
142
+ python backup.py
143
+ ```
144
+
145
+ ### Скачать один пост по URL
146
+
147
+ ```bash
148
+ article-backup "https://sponsr.ru/author/12345/post-title/"
149
+ article-backup "https://boosty.to/author/posts/uuid"
150
+ ```
151
+
152
+ ### Указать другой конфиг
153
+
154
+ ```bash
155
+ article-backup -c /path/to/config.yaml
156
+ ```
157
+
158
+ ## Разработка
159
+
160
+ ### Тесты
161
+
162
+ Проект использует встроенный `unittest`.
163
+
164
+ ```bash
165
+ python -m unittest -q
166
+ ```
167
+
168
+ ## Docker
169
+
170
+ Для серверов с устаревшим Python можно использовать Docker.
171
+
172
+ Для удобства используйте скрипт `run-docker.sh`, который автоматически подхватывает `output_dir` из вашего `config.yaml` и монтирует правильный volume.
173
+
174
+ ```bash
175
+ # Синхронизация + сборка сайта (рекомендуемый способ)
176
+ ./run-docker.sh
177
+
178
+ # Скачать один пост
179
+ ./run-docker.sh "https://sponsr.ru/author/123/"
180
+
181
+ # Только пересборка сайта
182
+ ./run-docker.sh hugo
183
+
184
+ # Пересборка контейнеров
185
+ ./run-docker.sh build
186
+ ```
187
+
188
+ ### Ручной запуск (Advanced)
189
+
190
+ Если вы не хотите использовать скрипт, можно запускать через `docker compose`, но нужно вручную указывать путь к бэкапам, если он отличается от `./backup`.
191
+
192
+ ```bash
193
+ # Если output_dir в конфиге = ./backup
194
+ docker compose run --rm backup
195
+
196
+ # Если output_dir другой
197
+ HOST_BACKUP_DIR=/path/to/data docker compose run --rm backup
198
+ ```
199
+
200
+ ### Cron
201
+
202
+ Для автоматической синхронизации добавьте в crontab:
203
+
204
+ ```bash
205
+ # Каждый день в 3:00
206
+ 0 3 * * * cd /path/to/article-backup && docker compose run --rm backup && docker compose run --rm hugo >> /var/log/article-backup.log 2>&1
207
+ ```
208
+
209
+ ## Структура выходных файлов
210
+
211
+ ```
212
+ backup/
213
+ ├── index.db # SQLite-индекс
214
+ ├── sponsr/
215
+ │ └── pushkin/
216
+ │ ├── _index.md
217
+ │ └── posts/
218
+ │ └── 2026-01-31-article-title/
219
+ │ ├── index.md # Статья с frontmatter
220
+ │ └── assets/ # Медиафайлы
221
+ └── boosty/
222
+ └── lermontov/
223
+ └── posts/
224
+ └── 2026-01-31-another-article/
225
+ ├── index.md
226
+ └── assets/
227
+ ```
228
+
229
+ ## Интеграция с Hugo
230
+
231
+ После каждого запуска `backup.py`:
232
+ - Автоматически создаётся симлинк `site/content → output_dir`
233
+ - Генерируется `site/hugo.toml` из секции `hugo:` в конфиге
234
+
235
+ ```bash
236
+ # Запуск локального сервера
237
+ cd site && hugo server -D
238
+ ```
239
+
240
+ Откройте http://localhost:1313
241
+
242
+ ### Настройка Hugo
243
+
244
+ Параметры Hugo задаются в `config.yaml`:
245
+
246
+ ```yaml
247
+ hugo:
248
+ base_url: "https://example.com/" # URL сайта для production
249
+ title: "Мой архив статей" # Заголовок сайта
250
+ language_code: "ru" # Язык контента
251
+ default_theme: "sepia" # Тема по умолчанию: light, dark, sepia, gruvbox, everforest
252
+ ```
253
+
254
+ Сайт поддерживает переключение тем "на лету" (кнопки в углу экрана). Выбор пользователя сохраняется в браузере.
255
+
256
+ Если секция `hugo:` не указана, используются значения по умолчанию (`http://localhost:1313/`).
257
+
258
+ ### RSS-ленты
259
+
260
+ Для каждого автора автоматически генерируется RSS-фид:
261
+
262
+ - `http://localhost:1313/sponsr/pushkin/index.xml`
263
+ - `http://localhost:1313/boosty/lermontov/index.xml`
264
+
265
+ На странице автора отображается ссылка 📡 для подписки.
266
+
267
+ ### Субдомены для авторов (nginx)
268
+
269
+ Каждого автора можно раздавать на отдельном субдомене. При использовании Docker CSS автоматически копируется в папки авторов.
270
+
271
+ ```bash
272
+ # Docker (CSS копируется автоматически)
273
+ docker compose run --rm backup && docker compose run --rm hugo
274
+
275
+ # Или локально через build.sh
276
+ cd site && ./build.sh
277
+ ```
278
+
279
+ Пример конфига nginx:
280
+
281
+ ```nginx
282
+ server {
283
+ listen 80;
284
+ server_name pushkin.example.site;
285
+ root /var/www/backup/site/public/sponsr/pushkin;
286
+ index index.html;
287
+
288
+ # Корень показывает список постов
289
+ location = / {
290
+ try_files /posts/index.html =404;
291
+ }
292
+
293
+ location / {
294
+ try_files $uri $uri/ =404;
295
+ }
296
+ }
297
+ ```
298
+
299
+ ## Формат статьи
300
+
301
+ ```yaml
302
+ ---
303
+ title: "Заголовок статьи"
304
+ date: 2024-01-15T12:00:00
305
+ source: https://sponsr.ru/pushkin/12345/...
306
+ author: pushkin
307
+ platform: sponsr
308
+ post_id: 12345
309
+ tags: ["тег1", "тег2"]
310
+ ---
311
+
312
+ # Заголовок статьи
313
+
314
+ Текст статьи...
315
+ ```
@@ -0,0 +1,14 @@
1
+ backup.py,sha256=6I5hGCY7UFMcH_GC437rcf3Pf5HI38rJdb2V0TKwcT8,6203
2
+ article_backup-0.2.3.dist-info/licenses/LICENSE,sha256=H7HKbB-BFnuJAfBBasE5FntYOdqzSGckwx6wxMlnfSA,10173
3
+ src/__init__.py,sha256=uV3ILKFkjpxUZ3w5HS9i5dxnL-gGIMFBzT96lSOETXM,14
4
+ src/boosty.py,sha256=oozGgcCqCsLup3LNWylb89M9AETudDHEQhExu2JjsDw,9007
5
+ src/config.py,sha256=xmAFMHv1ya2lnyFPZe9hDnRfI5MooIl2aBr2BKAcpGo,3373
6
+ src/database.py,sha256=TSbdI_8OgVtUNT_K5Wxlq0wLq3uti07qKsSuRqY0aoU,5763
7
+ src/downloader.py,sha256=zVVabcTdeYAy5R6XWS1Tbd03KpSLA4EO_BW5QSH9eoQ,14147
8
+ src/sponsr.py,sha256=WquXiGF606Hh46IGHD3SsmjhS6NYgolAahBr6CJRmaM,14291
9
+ src/utils.py,sha256=egcvTqg7hZowntPpIInNwcm0KYdE0WQTxjoM0QptKm4,5723
10
+ article_backup-0.2.3.dist-info/METADATA,sha256=ZT1fkdG-sPJZP3nq0UYNfHbfFLTyUsCpZgWfiETX6sw,10491
11
+ article_backup-0.2.3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
12
+ article_backup-0.2.3.dist-info/entry_points.txt,sha256=Nz5rb3V5-Vkm0gJ18e1eOb6fY6f1GeoHiAGGQHQgHrQ,47
13
+ article_backup-0.2.3.dist-info/top_level.txt,sha256=9Iu_UMhupxvQh2cehV6bzaqPeTDrDCakTE82bJG5WxI,11
14
+ article_backup-0.2.3.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (80.10.2)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ article-backup = backup:main
@@ -0,0 +1,177 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to the Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no theory of
154
+ liability, whether in contract, strict liability, or tort
155
+ (including negligence or otherwise) arising in any way out of
156
+ the use or inability to use the Work (even if such Contributor
157
+ has been advised of the possibility of such damages), shall any
158
+ Contributor be liable to You for any actual, direct, indirect,
159
+ incidental, special, exemplary, or consequential damages,
160
+ including but not limited to damages for loss of goodwill, work
161
+ stoppage, computer failure or malfunction, or any and all other
162
+ commercial damages or losses, unless required by applicable law
163
+ (such as deliberate and grossly negligent acts) or agreed to in
164
+ writing.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
@@ -0,0 +1,2 @@
1
+ backup
2
+ src