From 2b74caecbacac445b594e10b0c942da085c4aacd Mon Sep 17 00:00:00 2001 From: thevickypedia Date: Sat, 16 Apr 2022 11:27:53 -0500 Subject: [PATCH] Update docstrings --- analyzer.py | 21 +++--- doc_generator/_build/doctrees/README.doctree | Bin 6858 -> 6846 bytes .../_build/doctrees/environment.pickle | Bin 16772 -> 17384 bytes doc_generator/_build/doctrees/index.doctree | Bin 27118 -> 44398 bytes docs/genindex.html | 40 +++++++++++ docs/index.html | 67 ++++++++++++++++++ docs/objects.inv | Bin 362 -> 409 bytes docs/searchindex.js | 2 +- 8 files changed, 119 insertions(+), 11 deletions(-) diff --git a/analyzer.py b/analyzer.py index 290ef11..1fc25ce 100644 --- a/analyzer.py +++ b/analyzer.py @@ -26,7 +26,7 @@ LOGGER.addHandler(hdlr=handler) -def _custom_time(*args: logging.Formatter or time.time) -> time.struct_time: +def custom_time(*args: logging.Formatter or time.time) -> time.struct_time: """Creates custom timezone for ``logging`` which gets used only when invoked by ``Docker``. This is used only when triggered within a ``docker container`` as it uses UTC timezone. @@ -44,7 +44,7 @@ def _custom_time(*args: logging.Formatter or time.time) -> time.struct_time: return datetime.now().astimezone(tz=local_timezone).timetuple() -def _extract_str(input_: AnyStr) -> str: +def extract_str(input_: AnyStr) -> str: """Extracts strings from the received input. Args: @@ -57,15 +57,16 @@ def _extract_str(input_: AnyStr) -> str: return "".join([i for i in input_ if not i.isdigit() and i not in [",", ".", "?", "-", ";", "!", ":"]]).strip() -def _device_name(): +def device_name() -> str: + """Gets the device name for MacOS and Windows.""" if platform.system() == 'Darwin': system_kernel = subprocess.check_output("sysctl hw.model", shell=True).decode('utf-8').splitlines() - return _extract_str(system_kernel[0].split(':')[1]) + return extract_str(system_kernel[0].split(':')[1]) elif platform.system() == 'Windows': return subprocess.getoutput("WMIC CSPRODUCT GET VENDOR").replace('Vendor', '').strip() -def _get_ssid() -> Union[str, None]: +def get_ssid() -> Union[str, None]: """Checks the current operating system and runs the appropriate command to get the SSID of the access point. Returns: @@ -79,7 +80,7 @@ def _get_ssid() -> Union[str, None]: ) out, err = process.communicate() if out.decode(encoding='UTF-8').strip() == "AirPort: Off": - LOGGER.warning(f"{_device_name()} WiFi is turned off.") + LOGGER.warning(f"{device_name()} WiFi is turned off.") return if error := process.returncode: LOGGER.error(f"Failed to fetch SSID with exit code: {error}\n{err}") @@ -94,7 +95,7 @@ def _get_ssid() -> Union[str, None]: return info.strip('SSID').replace('SSID', '').replace(':', '').strip() -def _send_sms(msg: str) -> NoReturn: +def send_sms(msg: str) -> NoReturn: """Sens an SMS notification when invoked by the ``run`` method. Args: @@ -130,7 +131,7 @@ def __init__(self, router_pass: str = None): raise ValueError( 'Router password is required.' ) - self.ssid = _get_ssid() or 'your Network.' + self.ssid = get_ssid() or 'your Network.' self.snapshot = 'snapshot.json' self.blocked = 'blocked.yaml' self.netgear = Netgear(password=router_pass) @@ -311,12 +312,12 @@ def run(self, block: bool = False) -> NoReturn: LOGGER.info(f'{device.name} does not have internet access.') if threat: - _send_sms(msg=threat) + send_sms(msg=threat) else: LOGGER.info(f'NetScan has completed. No threats found on {self.ssid}') if __name__ == '__main__': if os.environ.get('DOCKER'): - logging.Formatter.converter = _custom_time + logging.Formatter.converter = custom_time LocalIPScan().run() diff --git a/doc_generator/_build/doctrees/README.doctree b/doc_generator/_build/doctrees/README.doctree index 70b566742fc921b1036da1a3022a650a1bea4de1..18825411f1fc757ea79b144cb23e782e263453d7 100644 GIT binary patch delta 32 ncmX?Qy3drQfpzNUjVwNlygK@!#i>Qb`em8P*_E3!851P|y@LxZ delta 44 zcmdmIddifgfpzNsjVwNlk{0@*#i>Qb`em8P*_HY(sm0kP`33svnI)TJ851P|X5bIN diff --git a/doc_generator/_build/doctrees/environment.pickle b/doc_generator/_build/doctrees/environment.pickle index 89588786c76a5d62470ca43487fa4a556d3e920a..7888f724cc74de7ab29a56386f302102db32f0d7 100644 GIT binary patch delta 987 zcmZo^W_;1k$lAa<^{(?q)=Nr4a}P?JWvypoU~qT5F>UwU_uHmTeyQZdXgOI?MP)Ll zia4Vkm=&NrWpb!W`eb<()6IKS9*Ng$Wc^@aVCYdwE-fy}&y6q1%uUtMRM5!GQ^?Iv zDa}b$NX$#jsjNyZ(wx#G0%PkTsh*M%=vOiYW=u+IS!Qx-d|o0^#-yay!KxPj|T4`Q# zNoIcDl+KbVjmYtU6x>sgwejQE1_`fvaPXq&6T+qs;X`;3A=@R2Uk@x)Q0$Qa>5)V8 zS80|kP`GwVmKu=CQlEU%u8J{ZvWvYgW9H-{dt-rIknnC`63@y5vGONxwO32Y1~N6W zP^Ef!d?9JqGcP5zVhSkC&{SlV1GTkJX`7PNKBb4PI5n{-Ib%vzEl@BcFbl)T$@UIn zTBufJ)gc+cT~MhD%q^K<+p=0F*E{GNWB}!}Ktx7h+mx(Q5U&iz1K9($3@FzE; delta 401 zcmaFS&e+n-$lAam?;2-_K{Aveq*(Ft|J3n6}$bb8YnGmr72Ic9V6KRVMc+ zPnoQ(Y{O^-=B-uXpDeGEv3ZZmBk{>!ZBH>uO+H{}2_%2nIRZ%=dn+JWZtnsl_t;zL zNU<_7Xn>8*;si2#*m6@#GV)WVbe2qMoKl*_2NbKFk|hqLvLq(!I#w~dPF~@t%jh=w znxnCR7f5(F&{6sOxz8*;B5k?jbd|b#}F+rxjJs469;>k0;o; zm}N8a*z^?7a#?O_=3YLZm@U>A&+WF^PLs3V4n{gfA_tmW!WrQWp7eWbye|s1 z(zD(rOUU=#H{Wj4F)JkcrbmT06Zg;F2diDhfa4{I6e7;Cug&UH1vkk273v|kCK?MU zU1$|5g_v|2AF13AO}TZK+YGf^_-KI>O^+)zXY+@x5}EXUF9{J2IlXb7X`) zB#3E&o#0i4omTiUR?be%z#yMx#q2?O5=KU6V8J#yJ;~=sM%wlCj}%wUr=i_)!u%6w z!Q??7d3XD&RKRAIkux6MP)i)GhW)xvgXFzPKp2D|LfS=&tqa?YC2YYfOe>Rq%NK@` zZp}HCSZZU=Ze!H6vBKsW=?nx?6Wtt3k)!L~lxUIigdRkj6FVzmwBJX*+A~>k%2az{Tflb`-^Zi}edN>YY72*x$$b==lS#I% zjUD7B!Q~?(=1~K&kVhpxt->)j21T3C^I4VUb21bs!Va1aU^<D?)5@SP!L;oims0nfD`i+&g6UA>CV}#YcgnFnXn6H{%?cN%= z_GKfO0rrEVME9e$qUg80i_r2ig_d<8ho=pFKGXY_0GdDVm?{BY3Z}}9R~8~mc=1Xk z_#n#GR;~+=jMyV??8R>lTKec_KCy2mZf?e{<%%`AXpER{Yg+^&FY%L}TRNhq__<&X zf>BaDF3@$_M^3aRn3Fy@fMeBIFto1l)iXX)-_p;-{N(;JR0PBg$oj#Z~~Kn&&aF27MxGd!110b|UnLW&*ZW>TymPveM~omTl2tMCAi zV=49!&rj0VxBw^8x*StfHolFUnGz=il`RZ#2Z1lLSbGUA$>9)6F5D=a^B1!UJhKUX zQJ^dk5EGcCT8%8Eq4!==58=x%UtAZPvZI9@*x_N|2y2dY zgq{XcX*L&xi>=)BZLqxP9iPsoRZ-5)@wjajcvKzU>4c&RsL_A!$y(6snF)kM}^-&Bp_b?1GIn!0blDdZT#E~2Uu zjKzSHXlOa(2|#2g$hSfbOl83A100J$CKkA@4>;$y_W_@PDx(iTwZKWR4|v-TeE=xg z9xklC71_Ni@T|5C7UMu0fnF}XYk(r#9x*#6A5t{l2L-pNHKs?TQ~(U9m6G^jR4^$< zn<4!?p|>pSVgZu5yDjuKj?j71$9_n++Rh@Ao0*+I-+Dl}mTz0|iRRmu0Op%V$N}Se z%TF%s>h5ge536|&ns)H_0xk-y+2nEeO5>hjtwV~K%}uMrU2IQwW(jzzk&Y}Iu~z+PQbpxme~ z&9$_;24PRoWhb_4Ii?^20Toa*QiY|K=hM7+5J)<8o>^CmSYi5C`V3=QD_y`3qpAQB zIPy3+T<;oJ*b_y^fKLM0moTm%M5e>X1Yvnhx){KQgiR)sT3GE338(J^x(#ygmL@jw zMU#HNr5SGEuqrH?Fh_oX@eOE1YE(bsSAs3HCu40i-lpB`b!^>oF=}!9xu=4fl|hqZ zUPO0k4chV`J)oJO&M|GTE(IvZ+^YGgTl0~KKGHbmT1w}T=5gb2B?xiN$dvUdIX*3N zQ*2t`5N7zi4LldK#td_DE>%sJ*98|R)TjE<-mmSk8~2!~x&)gyNl0GXoLss&=UMas z%(7TU9M7p)JG=M?h%93lUqP(~yEv+uAX5_<@T|cuAQ6#W44MfnfrpV@90!x;M|+&1 zq5TW^MA80*pp9LukHY2Eu%d`#mqq!Ac^zy_wciD=ZZJkQGO;U%OoyA=3l0FDW8L;v zN^hYf?X+Sk-uM0i{YvYycr*Dmvx5Ajzh#>tvkc|E)*B7ttpPI?D87G4l~HD4X^=hu zWt3Ss#t{3+F9J10xT&4Fgn=9)2O3sVV)5@F`EIa{Sr(#b4BzA%uA=0F4Vmx=qbKUy zm=1G}2DBb}E$PsNHRYruXM%RX{2SP304Cb1L($nF1x#_Pz^5lQGGcTSa*oe)Dpr^> zqo{m_@{#;>R-47;a(OwI7vVA!Zmu#JydF_yys)HD3S5rJVpcT) z*P*eX->dwORGRUV212lNxER6@8)B2MN1G6^87oniS?Qn=x4sa7_Ga?EZ82sX0tCRF zMkz6fya`I1F1PJ#@-nosdHo&~df-u>LKpQ6KW2L6$_3yaw`)IPT)7Z%%^}T@ur46h71<#=Vi(ecV0F!P<_l{<{eC?B;nNUks_E8(MF z!`4zJ>U?46pp~%1AfWWwse2V_F$;}68jVmQS{J57G#RGQ2j7s0)`fwHI@6~cOxK8F z)r}yDvQ3z6u+5qVxkt?CLi(&jhXN^a<#f%$RW(lS_b3BaKhE+v$dh6;|23G37gxDd{OgQ~8c_>V7 zy-s3&iV4@@dk$kClTL<_*T!SXB&3Q)YJ1^0;3jxD95|JQiy=HXMtQj7gY$vBzjyhK zui#QV;GNfJ9$kiMI3}Mn;a*4GsWF|-zKQ|FU!a;Pot;mwC8x+DpPhFu`0`c5Bc9Mn zv{oauFNY~$K8HDqm!`H?KMq4{-AXTYz)uKW7tDHxYFucSeG!yt*mVh?D0W>6BX*G| z?)i~#X*JkVD}}4U4Qt8Ky)GtDO&-{r>0g5{z@<{X?RP5494*W>3XTI3l!Yq@{;=gA znjmecU=`u^tz(kau;(UnshXVGcPA6W5d?5IsUCKb-TSMUtLacfvu0iseo$Bt z;uM6WmTE%wx3}Ltr$*2398ID@whTkz@EfM#{nFE$VlW0(?Qrb~XUOB)r zd+mn#m_1)?)Slr~`y+E2WsW+GdZe118jdog%&5mLqrO9px*CjvgUYSIMRr=41)R}t z24m=woedDgNA1?S+&J_Q9a=tz8_E66QIg^!kyU7|CZrx#1gf9!*6*#BI#AOUY8< w%bicbr6m1F71BAlFOu+fOu7S`5$xopGjK3d3ND?ehb;ajis%O_uq&|%Ne2Qrs%OujlVmuVlz zWWj|Z68k{%?6Fg_>KPdrG#jVXPSMC<%>qgm%vWSQ2Gk`xdHs9?ro$YQAI>*py2vqE zazPl=0glOq3k;d|fG8#DT@Wj_gDABO<_z@=jSNk{(xj~2Kurtum_9*l`h?Xcprq|W zMaEwsn^-imE^th4Sg6JH9bz2|C(t?_)vQNAtvwvM`6-!sDXA4xN;6cmB!JF^*yJq* z^wbxSQ*_xt%nyWJwRDjVlL{x;|0?&o5tJsQD z6N{2F(A^{rbch-!$W4ftX61@Q|7uxWr0uD=0v~f#od;j+f1ImeepYwR3Kk zTE3Inej!jgYaWP51iCRR4oH;taONfErj}F|q!xo?D%URyq|6Vj#IH0%5)^$|89G3H blZ94$F`eR^9JjiO9i$f+@0%spgfapELjSXN diff --git a/docs/genindex.html b/docs/genindex.html index 3ec83a3..d15e819 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -43,9 +43,13 @@

