diff --git a/README.md b/README.md index c299dd5..fd671d0 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,55 @@ # Maigret -![PyPI](https://img.shields.io/pypi/v/maigret?style=flat-square) -![PyPI - Downloads](https://img.shields.io/pypi/dw/maigret?style=flat-square) -[![Chat - Gitter](./static/chat_gitter.svg)](https://gitter.im/maigret-osint/community) -

- +

+ + PyPI + + + PyPI - Downloads + + + Chat - Gitter + + + Follow @sox0j + +

+

+ +

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. ## About -Purpose of Maigret - **collect a dossier on a person by username only**, checking for accounts on a huge number of sites. +**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. Maigret is an easy-to-use and power fork of [Sherlock](https://github.com/sherlock-project/sherlock). -This is a [sherlock](https://github.com/sherlock-project/) fork with cool features under heavy development. -*Don't forget to regularly update source code from repo*. - -Currently supported more than 2000 sites ([full list](./sites.md)), by default search is launched against 500 popular sites in descending order of popularity. +Currently supported more than 2000 sites ([full list](./sites.md)), search is launched against 500 popular sites in descending order of popularity by default. ## Main features -* Profile pages parsing, [extracting](https://github.com/soxoj/socid_extractor) personal info, links to other profiles, etc. -* Recursive search by new usernames found +* 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 -* Very few false positives -* Failed requests' restarts +* Requests retries + +See full description of Maigret features [in the Wiki](https://github.com/soxoj/maigret/wiki/Features). ## Installation -**NOTE**: Python 3.6 or higher and pip is required. +Maigret can be installed using pip, Docker, or simply can be launched from the cloned repo. +Also you can run Maigret using cloud shells (see buttons below). -**Python 3.8 is recommended.** +[![Open in Cloud Shell](https://user-images.githubusercontent.com/27065646/92304704-8d146d80-ef80-11ea-8c29-0deaabb1c702.png)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/soxoj/maigret&tutorial=README.md) [![Run on Repl.it](https://user-images.githubusercontent.com/27065646/92304596-bf719b00-ef7f-11ea-987f-2c1f3c323088.png)](https://repl.it/github/soxoj/maigret) +Open In Colab ### Package installing + +**NOTE**: Python 3.6 or higher and pip is required, **Python 3.8 is recommended.** + ```bash # install from pypi pip3 install maigret @@ -42,34 +57,36 @@ 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 -``` - -You can use a free virtual machine, the repo will be automatically cloned: - -[![Open in Cloud Shell](https://user-images.githubusercontent.com/27065646/92304704-8d146d80-ef80-11ea-8c29-0deaabb1c702.png)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/soxoj/maigret&tutorial=README.md) [![Run on Repl.it](https://user-images.githubusercontent.com/27065646/92304596-bf719b00-ef7f-11ea-987f-2c1f3c323088.png)](https://repl.it/github/soxoj/maigret) -Open In Colab - -```bash pip3 install -r requirements.txt + +# usage +./maigret.py username ``` -## Using examples +### Docker ```bash -# for a cloned repo -./maigret.py user +# official image +docker pull soxoj/maigret -# for a package -maigret user +# usage +docker run soxoj/maigret:latest username + +# manual build +docker build -t maigret . ``` -Features: +## Usage examples + ```bash # make HTML and PDF reports maigret user --html --pdf @@ -77,22 +94,12 @@ 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 - ``` -Run `maigret --help` to get arguments description. Also options are documented in [the Maigret Wiki](https://github.com/soxoj/maigret/wiki/Command-line-options). +Use `maigret --help` to get full options description. Also options are documented in [the Maigret Wiki](https://github.com/soxoj/maigret/wiki/Command-line-options). -With Docker: -``` -# manual build -docker build -t maigret . && docker run maigret user - -# official image -docker run soxoj/maigret:latest user -``` ## Demo with page parsing and recursive username search