mirror of
https://github.com/soxoj/maigret.git
synced 2026-05-06 22:19:01 +00:00
Documentation update (#1931)
This commit is contained in:
@@ -45,13 +45,17 @@ See full description of Maigret features [in the documentation](https://maigret.
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
‼️ Maigret is available online via [official Telegram bot](https://t.me/osint_maigret_bot).
|
‼️ Maigret is available online via [official Telegram bot](https://t.me/osint_maigret_bot). Consider using it if you don't want to install anything.
|
||||||
|
|
||||||
Maigret can be installed using pip, Docker, or simply can be launched from the cloned repo.
|
### Windows
|
||||||
|
|
||||||
Standalone EXE-binaries for Windows are located in [Releases section](https://github.com/soxoj/maigret/releases) of GitHub repository.
|
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).
|
Video guide on how to run it: https://youtu.be/qIgwTZOmMmM.
|
||||||
|
|
||||||
|
### Installation in Cloud Shells
|
||||||
|
|
||||||
|
You can launch Maigret using cloud shells and Jupyter notebooks. Press one of the buttons below and follow the instructions to launch it in your browser.
|
||||||
|
|
||||||
[](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/soxoj/maigret&tutorial=README.md)
|
[](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://replit.com/badge/github/soxoj/maigret" alt="Run on Replit" height="50"></a>
|
<a href="https://repl.it/github/soxoj/maigret"><img src="https://replit.com/badge/github/soxoj/maigret" alt="Run on Replit" height="50"></a>
|
||||||
@@ -59,7 +63,9 @@ Also, you can run Maigret using cloud shells and Jupyter notebooks (see buttons
|
|||||||
<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://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>
|
<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
|
### Local installation
|
||||||
|
|
||||||
|
Maigret can be installed using pip, Docker, or simply can be launched from the cloned repo.
|
||||||
|
|
||||||
**NOTE**: Python 3.10 or higher and pip is required, **Python 3.11 is recommended.**
|
**NOTE**: Python 3.10 or higher and pip is required, **Python 3.11 is recommended.**
|
||||||
|
|
||||||
|
|||||||
@@ -7,8 +7,43 @@ Maigret can be installed using pip, Docker, or simply can be launched from the c
|
|||||||
Also, it is available online via `official Telegram bot <https://t.me/osint_maigret_bot>`_,
|
Also, it is available online via `official Telegram bot <https://t.me/osint_maigret_bot>`_,
|
||||||
source code of a bot is `available on GitHub <https://github.com/soxoj/maigret-tg-bot>`_.
|
source code of a bot is `available on GitHub <https://github.com/soxoj/maigret-tg-bot>`_.
|
||||||
|
|
||||||
Package installing
|
Windows Standalone EXE-binaries
|
||||||
------------------
|
-------------------------------
|
||||||
|
|
||||||
|
Standalone EXE-binaries for Windows are located in the `Releases section <https://github.com/soxoj/maigret/releases>`_ 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.
|
||||||
|
|
||||||
|
.. image:: https://user-images.githubusercontent.com/27065646/92304704-8d146d80-ef80-11ea-8c29-0deaabb1c702.png
|
||||||
|
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/soxoj/maigret&tutorial=README.md
|
||||||
|
:alt: Open in Cloud Shell
|
||||||
|
|
||||||
|
.. image:: https://replit.com/badge/github/soxoj/maigret
|
||||||
|
:target: https://repl.it/github/soxoj/maigret
|
||||||
|
:alt: Run on Replit
|
||||||
|
:height: 50
|
||||||
|
|
||||||
|
.. image:: https://colab.research.google.com/assets/colab-badge.svg
|
||||||
|
:target: https://colab.research.google.com/gist/soxoj/879b51bc3b2f8b695abb054090645000/maigret-collab.ipynb
|
||||||
|
:alt: Open In Colab
|
||||||
|
:height: 45
|
||||||
|
|
||||||
|
.. image:: https://mybinder.org/badge_logo.svg
|
||||||
|
:target: https://mybinder.org/v2/gist/soxoj/9d65c2f4d3bec5dd25949197ea73cf3a/HEAD
|
||||||
|
:alt: Open In Binder
|
||||||
|
:height: 45
|
||||||
|
|
||||||
|
Local installation from PyPi
|
||||||
|
----------------------------
|
||||||
|
|
||||||
Please note that the sites database in the PyPI package may be outdated.
|
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.
|
If you encounter frequent false positive results, we recommend installing the latest development version from GitHub instead.
|
||||||
@@ -42,37 +77,6 @@ Development version (GitHub)
|
|||||||
pip3 install poetry
|
pip3 install poetry
|
||||||
poetry run maigret
|
poetry run maigret
|
||||||
|
|
||||||
Cloud shells and Jupyter notebooks
|
|
||||||
----------------------------------
|
|
||||||
|
|
||||||
In case you don't want to install Maigret locally, you can use cloud shells and Jupyter notebooks.
|
|
||||||
|
|
||||||
.. image:: https://user-images.githubusercontent.com/27065646/92304704-8d146d80-ef80-11ea-8c29-0deaabb1c702.png
|
|
||||||
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/soxoj/maigret&tutorial=README.md
|
|
||||||
:alt: Open in Cloud Shell
|
|
||||||
|
|
||||||
.. image:: https://replit.com/badge/github/soxoj/maigret
|
|
||||||
:target: https://repl.it/github/soxoj/maigret
|
|
||||||
:alt: Run on Replit
|
|
||||||
:height: 50
|
|
||||||
|
|
||||||
.. image:: https://colab.research.google.com/assets/colab-badge.svg
|
|
||||||
:target: https://colab.research.google.com/gist/soxoj/879b51bc3b2f8b695abb054090645000/maigret-collab.ipynb
|
|
||||||
:alt: Open In Colab
|
|
||||||
:height: 45
|
|
||||||
|
|
||||||
.. image:: https://mybinder.org/badge_logo.svg
|
|
||||||
:target: https://mybinder.org/v2/gist/soxoj/9d65c2f4d3bec5dd25949197ea73cf3a/HEAD
|
|
||||||
:alt: Open In Binder
|
|
||||||
:height: 45
|
|
||||||
|
|
||||||
Windows standalone EXE-binaries
|
|
||||||
-------------------------------
|
|
||||||
|
|
||||||
Standalone EXE-binaries for Windows are located in the `Releases section <https://github.com/soxoj/maigret/releases>`_ of GitHub repository.
|
|
||||||
|
|
||||||
Currently, the new binary is created automatically after each commit to the main branch, but is not deployed to the Releases section automatically.
|
|
||||||
|
|
||||||
Docker
|
Docker
|
||||||
------
|
------
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user