Index

A | B | C + | D + | E + | G | L | M | R + | S

A

@@ -79,6 +83,34 @@

C

+ +
+ +

D

+ + +
+ +

E

+ + +
+ +

G

+ +
@@ -112,6 +144,14 @@

R

+

S

+ + +
+
diff --git a/docs/index.html b/docs/index.html index c3b17ff..7b19791 100644 --- a/docs/index.html +++ b/docs/index.html @@ -123,6 +123,73 @@

Welcome to NetScan’s documentation! +
+analyzer.custom_time(*args: logging.Formatter) → time.struct_time
+

Creates custom timezone for logging which gets used only when invoked by Docker.

+

This is used only when triggered within a docker container as it uses UTC timezone.

+
+
Parameters
+

*args – Takes Formatter object and current epoch time as arguments passed by formatTime from logging.

+
+
Returns
+

A struct_time object which is a tuple of: +current year, month, day, hour, minute, second, weekday, year day and dst (Daylight Saving Time)

+
+
Return type
+

struct_time

+
+
+
+ +
+
+analyzer.device_name() → str
+

Gets the device name for MacOS and Windows.

+
+ +
+
+analyzer.extract_str(input_: AnyStr) → str
+

Extracts strings from the received input.

+
+
Parameters
+

input_ – Takes a string as argument.

