Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/isfilimonov/vk-data-extractor
✌🏼Vextractor is a quick and handy extractor of user data from VKontakte (vk.com).
https://github.com/isfilimonov/vk-data-extractor
python vk vkontakte
Last synced: about 1 month ago
JSON representation
✌🏼Vextractor is a quick and handy extractor of user data from VKontakte (vk.com).
- Host: GitHub
- URL: https://github.com/isfilimonov/vk-data-extractor
- Owner: IsFilimonov
- License: mit
- Created: 2022-12-31T11:08:17.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-26T20:31:19.000Z (3 months ago)
- Last Synced: 2024-09-26T05:02:00.853Z (about 2 months ago)
- Topics: python, vk, vkontakte
- Language: Python
- Homepage:
- Size: 289 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Vextractor
> 🐈⬛ Cat says meow!\
> 🐕 Dog says woof!\
> 🤖 Vextractor says vextract! vextract! vextract!
**Vextractor** is a quick and handy extractor of user data from [VKontakte](vk.com) from CLI.
The idea for this project arose from another project's needs. It is always more convenient to analyze data in tabular form. Not everyone can work directly with the vk API, just type a few commands into the console and get the result.
---
---
## Acknowledgements
- [Pallets Projects](https://palletsprojects.com/) for the [Click](https://github.com/pallets/click) CLI toolkit;
- Kirill aka [@python273](https://github.com/python273) and [contributors](https://github.com/python273/vk_api/graphs/contributors) for the [vk_api](https://github.com/python273/vk_api).
## Secrets
Fill `.env.example` and then rename it to `.env`.
Also you can use options `--login` and `--password`, but it's not as convenient.
## Installing
Install and update using [poetry](https://python-poetry.org/docs/cli/#install):
```bash
poetry install --only main
```
### Groups
Poetry [provides](https://python-poetry.org/docs/master/managing-dependencies/) a way to organize dependencies by groups. The Vextractor consists of:
- Main group;
- Dev dependencies;
- Typing dependencies;
- Docs dependencies;
- Tests dependencies.
## Usage
Vextractor uses the short cry `vextract` for convenience.
There are several ways to call Vextractor:
- Without activating virtual environment:
```bash
poetry run vextract
```
- With activating virtual environment:
```bash
poetry shell
vextract
```
### Help
**Note**: use one of the options: `-h` or `--help`, not both.
Available commands: `vextract` or `vextract -h/--help`.
Detail information for commands: `vextract birthdays -h/--help`
### Commands
- `vextract birthdays` -- Extract friends birthdays.
- `vextract album https://vk.com/album-1234567890_987654321` --- Download all images from album.
## LICENSE
Vextractor is licensed under the MIT/Expat license, see the [LICENSE](https://github.com/IsFilimonov/vk-data-extractor/blob/main/LICENSE) file for details.