From 4894a267d75ea8353edaa46120a493ab12981c31 Mon Sep 17 00:00:00 2001
From: Soxoj <31013580+soxoj@users.noreply.github.com>
Date: Mon, 16 Dec 2024 17:06:06 +0100
Subject: [PATCH] Added web interface docs (#1972)
---
README.md | 25 +++++++++++++++++++
docs/source/features.rst | 28 ++++++++++++++++++++++
docs/source/usage-examples.rst | 9 +++++++
static/web_interface_screenshot.png | Bin 0 -> 630425 bytes
static/web_interface_screenshot_start.png | Bin 0 -> 108784 bytes
5 files changed, 62 insertions(+)
create mode 100644 static/web_interface_screenshot.png
create mode 100644 static/web_interface_screenshot_start.png
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
+
+
+
+
+
+
+
+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 0000000000000000000000000000000000000000..e19a4f57ac46a9dc76ec4f68acf692f10c0ad06c
GIT binary patch
literal 630425
zcmeFZby!sG`Zf$wQVJ>{jf6-yNQ1Pbbayzw(4B$`qDXft(nxnpHwZ%y-8Br|@veDd
z|Mu~|$NN3(f4)DyZ*v?ovsk^Z`@ZTtuWN;qo&N~$6uVP+#CVKCoE
z2iCliYimV9!Vw2aNT|q3NKmOb*;|5aEs&68Lt?cswAFeD)AXVu#9m=irT$K)qNaNn
zgQttMDOG|Wh4j7s>3v2w^EWM(-%OE7>lia8kxOaZ2s`G8)Stw-mKtl#WxgxA>^)t(
zTpRSipLcv_vokit{{Gt
zIy}L{+JHqoQgJfo-jGn01JGux@q>1UkKZ64&Qm--9a9;;=*Ir6Hf>mwXvNna9kQOt!#mL($1)E}xGm~gMuB7mLakts>LlIN7;;_Kw$kBK|o
z;-n$mnuN`C?WOnL$i90;$s`+(+QkTycRoa4{{rrP;zS+m;qPbZlS?hCjUCPuPC1BH
zPmNdl2;CLc(~Jgvy_EgCUyJ%WHutc*OP(N^K0q
zQ=FL75*`v|zM@nnT9@f!T588GuQ3_^?6GG-b+1I6${2~^C&-wy`(A6+T#%th&ITsB
zJ{2;t7!p}*|H3C)&+z+(%VN*Y9#bQCladfo!3o~o>-Hx%CD4+IV1=_pgmkN1wU`+58v;&2cae2r=uZ1>QUuZ?8_|aX&u8l2NNBsKH
z>~MKz_mE~V@+BbDb@MUckBs&0~Z@ca*EH
zJ!uEh)_60i`;NoU-?S(3#@L^z3=Q2(iJGTBgzlxYlzyB<-XU|ts((k`L4t%L7{Fs%
zILSdwp=+SLQeg92@260jZ7$7KaB~YiQ=fU7bD?wiA(50(lX21xIqqb12ZXLQwBH9E
z+YcWVC+yQYcgo_@&JxzUoy!al-^P$ge?Gj~arn%YDAFE32RpmNiXf5Oy?4G84wsZS
zgHxP~IT8f#4ud^a$0kRK
z4yp3L)Y%{RqtJcBVMZzVB~XHIi!Audu7r~N-H(MQFR@tzm=@4$Ftn73JdiJb3GNY#
z<2`yMwed;B^t1M}2cNK8C4C~PXzztcMMbL9qToMMHGj@Y$so}i>Dq0Xi9QufCav_0
zD8g;!!AQsvRdJ;9i=h1P)43ehU&F)_Utr_PEDvM8MHfJ0k^C}Dw?R@tGW&7-N6v5g
z4crP8-+&V{B()9~4z7NDGgDh;EcuoZ4oqHBrVhpu>z@y70*B5?#siK`DIKYmx`=CN
z^jp4r+#77mSt#G{I1})}FbuC=nAlTlcz7%Q?NR9c2dHfKg4yFD#1me>c&3h5h5rD5
z@K@ugl!pxMBi9gK$%i#W(IGnR#O)pJ$L+%H(d}+aW~QPck|Xr|5k9hSXjvK3)nDn#
zPfH1i*S+4N_EmYK!J*;!22)e+4SwE}JoVfib^anJjn%|nt1|Sd&pT3K)Q3Hg9{C=<
z9>tZu71jf*&(Ax8mLx)Q%-^iN8CThQVfEsa!CqZMV?aY#!%Y2SzO%+e?yiP#@pRtB
z8%6m6!>@(BhKl)BlHmGjxk^E6`&{*Wp0V_#R|7e$-^W#y)hJa(e{XQplLU9>41CuZ
z*#c>S*v5LcG`E;>HF4s{B)I|JHa@&R#P5wBs
zJ4rl=J&7k*!End;-sTm2viM;!txc+}Ab8$M-PxR<@a4FGo4}@k)Jp<>o|lbeCj8VE
z?Fabl(mu{^&V!C~TR!%gU*`i?!-?`jk@S1VYw>xt(u{^~v?oib(bC
z>xXAMYgim?+%C6v7g-&Po#Fc>N3zGc2Q?j|meO2ATtnWEgiwUmJt&T^Hdc3I;g$2-
zZ1ys6TX^c+><_RswzNI@^<>vf@OJrBPFwt9@>YFMb=y#X__h}8w0pia9o{@}OWYS0
z+cDkYMZ7>ph57QyUK*?;twV(P6Iu{z9C{TR2#pT45ZmjiEkz2xKIsh65+NteiusFY
z+(Is%8!TZQ!CiTaM;|>u3}D${YGH?C8xh^SXcc+&XqX$F{4uX(N5W;KW@JWp&~
zc5%`}35bOg{SpZh8(&p9r0!{Gz8&xUc{=rG3R;fg6yr`Cuiek4-|3r}JL7}SNCfms1z4^f2z=vv&b0`wB`4zbf
zUF)uoq#)@8=tMWXDCsT9!$J_-wT8sha_w^7A!*B;0lPFajvNoAiJ6F6!L>JQ7DJbf
z-L<(58?dX)bH$F%4(BhFw~r3w!I*`Ts!lcmr-5Iw_dm9N1b>lc(XHRmV`x4yO?1|g
znu_me=pgbZKi^I=!idXc1LX*4R>8L2hEKxCO9geUg{-aJNMQQ9
zU&deCc)NX_ceQX|*zFYPsvGcjIgNp#d1ra2!{uk)o&C>l)=>IUTrmnCXp(18G8W2g
z}Y8voh32G?P_YFJZGqMF!d$e`DO#H7(1AalZ{v3sabt~YuszYy?Xv(
zWo`AC(MipWN5|o7wabl@Wv%O?v^qi$*pBPqu{oFt7rVoaT@77qX)D6#BN|sR7Zpp1
zo8?J%@w-2STZFaJ!oBB?UtKLZ+xMg=`D->-_sWejFu8@(=(P!4@tiR32bkJ7)n8Vd_8j5CE1DtJ$cj{@BIEMwnV#QH4sv-pPWBmzABB
zomvEoii%3e$=p&vRZ{w|!-4;Vso%P|I0&$@xx2fwx^uDGJ6W-D@bmMtv2(I
zusD0#xtMsc*g4bud6K`+BWdAm<^*zZ0omJ8APUjXfXskvh;Y2*;uZSifd6CD|6KCl
z4%PmjLpizm*#G^|f7|rGAFAPO;Ur-X1}^F%@;?Li*TMh3@vj4g*bvYDZ?gDP(0{B2
zBrSp^#P+XI6T#BmGd=J(
zfxI(|*?@a|+qJKJl4^?&&QM=rdo%s`^@%S_856Yfi+V4ig;5zB{&!oc?@!*0Gs}JW
z5OX|jm$f3A4zUlbT~A5mUr+NcUiKJR-rw#&_iH{(g$r4&&CD+^UZ43D*B7cR%C`m~
z-Mdfq?yg^A)R_7*>@1PAo9M`>cw$I*{Q5;B#{Lxp`Hp-4aaO7~X!o<}80k}=-TCH#
zhrm-<29mq~;5xGE$bq1cUOB7(KnO_pP$3@ZcYk`|ejaJOGuF*;8X^8qgpJg~o%SC*
ziWpLWBmq@ITyBcXe>AAT&{+K^A`|<6b7%+$Go(JtrZw=r4%?Zcv#GM}TtAMYv*E3E
z*^FvW6QIj6RqpAD?#wA|_P_O;s(rwhOvYjFuDdm=?`hG85^rnW}X1xDo&p`Bw>KX&5q_CNUu``UA
ziI~emq2l|^CA`^5;G`nurDyB?xX#|5$6dmUBbD3ZbkqDBF9cA5b1{TJ^(We?Lc=EP
z4W=BdF32Xk(;(l_I}D&hbSte{Gz!!sT{cIa_qI8-Cdh%OM;Xdimct)si3*7SQd&4)
zPm6x8m^7);H(m&(%~lHq`(|pHcSnfFF&m~Zw+VTlr2I6f*VO!}&ydUuR)}+Uis~kO
zD&+Agrlz!2ktm67;_a@ZY!N0#%
zXRch+MO{^Glm$R?l!;Pxf^h@d34setX2f6Cd+cZUu)7y2B(N_!J@cN3L29Y6*>ZC(
zy@Phky>J*nh0OU~k~7@+cSJ>uG;fDIrtkfEI)7UH4K;urxY>^ZL@VD#uaBZ#LPH{J
zYHFy$zv)!mr`2RH^g1R{Z8*D~DkBr}h(O9Ld_ZuAD-KgRD565pah|?-7{ll(wL6he
zx@e7vn7tvF7P=PPo+*BYH6y{K#*{qd;Gy_AJlMSFjZ6*>IMdH
z=iOz(FIW?Ox-izwNl;SFQ|*X=tLe{BI$iXG`2BZNGGE8O=Cl~3o+`84-w7U>%94-I
zR9hb`bKM?SdGLefUKL>RY(bA2O;1wzIsLBAB;oN7XtV&6wlYU5eFtOX;EE~f%Fg0m
zG;=WL%@z0{8aBD#h?s>E
z0g!x%?R0~bW|8({Zvu6PYZRB2Qtf^xDV*Tix^ItjDyYOIzytj^UE
zKm84>7&}X^J$rocKRdSw+k0=w6}IOJ>xHf>u2rqG4{ok6S7-Mhn_pkp4^U4G;Sh7m
z{*eBfsX34&jy7-Td#s_;X!+HqnOp3a;ydG{?h=zW^WmiqJ9Xr3O8*@W&~RDS%-av6
zfm2m>v(GtFO#?x%lV9LbB@m+VMath{v_9Pr$i>Y@6V%hK`TjUn7&a#2OY3{#62|8;
z-{d>eAcftfB{@-+%rVbDs~m7DWl$e`(pJhNnD#xF$8%0W1O@ZWUae|1{w8g-@{kU>=q8&=~7OK5pcB@
ztoqI=0L&AqF5eZ#J6x-%0r9ARsUC>Q=Rp1EXubxdN@Vo2?NnLMmFFRum144pS&%}i
z0MBR+%L|odJ2FEauU0|r%7u@%D{X+8Y*YT25zgfuB
zK1Rs%K(;7_f2H*!_QB=wkAqA5=AOuTzxcM`2R*}PG7_7-J5_)Qj;n{)$~dibKbtDE
zh~1g6ipL@5>Q48+VxU(}jZu@P+8fPNE4%D6aQgjpK6a8@^34BMOW&^Xm~e{PDp)l8vyIhn-_)M3CDVDI
z>_qWEkE2*@2#4r8(nM(JmB~&U%7a5sU7;ti@A_LBQ@kXBpz0Z?FEgH2CJ4(gblvag
z%PSWvP?;j^tf|zI#<{!c-z>A;biS6~AcI5l&u(sE3-8mk@$}U>W$&>xd#@d|blDp;
z|Gm+`HLzC?aOf6&apl5pQ)OA4o(JYouWBq@(Xl)Onci3?dScE@cbnb3+tmeeow60P
zL_T{v71-kuSqVIguTzO(ljGwSGjQ
zxESjAa?nZYYq33EIClX!b=k^%4O+z{?m159_3C;5cywHn1S11c9x;sqOGVG@S7ecVPjGo}w%}_+*DaiWPiy`g*=xteI<^Bb6i2G@y#o9UiwkTaT7s#sYEpJ_m{F
zRQS$E;?EQ~b#(f+96!$BddynqWV6ip!FSw$Rym}5;s~8nL@}-=31Fy)wfCs0*1NIP
zZ+&8%_$5B;bsU-{ColK;3Bx1qs+t~;HJh1Ru7g!;zG`h5xBc8J
zPK(|R@6V|Iw{6ANP1RksY
zCNk#Mx9C^O{+F
zbgQ7*i+M;XqJN}=<@TlB{WNy2QMh~!%^TMac5}W?nRwWO!3i3nt{W&qK=-0jWv`y1f{;WYRi0=@eQ_uh~yY)@wusORp5dZr?ax&|ej
zz^3W+7M?FqkzomTxJ12Q_9gK~&@q>ApZT%8#RpmDXcf2GICc!#c=jra%=k
z3I-Zaa;hFXc(pe+ElWCe&}y6?4KfpV%5`~v{cx|i`E`M2p}rL(79f+Qc1H%aY=xI?
z`+~f+t&D*75GuSaF!>=Zj&?}BKMRB8gbVGTE&H8vb6{sHr7}XS`W<$njFV`>t4CN8
zvYXprU%$OowcF;i<+gmilNOWn&HkSej(`_LfM-aWtET%BFB^ojX<+}IRpxX!@Z-VF
zWjQS`?|7xJD&O0&{L0ZnHNiY(8X{Kx2tYHtTO@)51+?ZGJS~#&MdV@`HB?}2pd-K*
z%LC>}A0Dj7&Jx2hi3V}eq)ttJ!C#ds=pRwV8t}NzI88Ij`N%GSJVBb$ueM8v`zILU*_rU9}?RNu89#`+*}_HNy(*)7$A(q
z?agH|H`iP&3dRG}pA&#hsN&vdObG;C`1L0W%WzuumlN4Y)gLSZP>Wj5Fg+h3N(Eg00-upTHEVoYYHQ3DlY+oMCx4Q;i>X<
zp+3jm+jA>^w?~GgYn^Mj`xseJDMCrq=0olh3)ZS^ar-vi{|7^cLoaPnFme+oVaxfA4(_g8A{@
z<55iJ{mNJ6z1yT0giA^|di@*4b-bL?Z8yf~D;@t(dU!PHS9YU0Qu`Rde!M=}F7Mce
z?)G_eS@o{;M8onsSQ0GVzoFyv>^Y5kXmY!_L_1R2HJw`m`AYQcGrv{;oAdZl&bWrq
zFJBG|!&@*=lGET$v!QQe*aKtK|pOO-pH5kLeQjI$_99p0(X+;+3^AJ`GWKMU|)E>
zyWYe7-P?mcwzOuHxqE$KH_|-TlfP9Td7O4py7w)0d904IAYX#&!$lk;;dfcge-+G+ehyhm%He0Xda^6bm
z28)70tI;Y$)9ppS`=xU`X3V%j!C}Fm1nbWn&WVtI4ImDUwp2`(>-an*aFP}K__;#F
zsnw91tyb=Da!$LQrxV7#K-yuR#Bmt|`6*Y2GwVDgOg~}Ox8