nazurin
nazurin copied to clipboard
y-young
π Images collection done right. Telegram εΎηζΆθζΊε¨δΊΊ / A Telegram bot that helps you collect ACG illustrations.
Nazurin
English | δΈζ
ε°γγͺε°γγͺθ³’ε°, a Telegram bot which helps you collect ACG illustrations from various sites.
Architecture
Features
- View/Download artwork from various sites
- Add images to your collection via Telegram
- Store your collection in Telegram channels
- Store images on multiple types of storage
- Store image metadata in multiple types of database
Supported Sites
| Name | URL | Commands | Collection |
|---|---|---|---|
| Pixiv | https://www.pixiv.net/ | β | β |
| Danbooru | https://danbooru.donmai.us/ | β | β |
| Safebooru | https://safebooru.donmai.us/ | β | |
| yandere | https://yande.re/ | β | β |
| Konachan | https://konachan.com/ | β | β |
| Lolibooru | https://lolibooru.moe/ | β | |
| Zerochan | https://www.zerochan.net/ | β | β |
| Gelbooru | https://gelbooru.com/ | β | |
| https://twitter.com/ | β | ||
| ArtStation | https://www.artstation.com/ | β | |
| Wallhaven | https://wallhaven.cc/ | β | |
| Bilibili Dynamics | https://t.bilibili.com/ | β | |
| https://weibo.com/ | β | ||
| DeviantArt | https://www.deviantart.com/ | β | |
| Lofter | https://www.lofter.com/ | β |
Supported Databases
| Driver | URL | Usage | Note |
|---|---|---|---|
| TinyDB | https://tinydb.readthedocs.io/en/stable/index.html | Wiki | Default |
| Firestore | https://firebase.google.com/products/firestore | Wiki | |
| MongoDB | https://www.mongodb.com/ | Wiki | MongoDB Atlas supported |
| Cloudant | https://www.ibm.com/cloud/cloudant | Wiki |
You can also implement your own database driver by creating a file under database folder, and set this option to the name of driver class.
Supported Storage
| Name | URL | Usage | Note |
|---|---|---|---|
| Local | Set STORAGE = Local |
Default | |
| Telegram | https://telegram.org/ | Wiki | Added in v2 |
| MEGA | https://mega.nz/ | Wiki | |
| Google Drive | https://drive.google.com/ | Wiki | |
| OneDrive | https://onedrive.live.com/ | Wiki |
Configuration
For more information, see Wiki
Deploy
Deploy on Heroku
'Deploy to Heroku' Button
Tips: You can fork this repository, modify it to your needs, and use this button to deploy your own version.
Manual
Set all required environment variables on Heroku according to Configuration Guide, clone this repository and push to Heroku, everything should be working properly.
Deploy on your own server
Manual
Tips: You may comment out unused dependencies in
requirements.txtbefore installation.
- Install dependencies:
pip install -r requirements.txt - Set the required environment variables or place them in
.envfile, you may refer to.env.exampleas an example - Start the bot:
python -m nazurin
Docker
- Configure the options in
.env - Run
docker-compose up -d --build
Usage
Commands:
-
/ping- pong -
/pixiv <id>- view pixiv artwork -
/pixiv_download <id>- download pixiv artwork -
/danbooru <id>- view danbooru post -
/danbooru_download <id>- download danbooru post -
/yandere <id>- view yandere post -
/yandere_download <id>- download yandere post -
/konachan <id>- view konachan post -
/konachan_download <id>- download konachan post -
/zerochan <id>- view zerochan post -
/zerochan_download <id>- download zerochan post -
/bookmark <id>- bookmark pixiv artwork -
/clear_cache- clear download cache -
/help- get help text
How to update your collection
Send the bot a message with a link of supported sites, this message will be forwarded to GALLERY channel, the bot will then download the original images from the site, send the files to ALBUM channel, and finally store to your custom destinations.
Tips: On mobile you can use the share button in apps, as long as the final message contains a link.
y-young