https://github.com/rulen111/vkcc-auto
Tiny flask application for automated link shortening via vk.cc service.
https://github.com/rulen111/vkcc-auto
flask vk-api
Last synced: 5 months ago
JSON representation
Tiny flask application for automated link shortening via vk.cc service.
- Host: GitHub
- URL: https://github.com/rulen111/vkcc-auto
- Owner: rulen111
- License: mit
- Created: 2024-09-06T14:42:28.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-02T14:56:55.000Z (almost 2 years ago)
- Last Synced: 2025-07-26T22:18:29.531Z (11 months ago)
- Topics: flask, vk-api
- Language: Python
- Homepage:
- Size: 1.11 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VKcc Auto
Tiny flask application for automated link shortening via [vk.cc](https://vk.com/cc) service.
Takes a `.xlsx` file with links and returns the same file but with shortened links alongside the old ones.
## Run with docker-compose
1. **Clone this repository:**
`git clone https://github.com/rulen111/vkcc-auto.git`
2. **Configure environment `./.env`**
3. **Run everything:**
`docker-compose up --build`
___
## Installation
1. **Clone this repository:**
```git clone https://github.com/rulen111/vkcc-auto.git```
2. **Create virtual environment and install requirements:**
```pip install -r requirements.txt```
3. **Configure the application:**
Application's default settings can be found in `./vkcc_auto/config` module. Since this application sends request to VK API, along with flask app's `SECRET_KEY` user must provide a valid [VK API access token](https://dev.vk.com/ru/api/access-token/getting-started) of any type.
One way to do that is to create a separate config file with app's secret key and an access token (i.e. `my_config.cfg`) and set an environment variable `VKCCAUTO_SETTINGS` pointing to that file.
**Config file:**
```
SECRET_KEY = ""
TOKEN = ""
```
**Setting env variable:**
```
export VKCCAUTO_SETTINGS=/path/to/my_config.cfg
```
4. **Configure celery:**
This application uses [Redis](https://docs.celeryq.dev/en/stable/getting-started/backends-and-brokers/redis.html#broker-redis) by default. Therefore, you need to have redis backend installed on your system in order to run this application. The easiest way is to use docker:
```
docker run -d -p 6379:6379 redis
```
You can use any compatible message broker, but make sure to change the celery configuration in `./vkcc_auto/config`:
```
CELERY = dict(
broker_url="",
result_backend="",
)
```
## How to use
1. **Make sure your app is configured**
2. **Run celery backend:**
Startup your message broker (redis by default) and run the Celery worker server using `./make_celery.py`:
```
celery -A make_celery worker -l info -P solo
```
3. **Deploy application:**
Using `flask` built-in development server:
```
flask --app vkcc_auto run
```
Or using `gunicorn`:
```
gunicorn -b 0.0.0.0:8000 -w 4 'vkcc_auto:create_app()'
```
4. The application has only one page and it's pretty straightforward. Choose a `.xlsx` file with links, press SUBMIT button and wait for an output file download. Main page also provides a dynamic progress bar for tracking task progress.
---
