vkms


Namevkms JSON
Version 1.0.2 PyPI version JSON
download
home_page
SummaryUtility for saving messages from the VK social network
upload_time2023-05-31 08:51:13
maintainer
docs_urlNone
author
requires_python
licenseGPL-3.0-only
keywords api parser vk messages saver
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # vk-messages-saver

[![Maintanance](https://img.shields.io/maintenance/yes/2023?style=flat-square)](https://github.com/YariKartoshe4ka/vk-messages-saver/commits/master)
[![Releases](https://img.shields.io/github/v/release/YariKartoshe4ka/vk-messages-saver?style=flat-square)](https://github.com/YariKartoshe4ka/vk-messages-saver/releases)
[![VK API](https://img.shields.io/static/v1?label=API&message=5.131&color=a938e4&labelColor=000000&logo=vk&style=flat-square)](https://dev.vk.com/)
[![PyPI](https://img.shields.io/pypi/pyversions/vkms?style=flat-square)](https://pypi.org/project/vkms/)
[![Speed](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/YariKartoshe4ka/bf106ade592cbea6189b89f71c7545e9/raw/vkms-speed.json)](https://github.com/YariKartoshe4ka/vk-messages-saver/actions)

Утилита для сохранения переписок ВКонтакте


### Установка

Загружаем и устанавливаем последнюю версию VKMS из [PyPI](https://pypi.org/project/vkms/)

```bash
pip install vkms
```


### Использование

1. Получаем токен доступа с правами на сообщения от официального приложения. Можно воспользоваться [этим сайтом](https://vkhost.github.io/). После авторизации копируем из адресной строки параметр *access_token* и вставляем его в терминал

    ```bash
    export ACCESS_TOKEN='...'
    ```

2. Запускаем VKMS и скачиваем полную информацию о переписках

    ```bash
    vkms dump
    ```

    Теперь можно спарсить полученные данные в удобный для чтения формат

    ```bash
    vkms parse
    ```


### Функции

В данный момент VKMS может:

- Сохранять переписки в программном формате (JSON), доступна многопоточная загрузка (`vkms dump`)
- Сохранять переписки в удобном для чтения формате (`vkms parse`)
    - TXT, за основу была взята структура формата [hikiko4ern'а](https://github.com/hikiko4ern/vk_dump)
    - HTML, кастомная верстка, максимально приближенная к официальному приложению VK Android

<table>
    <tr align="center">
        <th>HTML</th>
        <th>TXT</th>
    </tr>
    <tr>
        <td width="50%"><img src="docs/html_saver_example.png" alt="Пример переписки в HTML формате"></td>
        <td width="50%"><img src="docs/txt_saver_example.png" alt="Пример переписки в TXT формате"></td>
    </tr>
</table>

- Загружать вложения, доступна многопоточная загрузка (`vkms atch`)
    - Фото
    - Документы
    - Стикеры
    - Подарки
    - Голосовые сообщения
    - Граффити

[Подробное описание](https://github.com/YariKartoshe4ka/vk-messages-saver/blob/master/docs/DOCS.md)

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "vkms",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "api,parser,vk,messages,saver",
    "author": "",
    "author_email": "Yaroslav Kikel <yaroslav.kikel.06@inbox.ru>",
    "download_url": "https://files.pythonhosted.org/packages/7d/b2/72561089b32e07708458e14b4b648429570aa4ec2ed19bdee5822492ad0b/vkms-1.0.2.tar.gz",
    "platform": null,
    "description": "# vk-messages-saver\n\n[![Maintanance](https://img.shields.io/maintenance/yes/2023?style=flat-square)](https://github.com/YariKartoshe4ka/vk-messages-saver/commits/master)\n[![Releases](https://img.shields.io/github/v/release/YariKartoshe4ka/vk-messages-saver?style=flat-square)](https://github.com/YariKartoshe4ka/vk-messages-saver/releases)\n[![VK API](https://img.shields.io/static/v1?label=API&message=5.131&color=a938e4&labelColor=000000&logo=vk&style=flat-square)](https://dev.vk.com/)\n[![PyPI](https://img.shields.io/pypi/pyversions/vkms?style=flat-square)](https://pypi.org/project/vkms/)\n[![Speed](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/YariKartoshe4ka/bf106ade592cbea6189b89f71c7545e9/raw/vkms-speed.json)](https://github.com/YariKartoshe4ka/vk-messages-saver/actions)\n\n\u0423\u0442\u0438\u043b\u0438\u0442\u0430 \u0434\u043b\u044f \u0441\u043e\u0445\u0440\u0430\u043d\u0435\u043d\u0438\u044f \u043f\u0435\u0440\u0435\u043f\u0438\u0441\u043e\u043a \u0412\u041a\u043e\u043d\u0442\u0430\u043a\u0442\u0435\n\n\n### \u0423\u0441\u0442\u0430\u043d\u043e\u0432\u043a\u0430\n\n\u0417\u0430\u0433\u0440\u0443\u0436\u0430\u0435\u043c \u0438 \u0443\u0441\u0442\u0430\u043d\u0430\u0432\u043b\u0438\u0432\u0430\u0435\u043c \u043f\u043e\u0441\u043b\u0435\u0434\u043d\u044e\u044e \u0432\u0435\u0440\u0441\u0438\u044e VKMS \u0438\u0437 [PyPI](https://pypi.org/project/vkms/)\n\n```bash\npip install vkms\n```\n\n\n### \u0418\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u043d\u0438\u0435\n\n1. \u041f\u043e\u043b\u0443\u0447\u0430\u0435\u043c \u0442\u043e\u043a\u0435\u043d \u0434\u043e\u0441\u0442\u0443\u043f\u0430 \u0441 \u043f\u0440\u0430\u0432\u0430\u043c\u0438 \u043d\u0430 \u0441\u043e\u043e\u0431\u0449\u0435\u043d\u0438\u044f \u043e\u0442 \u043e\u0444\u0438\u0446\u0438\u0430\u043b\u044c\u043d\u043e\u0433\u043e \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f. \u041c\u043e\u0436\u043d\u043e \u0432\u043e\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u044c\u0441\u044f [\u044d\u0442\u0438\u043c \u0441\u0430\u0439\u0442\u043e\u043c](https://vkhost.github.io/). \u041f\u043e\u0441\u043b\u0435 \u0430\u0432\u0442\u043e\u0440\u0438\u0437\u0430\u0446\u0438\u0438 \u043a\u043e\u043f\u0438\u0440\u0443\u0435\u043c \u0438\u0437 \u0430\u0434\u0440\u0435\u0441\u043d\u043e\u0439 \u0441\u0442\u0440\u043e\u043a\u0438 \u043f\u0430\u0440\u0430\u043c\u0435\u0442\u0440 *access_token* \u0438 \u0432\u0441\u0442\u0430\u0432\u043b\u044f\u0435\u043c \u0435\u0433\u043e \u0432 \u0442\u0435\u0440\u043c\u0438\u043d\u0430\u043b\n\n    ```bash\n    export ACCESS_TOKEN='...'\n    ```\n\n2. \u0417\u0430\u043f\u0443\u0441\u043a\u0430\u0435\u043c VKMS \u0438 \u0441\u043a\u0430\u0447\u0438\u0432\u0430\u0435\u043c \u043f\u043e\u043b\u043d\u0443\u044e \u0438\u043d\u0444\u043e\u0440\u043c\u0430\u0446\u0438\u044e \u043e \u043f\u0435\u0440\u0435\u043f\u0438\u0441\u043a\u0430\u0445\n\n    ```bash\n    vkms dump\n    ```\n\n    \u0422\u0435\u043f\u0435\u0440\u044c \u043c\u043e\u0436\u043d\u043e \u0441\u043f\u0430\u0440\u0441\u0438\u0442\u044c \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u043d\u044b\u0435 \u0434\u0430\u043d\u043d\u044b\u0435 \u0432 \u0443\u0434\u043e\u0431\u043d\u044b\u0439 \u0434\u043b\u044f \u0447\u0442\u0435\u043d\u0438\u044f \u0444\u043e\u0440\u043c\u0430\u0442\n\n    ```bash\n    vkms parse\n    ```\n\n\n### \u0424\u0443\u043d\u043a\u0446\u0438\u0438\n\n\u0412 \u0434\u0430\u043d\u043d\u044b\u0439 \u043c\u043e\u043c\u0435\u043d\u0442 VKMS \u043c\u043e\u0436\u0435\u0442:\n\n- \u0421\u043e\u0445\u0440\u0430\u043d\u044f\u0442\u044c \u043f\u0435\u0440\u0435\u043f\u0438\u0441\u043a\u0438 \u0432 \u043f\u0440\u043e\u0433\u0440\u0430\u043c\u043c\u043d\u043e\u043c \u0444\u043e\u0440\u043c\u0430\u0442\u0435 (JSON), \u0434\u043e\u0441\u0442\u0443\u043f\u043d\u0430 \u043c\u043d\u043e\u0433\u043e\u043f\u043e\u0442\u043e\u0447\u043d\u0430\u044f \u0437\u0430\u0433\u0440\u0443\u0437\u043a\u0430 (`vkms dump`)\n- \u0421\u043e\u0445\u0440\u0430\u043d\u044f\u0442\u044c \u043f\u0435\u0440\u0435\u043f\u0438\u0441\u043a\u0438 \u0432 \u0443\u0434\u043e\u0431\u043d\u043e\u043c \u0434\u043b\u044f \u0447\u0442\u0435\u043d\u0438\u044f \u0444\u043e\u0440\u043c\u0430\u0442\u0435 (`vkms parse`)\n    - TXT, \u0437\u0430 \u043e\u0441\u043d\u043e\u0432\u0443 \u0431\u044b\u043b\u0430 \u0432\u0437\u044f\u0442\u0430 \u0441\u0442\u0440\u0443\u043a\u0442\u0443\u0440\u0430 \u0444\u043e\u0440\u043c\u0430\u0442\u0430 [hikiko4ern'\u0430](https://github.com/hikiko4ern/vk_dump)\n    - HTML, \u043a\u0430\u0441\u0442\u043e\u043c\u043d\u0430\u044f \u0432\u0435\u0440\u0441\u0442\u043a\u0430, \u043c\u0430\u043a\u0441\u0438\u043c\u0430\u043b\u044c\u043d\u043e \u043f\u0440\u0438\u0431\u043b\u0438\u0436\u0435\u043d\u043d\u0430\u044f \u043a \u043e\u0444\u0438\u0446\u0438\u0430\u043b\u044c\u043d\u043e\u043c\u0443 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044e VK Android\n\n<table>\n    <tr align=\"center\">\n        <th>HTML</th>\n        <th>TXT</th>\n    </tr>\n    <tr>\n        <td width=\"50%\"><img src=\"docs/html_saver_example.png\" alt=\"\u041f\u0440\u0438\u043c\u0435\u0440 \u043f\u0435\u0440\u0435\u043f\u0438\u0441\u043a\u0438 \u0432 HTML \u0444\u043e\u0440\u043c\u0430\u0442\u0435\"></td>\n        <td width=\"50%\"><img src=\"docs/txt_saver_example.png\" alt=\"\u041f\u0440\u0438\u043c\u0435\u0440 \u043f\u0435\u0440\u0435\u043f\u0438\u0441\u043a\u0438 \u0432 TXT \u0444\u043e\u0440\u043c\u0430\u0442\u0435\"></td>\n    </tr>\n</table>\n\n- \u0417\u0430\u0433\u0440\u0443\u0436\u0430\u0442\u044c \u0432\u043b\u043e\u0436\u0435\u043d\u0438\u044f, \u0434\u043e\u0441\u0442\u0443\u043f\u043d\u0430 \u043c\u043d\u043e\u0433\u043e\u043f\u043e\u0442\u043e\u0447\u043d\u0430\u044f \u0437\u0430\u0433\u0440\u0443\u0437\u043a\u0430 (`vkms atch`)\n    - \u0424\u043e\u0442\u043e\n    - \u0414\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u044b\n    - \u0421\u0442\u0438\u043a\u0435\u0440\u044b\n    - \u041f\u043e\u0434\u0430\u0440\u043a\u0438\n    - \u0413\u043e\u043b\u043e\u0441\u043e\u0432\u044b\u0435 \u0441\u043e\u043e\u0431\u0449\u0435\u043d\u0438\u044f\n    - \u0413\u0440\u0430\u0444\u0444\u0438\u0442\u0438\n\n[\u041f\u043e\u0434\u0440\u043e\u0431\u043d\u043e\u0435 \u043e\u043f\u0438\u0441\u0430\u043d\u0438\u0435](https://github.com/YariKartoshe4ka/vk-messages-saver/blob/master/docs/DOCS.md)\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-only",
    "summary": "Utility for saving messages from the VK social network",
    "version": "1.0.2",
    "project_urls": {
        "Homepage": "https://github.com/YariKartoshe4ka/vk-messages-saver"
    },
    "split_keywords": [
        "api",
        "parser",
        "vk",
        "messages",
        "saver"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "af8bcfebd90943f44ec1c9d390fae206d2f98c2ba506bcca1b51d9776bcc40a6",
                "md5": "def71189eba2f8fdbbba3718b0a28926",
                "sha256": "0aac537cc8cae4f5cba24cdec6c9f49c319ba9ecf14ca8a4e950c8bc31c1ae29"
            },
            "downloads": -1,
            "filename": "vkms-1.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "def71189eba2f8fdbbba3718b0a28926",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 63934,
            "upload_time": "2023-05-31T08:51:12",
            "upload_time_iso_8601": "2023-05-31T08:51:12.013923Z",
            "url": "https://files.pythonhosted.org/packages/af/8b/cfebd90943f44ec1c9d390fae206d2f98c2ba506bcca1b51d9776bcc40a6/vkms-1.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7db272561089b32e07708458e14b4b648429570aa4ec2ed19bdee5822492ad0b",
                "md5": "d9465b0da342178f4274d09406ee9969",
                "sha256": "3a405f3dfe0cbff1fb403e2ffe5b5b3ccc93c07ae6efd5e668ccba5726716509"
            },
            "downloads": -1,
            "filename": "vkms-1.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "d9465b0da342178f4274d09406ee9969",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 151318,
            "upload_time": "2023-05-31T08:51:13",
            "upload_time_iso_8601": "2023-05-31T08:51:13.156549Z",
            "url": "https://files.pythonhosted.org/packages/7d/b2/72561089b32e07708458e14b4b648429570aa4ec2ed19bdee5822492ad0b/vkms-1.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-31 08:51:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "YariKartoshe4ka",
    "github_project": "vk-messages-saver",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "vkms"
}
Elapsed time: 0.72702s