Skip to content

Commit 6dce373

Browse files
conqueror62821conqueror62821
committed
Update project information and remove obsolete code
1 parent a3cbaa9 commit 6dce373

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+255
-2977
lines changed

‎.github/workflows/codeql-analysis.yml

-72
This file was deleted.

‎.prettierrc

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
printWidth: 120
2+
proseWrap: always
3+
overrides:
4+
- files: "*.md"
5+
options:
6+
printWidth: 80

‎LICENSE

+165
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

‎README.md

+57-79
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,57 @@
1-
# Reverse Image Search Bot
2-
3-
## How to use me
4-
5-
Send me an image, sticker, video/gif or url and I will send you direct reverse
6-
image search links for SauceNao, Google, Yandex and the like. For anime images
7-
I recommend SauceNao, for other images I recommend to use Google, Yandex.
8-
9-
Supported engines:
10-
11-
- All-in-one: Google, Yandex, Baidu, Shutterstock, Bing, TinEye, Sogou
12-
- Artworks & Anime: SauceNAO, IQDB, Trace, ascii2d
13-
14-
Inline results support:
15-
16-
SauceNAO, IQDB, Trace
17-
18-
## Commands
19-
20-
- `/help`, `/start`: Show this help message
21-
- `/credits`: Show all available engines (and what they are best for), data
22-
providers and other credits.
23-
- `/tips`: Various tips and tricks for better search results
24-
- `/search`: Reply to a message with an image or video to start a search
25-
- `/auto_search`: Toggle auto search on and off
26-
27-
![example](https://raw.githubusercontent.com/Nachtalb/reverse_image_search_bot/master/reverse_image_search_bot/images/help.jpg)
28-
29-
## Author
30-
31-
- [Nachtalb on Github](https://github.com/Nachtalb)
32-
- [@Nachtalb on Telegram](https://t.me/Nachtalb)
33-
34-
## Donations
35-
36-
- [PayPal](https://paypal.me/Espig)
37-
- BTC: `3E6Pw8gwLJSyfumpjuJ6CWNKjZJLCmXZ2G`
38-
- BTC/BSC: `0x3c5211340Db470A31F1a37E343E326db69FF2F5C`
39-
- ETH: `0x3c5211340Db470A31F1a37E343E326db69FF2F5C`
40-
- USDC: `0x3c5211340Db470A31F1a37E343E326db69FF2F5C`
41-
- PayString: `nachtalb$paystring.crypto.com`
42-
43-
## Other Bots
44-
45-
- [@XenianBot](https://t.me/XenianBot) All general purpose but with tons of functionality
46-
47-
## Issues / Contributions
48-
49-
- [Code repository](https://github.com/Nachtalb/reverse_image_search_bot)
50-
- [@Nachtalb](https://t.me/Nachtalb)
51-
- via /support at [@XenianBot](https://t.me/Nachtalb)
52-
53-
Thank you for using [@reverse_image_search_bot](https://t.me/reverse_image_search_bot).
54-
55-
### Installation
56-
57-
Requires at least **Python 3.10**.
58-
59-
Best if you create a python virtualenv.
60-
61-
Install all dependencies with:
62-
63-
```bash
64-
pip install -r requirements.txt
65-
```
66-
67-
After this is complete, you have to get an API Token from Telegram. You can
68-
easily get one via [@BotFather](https://t.me/BotFather).
69-
70-
Now that you have your API Token copy the `settings.example.py` to `settings.py`
71-
and paste in your API Token and so on.
72-
73-
Finally you can use this to start your bot.
74-
75-
```bash
76-
python run_bot.py
77-
```
78-
79-
Thank you for using [@reverse_image_search_bot](https://t.me/reverse_image_search_bot).
1+
<!-- markdownlint-disable MD033 -->
2+
<!-- markdownlint-disable MD013 -->
3+
<h1 align="center">Image Reverse Search Bot 🕵️‍♂️🔍</h1>
4+
<p align="center">
5+
<img src="https://img.shields.io/badge/License-LGPLv3-blue.svg" alt="License: LGPL-3.0">
6+
<img src="https://img.shields.io/github/stars/Nachtalb/reverse_image_search_bot?style=social" alt="GitHub Stars">
7+
<img src="https://img.shields.io/github/forks/Nachtalb/reverse_image_search_bot?style=social" alt="GitHub Forks">
8+
<img src="https://img.shields.io/github/issues/Nachtalb/reverse_image_search_bot" alt="GitHub Issues">
9+
<img src="https://img.shields.io/github/issues-pr/Nachtalb/reverse_image_search_bot" alt="GitHub Pull Requests">
10+
<br>
11+
<a href="https://github.com/Nachtalb"><img src="https://img.shields.io/badge/Author-Nachtalb-1f425f.svg" alt="Author: Nachtalb"></a>
12+
<a href="https://t.me/Nachtalb"><img src="https://img.shields.io/badge/Telegram-Nachtalb-blue" alt="Telegram: Nachtalb"></a>
13+
<a href="https://t.me/reverse_image_search_bot"><img src="https://img.shields.io/badge/Bot-Image%20Reverse%20Search-4250b6" alt="Bot: Image Reverse Search"></a>
14+
</p>
15+
<!-- markdownlint-enable MD013-->
16+
17+
> :warning: **Heads up, folks!**: Our trusty bot is currently undergoing a
18+
> complete makeover! I'm actively developing on the
19+
> [`na/v2`](https://github.com/Nachtalb/reverse_image_search_bot/pull/22)
20+
> branch, so make sure to keep an eye on that one instead of `master`.
21+
22+
## About 🌟
23+
24+
Introducing Image Reverse Search, your friendly Telegram bot that helps you
25+
perform reverse image searches for images, videos, and GIFs! 📷🎞️🎉 With support
26+
for a wide range of search engines, you'll get results directly within Telegram
27+
for some, while others will provide an inline button leading you to the engine's
28+
reverse search website. It's like having your personal detective right in your
29+
pocket! 🕵️‍♂️
30+
31+
## Installation 🛠️
32+
33+
1. Clone the repository like a pro!
34+
2. Copy `config.example.json` to `config.json` and fill in the top-secret
35+
information.
36+
3. Make sure the treasure trove of the `downloads` folder is accessible via the
37+
`file_url` provided.
38+
4. Install the bot using the magical command `poetry install`.
39+
5. Finally, unleash the bot with `poetry run start-bots`!
40+
41+
## Parity with Old Version 🕰️
42+
43+
Our dear bot is missing a few tricks from its older self. Here's what's not yet
44+
implemented:
45+
46+
- Inline results for Pixiv 🖼️
47+
- Generic SauceNAO results 🌐
48+
- MangaDex 📚
49+
- Anilist 📝
50+
- Trace.moe 🎥
51+
- Generic IQDB results 🌐
52+
- Baidu search link 🇨🇳
53+
54+
## License 📄
55+
56+
This project is proudly licensed under the
57+
[LGPL-3.0 License](https://licenses.nachtalb.io/#lgpl-3.0). 😎

0 commit comments

Comments
 (0)