diff --git a/README.md b/README.md index 65b811c..f34a67f 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,7 @@ You can launch Maigret using cloud shells and Jupyter notebooks. Press one of th 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.** ```bash @@ -131,6 +132,30 @@ 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). +### Web interface + +You can run Maigret with a web interface, where you can view the graph with results and download reports of all formats on a single page. + +
+Web Interface Screenshots + +![Web interface: how to start](https://raw.githubusercontent.com/soxoj/maigret/main/static/web_interface_screenshot_start.png) + +![Web interface: results](https://raw.githubusercontent.com/soxoj/maigret/main/static/web_interface_screenshot.png) + +
+ +Instructions: + +1. Run Maigret with the ``--web`` flag and specify the port number. + +```console +maigret --web 5000 +``` +2. Open http://127.0.0.1:5000 in your browser and enter one or more usernames to make a search. + +3. Wait a bit for the search to complete and view the graph with results, the table with all accounts found, and download reports of all formats. + ## 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! diff --git a/docs/source/features.rst b/docs/source/features.rst index 28dc1cf..f06f86e 100644 --- a/docs/source/features.rst +++ b/docs/source/features.rst @@ -5,6 +5,34 @@ Features This is the list of Maigret features. +.. _web-interface: + +Web Interface +------------- + +You can run Maigret with a web interface, where you can view the graph with results and download reports of all formats on a single page. + + +.. image:: https://raw.githubusercontent.com/soxoj/maigret/main/static/web_interface_screenshot_start.png + :alt: Web interface: how to start + + +.. image:: https://raw.githubusercontent.com/soxoj/maigret/main/static/web_interface_screenshot.png + :alt: Web interface: results + + +Instructions: + +1. Run Maigret with the ``--web`` flag and specify the port number. + +.. code-block:: console + + maigret --web 5000 + +2. Open http://127.0.0.1:5000 in your browser and enter one or more usernames to make a search. + +3. Wait a bit for the search to complete and view the graph with results, the table with all accounts found, and download reports of all formats. + Personal info gathering ----------------------- diff --git a/docs/source/usage-examples.rst b/docs/source/usage-examples.rst index 8730440..e294c6c 100644 --- a/docs/source/usage-examples.rst +++ b/docs/source/usage-examples.rst @@ -3,6 +3,15 @@ Usage examples ============== +You can use Maigret as: +- a command line tool: inital and a default mode +- a `web interface <#web-interface>`_: view the graph with results and download all report formats on a single page +- a library: integrate Maigret into your own project + +Use Cases +--------- + + 1. Search for accounts with username ``machine42`` on top 500 sites (by default, according to Alexa rank) from the Maigret DB. .. code-block:: console diff --git a/static/web_interface_screenshot.png b/static/web_interface_screenshot.png new file mode 100644 index 0000000..e19a4f5 Binary files /dev/null and b/static/web_interface_screenshot.png differ diff --git a/static/web_interface_screenshot_start.png b/static/web_interface_screenshot_start.png new file mode 100644 index 0000000..44067fa Binary files /dev/null and b/static/web_interface_screenshot_start.png differ