+
+
Returns
+

A string after removing special characters.

+
+
Return type
+

str

+
+
+
+ +
+
+analyzer.get_ssid() → Optional[str]
+

Checks the current operating system and runs the appropriate command to get the SSID of the access point.

+
+
Returns
+

SSID of the access point/router which is being accessed.

+
+
Return type
+

str

+
+
+
+ +
+
+analyzer.send_sms(msg: str) → NoReturn
+

Sens an SMS notification when invoked by the run method.

+
+
Parameters
+

msg – Message that has to be sent.

+
+
+
+

Indices and tables

diff --git a/docs/objects.inv b/docs/objects.inv index e55a9c72f85880aa54534a519d886b2989e40fca..c7de258eb880c2b637ba403699f3cb4a132a697c 100644 GIT binary patch delta 300 zcmV+{0n`5K0+|Dlc7KygPQx$|hW9yz5o}Y@ZFfj?QHi36E?8Pqdq|@C5qT!GVZ}AL z9w#A*8<9#-Qg+rq-#26V0S-*_hCx)#!g^gB6t|*u8V|FAt+|d_dLz;Vj_B;cD=@2U zqri2VGC(BeW9v732FCb(KMT3=da|{LhUEX`t?_Div84h6qkkj^6&0Q@_CxI^IjSc1 zR&r^v<6mm0xb*Ifq4Bj;C>=~T@W25SOX4um$g!oV)Dv++rzKfBk3TK%?$=8}tQXoV zkv0m2xDlzuU)fpTy!VY{8wEMOPy=<`X;CO^8Qgs}(`evH1P<%|i#a z6-mIbSGh3VLw~WWj@dX!Wvlc@($>lJ7p;ihJ;I_