Projects STRLCPY maigret Commits e70bdf37
🤬
  • ■ ■ ■ ■ ■ ■
    README.md
    1 1  # Maigret
    2 2   
    3  -![PyPI](https://img.shields.io/pypi/v/maigret?style=flat-square)
    4  -![PyPI - Downloads](https://img.shields.io/pypi/dw/maigret?style=flat-square)
    5  -[![Chat - Gitter](./static/chat_gitter.svg)](https://gitter.im/maigret-osint/community)
    6  - 
    7 3  <p align="center">
    8  - <img src="./static/maigret.png" />
     4 + <p align="center">
     5 + <a href="https://pypi.org/project/maigret/">
     6 + <img alt="PyPI" src="https://img.shields.io/pypi/v/maigret?style=flat-square">
     7 + </a>
     8 + <a href="https://pypi.org/project/maigret/">
     9 + <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dw/maigret?style=flat-square">
     10 + </a>
     11 + <a href="https://gitter.im/maigret-osint/community">
     12 + <img alt="Chat - Gitter" src="./static/chat_gitter.svg" />
     13 + </a>
     14 + <a href="https://twitter.com/intent/follow?screen_name=sox0j">
     15 + <img src="https://img.shields.io/twitter/follow/sox0j?label=Follow%20sox0j&style=social&color=blue" alt="Follow @sox0j" />
     16 + </a>
     17 + </p>
     18 + <p align="center">
     19 + <img src="./static/maigret.png" height="200"/>
     20 + </p>
    9 21  </p>
    10 22   
    11 23  <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>
    12 24   
    13 25  ## About
    14 26   
    15  -Purpose of Maigret - **collect a dossier on a person by username only**, checking for accounts on a huge number of sites.
     27 +**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).
    16 28   
    17  -This is a [sherlock](https://github.com/sherlock-project/) fork with cool features under heavy development.
    18  -*Don't forget to regularly update source code from repo*.
    19  - 
    20  -Currently supported more than 2000 sites ([full list](./sites.md)), by default search is launched against 500 popular sites in descending order of popularity.
     29 +Currently supported more than 2000 sites ([full list](./sites.md)), search is launched against 500 popular sites in descending order of popularity by default.
    21 30   
    22 31  ## Main features
    23 32   
    24  -* Profile pages parsing, [extracting](https://github.com/soxoj/socid_extractor) personal info, links to other profiles, etc.
    25  -* Recursive search by new usernames found
     33 +* Profile pages parsing, [extraction](https://github.com/soxoj/socid_extractor) of personal info, links to other profiles, etc.
     34 +* Recursive search by new usernames and other ids found
    26 35  * Search by tags (site categories, countries)
    27 36  * Censorship and captcha detection
    28  -* Very few false positives
    29  -* Failed requests' restarts
     37 +* Requests retries
     38 + 
     39 +See full description of Maigret features [in the Wiki](https://github.com/soxoj/maigret/wiki/Features).
    30 40   
    31 41  ## Installation
    32 42   
    33  -**NOTE**: Python 3.6 or higher and pip is required.
     43 +Maigret can be installed using pip, Docker, or simply can be launched from the cloned repo.
     44 +Also you can run Maigret using cloud shells (see buttons below).
    34 45   
    35  -**Python 3.8 is recommended.**
     46 +[![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)
     47 +<a href="https://colab.research.google.com/gist//soxoj/879b51bc3b2f8b695abb054090645000/maigret.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab" height="40"></a>
    36 48   
    37 49  ### Package installing
     50 + 
     51 +**NOTE**: Python 3.6 or higher and pip is required, **Python 3.8 is recommended.**
     52 + 
    38 53  ```bash
    39 54  # install from pypi
    40 55  pip3 install maigret
    skipped 1 lines
    42 57  # or clone and install manually
    43 58  git clone https://github.com/soxoj/maigret && cd maigret
    44 59  pip3 install .
     60 + 
     61 +# usage
     62 +maigret username
    45 63  ```
    46 64   
    47 65  ### Cloning a repository
    48 66   
    49 67  ```bash
    50 68  git clone https://github.com/soxoj/maigret && cd maigret
    51  -```
    52  - 
    53  -You can use a free virtual machine, the repo will be automatically cloned:
    54  - 
    55  -[![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)
    56  -<a href="https://colab.research.google.com/gist//soxoj/879b51bc3b2f8b695abb054090645000/maigret.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab" height="40"></a>
     69 +pip3 install -r requirements.txt
    57 70   
    58  -```bash
    59  -pip3 install -r requirements.txt
     71 +# usage
     72 +./maigret.py username
    60 73  ```
    61 74   
    62  -## Using examples
     75 +### Docker
    63 76   
    64 77  ```bash
    65  -# for a cloned repo
    66  -./maigret.py user
     78 +# official image
     79 +docker pull soxoj/maigret
    67 80   
    68  -# for a package
    69  -maigret user
     81 +# usage
     82 +docker run soxoj/maigret:latest username
     83 + 
     84 +# manual build
     85 +docker build -t maigret .
    70 86  ```
    71 87   
    72  -Features:
     88 +## Usage examples
     89 + 
    73 90  ```bash
    74 91  # make HTML and PDF reports
    75 92  maigret user --html --pdf
    76 93   
    77 94  # search on sites marked with tags photo & dating
    78 95  maigret user --tags photo,dating
    79  - 
    80 96   
    81 97  # search for three usernames on all available sites
    82 98  maigret user1 user2 user3 -a
    83  - 
    84 99  ```
    85 100   
    86  -Run `maigret --help` to get arguments description. Also options are documented in [the Maigret Wiki](https://github.com/soxoj/maigret/wiki/Command-line-options).
     101 +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).
    87 102   
    88  -With Docker:
    89  -```
    90  -# manual build
    91  -docker build -t maigret . && docker run maigret user
    92  - 
    93  -# official image
    94  -docker run soxoj/maigret:latest user
    95  -```
    96 103   
    97 104  ## Demo with page parsing and recursive username search
    98 105   
    skipped 17 lines
Please wait...
Page is in error, reload to recover