mirror of
https://github.com/soxoj/maigret.git
synced 2026-05-06 22:19:01 +00:00
dr-BEat
130 lines
5.4 KiB
Markdown
130 lines
5.4 KiB
Markdown
# Maigret
|
|
|
|
<p align="center">
|
|
<p align="center">
|
|
<a href="https://pypi.org/project/maigret/">
|
|
<img alt="PyPI" src="https://img.shields.io/pypi/v/maigret?style=flat-square">
|
|
</a>
|
|
<a href="https://pypi.org/project/maigret/">
|
|
<img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dw/maigret?style=flat-square">
|
|
</a>
|
|
<a href="https://pypi.org/project/maigret/">
|
|
<img alt="Views" src="https://komarev.com/ghpvc/?username=maigret&color=brightgreen&label=views&style=flat-square">
|
|
</a>
|
|
</p>
|
|
<p align="center">
|
|
<img src="https://raw.githubusercontent.com/soxoj/maigret/main/static/maigret.png" height="200"/>
|
|
</p>
|
|
</p>
|
|
|
|
<i>The Commissioner Jules Maigret is a fictional French police detective, created by Georges Simenon. His investigation method is based on understanding the personality of different people and their interactions.</i>
|
|
|
|
## About
|
|
|
|
**Maigret** collect a dossier on a person **by username only**, checking for accounts on a huge number of sites and gathering all the available information from web pages. No API keys required. Maigret is an easy-to-use and powerful fork of [Sherlock](https://github.com/sherlock-project/sherlock).
|
|
|
|
Currently supported more than 2500 sites ([full list](https://github.com/soxoj/maigret/blob/main/sites.md)), search is launched against 500 popular sites in descending order of popularity by default. Also supported checking of Tor sites, I2P sites, and domains (via DNS resolving).
|
|
|
|
## Main features
|
|
|
|
* Profile pages parsing, [extraction](https://github.com/soxoj/socid_extractor) of personal info, links to other profiles, etc.
|
|
* Recursive search by new usernames and other ids found
|
|
* Search by tags (site categories, countries)
|
|
* Censorship and captcha detection
|
|
* Requests retries
|
|
|
|
See full description of Maigret features [in the documentation](https://maigret.readthedocs.io/en/latest/features.html).
|
|
|
|
## Installation
|
|
|
|
Maigret can be installed using pip, Docker, or simply can be launched from the cloned repo.
|
|
|
|
Standalone EXE-binaries for Windows are located in [Releases section](https://github.com/soxoj/maigret/releases) of GitHub repository.
|
|
|
|
Also you can run Maigret using cloud shells and Jupyter notebooks (see buttons below).
|
|
|
|
[](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/soxoj/maigret&tutorial=README.md)
|
|
<a href="https://repl.it/github/soxoj/maigret"><img src="https://user-images.githubusercontent.com/27065646/92304596-bf719b00-ef7f-11ea-987f-2c1f3c323088.png" alt="Run on Repl.it" height="50"></a>
|
|
|
|
<a href="https://colab.research.google.com/gist/soxoj/879b51bc3b2f8b695abb054090645000/maigret-collab.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab" height="45"></a>
|
|
<a href="https://mybinder.org/v2/gist/soxoj/9d65c2f4d3bec5dd25949197ea73cf3a/HEAD"><img src="https://mybinder.org/badge_logo.svg" alt="Open In Binder" height="45"></a>
|
|
|
|
### Package installing
|
|
|
|
**NOTE**: Python 3.7 or higher and pip is required, **Python 3.8 is recommended.**
|
|
|
|
```bash
|
|
# install from pypi
|
|
pip3 install maigret
|
|
|
|
# or clone and install manually
|
|
git clone https://github.com/soxoj/maigret && cd maigret
|
|
pip3 install .
|
|
|
|
# usage
|
|
maigret username
|
|
```
|
|
|
|
### Cloning a repository
|
|
|
|
```bash
|
|
git clone https://github.com/soxoj/maigret && cd maigret
|
|
pip3 install -r requirements.txt
|
|
|
|
# usage
|
|
./maigret.py username
|
|
```
|
|
|
|
### Docker
|
|
|
|
```bash
|
|
# official image
|
|
docker pull soxoj/maigret
|
|
|
|
# usage
|
|
docker run -it --rm soxoj/maigret:latest username
|
|
|
|
# manual build
|
|
docker build -t maigret .
|
|
```
|
|
|
|
## Usage examples
|
|
|
|
```bash
|
|
# make HTML and PDF reports
|
|
maigret user --html --pdf
|
|
|
|
# search on sites marked with tags photo & dating
|
|
maigret user --tags photo,dating
|
|
|
|
# search for three usernames on all available sites
|
|
maigret user1 user2 user3 -a
|
|
```
|
|
|
|
Use `maigret --help` to get full options description. Also options [are documented](https://maigret.readthedocs.io/en/latest/command-line-options.html).
|
|
|
|
## Contributing
|
|
|
|
Maigret has open-source code, so you may contribute your own sites by adding them to `data.json` file, or bring changes to it's code!
|
|
If you want to contribute, don't forget to activate statistics update hook, command for it would look like this: `git config --local core.hooksPath .githooks/`
|
|
You should make your git commits from your maigret git repo folder, or else the hook wouldn't find the statistics update script.
|
|
|
|
## Demo with page parsing and recursive username search
|
|
|
|
[PDF report](https://raw.githubusercontent.com/soxoj/maigret/main/static/report_alexaimephotographycars.pdf), [HTML report](https://htmlpreview.github.io/?https://raw.githubusercontent.com/soxoj/maigret/main/static/report_alexaimephotographycars.html)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[Full console output](https://raw.githubusercontent.com/soxoj/maigret/main/static/recursive_search.md)
|
|
|
|
## License
|
|
|
|
MIT © [Maigret](https://github.com/soxoj/maigret)<br/>
|
|
MIT © [Sherlock Project](https://github.com/sherlock-project/)<br/>
|
|
Original Creator of Sherlock Project - [Siddharth Dushantha](https://github.com/sdushantha)
|