Installation

Maigret can be installed using pip, Docker, or simply can be launched from the cloned repo. Also, it is available online via official Telegram bot, source code of a bot is available on GitHub.

Windows Standalone EXE-binaries

Standalone EXE-binaries for Windows are located in the Releases section of GitHub repository.

Currently, the new binary is created automatically after each commit to main and dev branches.

Video guide on how to run it: https://youtu.be/qIgwTZOmMmM.

Cloud Shells and Jupyter notebooks

In case you don’t want to install Maigret locally, you can use cloud shells and Jupyter notebooks. Press one of the buttons below and follow the instructions to launch it in your browser.

Open in Cloud Shell Run on Replit Open In Colab Open In Binder

Local installation from PyPi

Please note that the sites database in the PyPI package may be outdated. If you encounter frequent false positive results, we recommend installing the latest development version from GitHub instead.

Note

Python 3.10 or higher and pip is required, Python 3.11 is recommended.

# install from pypi
pip3 install maigret

# usage
maigret username

Development version (GitHub)

git clone https://github.com/soxoj/maigret && cd maigret
pip3 install .

# OR
pip3 install git+https://github.com/soxoj/maigret.git

# usage
maigret username

# OR use poetry in case you plan to develop Maigret
pip3 install poetry
poetry run maigret

Docker

# official image of the development version, updated from the github repo
docker pull soxoj/maigret

# usage
docker run -v /mydir:/app/reports soxoj/maigret:latest username --html

# manual build
docker build -t maigret .