Skip to main content

Minimal Python library for VK API (sync)

Project description

VKama

Минимальная Python библиотека для работы с VK API.

VKama — это лёгкий sync-клиент для основных методов VK API.
Подходит для:

  • ботов
  • парсеров
  • рассылок
  • автоматизации

Работает через обычный access token.


Установка

Скопируйте библиотеку в проект:

vkama/
 ├─ __init__.py
 └─ vkama.py

или импортируйте из репозитория.


Быстрый старт

from vkama import VK

TOKEN = "your_vk_token"

vk = VK(TOKEN)

user = vk.users_get(user_ids="1")

print(user)

Получение токена

Откройте ссылку:

https://oauth.vk.com/authorize?client_id=6287487&display=page&redirect_uri=https://oauth.vk.com/blank.html&scope=messages,groups,offline&response_type=token&v=5.199

После авторизации в адресной строке появится:

access_token=XXXXXXXX

Используйте этот токен в библиотеке.


Примеры

Получить пользователя

vk.users_get(user_ids="1")

Получить друзей

vk.friends_get(user_id=1)

Получить группы

vk.groups_get(user_id=1)

Получить участников группы

vk.groups_get_members("python")

Отправить сообщение

vk.messages_send(
    user_id=123456,
    message="Привет!"
)

Получить историю сообщений

vk.messages_get_history(user_id=123456)

Опубликовать пост

vk.wall_post(
    owner_id=1,
    message="Hello VK!"
)

Основные методы

VKama реализует базовые методы VK API:

Users

users.get
users.search

Friends

friends.get

Groups

groups.get
groups.getMembers

Messages

messages.send
messages.getHistory

Wall

wall.post
wall.get

Пример скрипта

Получение участников группы и отправка сообщения:

from vkama import VK

vk = VK("TOKEN")

members = vk.groups_get_members("python")

for user in members["items"]:
    vk.messages_send(
        user_id=user,
        message="Привет!"
    )

Обработка ошибок

Если VK API возвращает ошибку, библиотека выбрасывает исключение:

VK API Error {code}: {message}

Требования

Python 3.7+

Зависимости:

requests

Автор

Sargis Kazaryan

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vkama-0.1.0.tar.gz (2.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vkama-0.1.0-py3-none-any.whl (2.4 kB view details)

Uploaded Python 3

File details

Details for the file vkama-0.1.0.tar.gz.

File metadata

  • Download URL: vkama-0.1.0.tar.gz
  • Upload date:
  • Size: 2.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for vkama-0.1.0.tar.gz
Algorithm Hash digest
SHA256 76a7a0b4a3083f07e09162d82254c5b87a0570c377aa555bced06af71d592326
MD5 6fac79cf378c76a6e37f56707be92a15
BLAKE2b-256 70e8da687284895fc7e8827a1db6237962a6b1666e5b0f89b2626630a2e2b1bd

See more details on using hashes here.

File details

Details for the file vkama-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: vkama-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 2.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for vkama-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 16a3e03cd460ef00eeb844d10eabb2ad2951b18c3d26657d3f1ee1561248e990
MD5 56852401d84cd3ef75f09663bea030a3
BLAKE2b-256 969789ee0939c2347e8832afd0a6c13b4caea4f507da5a3661c9e3a58ef0a110

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page