From 486c1d3502d32e9be26885ee12747f857c16e1a4 Mon Sep 17 00:00:00 2001 From: Anupam Maurya Date: Sun, 12 Nov 2023 10:46:36 +0530 Subject: [PATCH] first commit --- .github/workflows/test.yml | 28 + .gitignore | 2 + Makefile | 20 + README.md | 51 + build/.buildinfo | 4 + build/.doctrees/environment.pickle | Bin 0 -> 43294 bytes build/.doctrees/index.doctree | Bin 0 -> 4971 bytes build/.doctrees/modules/asymmetric.doctree | Bin 0 -> 3497 bytes build/.doctrees/modules/symmetric.doctree | Bin 0 -> 3490 bytes build/.doctrees/modules/tanji.doctree | Bin 0 -> 3462 bytes build/.doctrees/readme.doctree | Bin 0 -> 14135 bytes build/_sources/index.rst.txt | 18 + build/_sources/modules/asymmetric.rst.txt | 7 + build/_sources/modules/symmetric.rst.txt | 7 + build/_sources/modules/tanji.rst.txt | 7 + build/_sources/readme.rst.txt | 4 + build/_static/alabaster.css | 703 +++++++++++++ build/_static/basic.css | 925 ++++++++++++++++++ build/_static/custom.css | 1 + build/_static/doctools.js | 156 +++ build/_static/documentation_options.js | 13 + build/_static/file.png | Bin 0 -> 286 bytes build/_static/language_data.js | 199 ++++ build/_static/minus.png | Bin 0 -> 90 bytes build/_static/plus.png | Bin 0 -> 90 bytes build/_static/pygments.css | 84 ++ build/_static/searchtools.js | 574 +++++++++++ build/_static/sphinx_highlight.js | 154 +++ build/genindex.html | 105 ++ build/index.html | 125 +++ build/modules/asymmetric.html | 108 ++ build/modules/symmetric.html | 110 +++ build/modules/tanji.html | 110 +++ build/objects.inv | Bin 0 -> 306 bytes build/readme.html | 157 +++ build/search.html | 124 +++ build/searchindex.js | 1 + dist/tanji-1.0.0-py3-none-any.whl | Bin 0 -> 3977 bytes dist/tanji-1.0.0.tar.gz | Bin 0 -> 3255 bytes example.py | 6 + make.bat | 35 + pyproject.toml | 24 + requirements.txt | Bin 0 -> 272 bytes source/conf.py | 28 + source/index.rst | 18 + source/modules/asymmetric.rst | 7 + source/modules/symmetric.rst | 7 + source/modules/tanji.rst | 7 + source/readme.rst | 4 + tanji/__init__.py | 0 tanji/__pycache__/__init__.cpython-311.pyc | Bin 0 -> 135 bytes tanji/__pycache__/asymmetric.cpython-311.pyc | Bin 0 -> 2252 bytes tanji/__pycache__/secrets.cpython-311.pyc | Bin 0 -> 158 bytes tanji/__pycache__/symmetric.cpython-311.pyc | Bin 0 -> 2452 bytes tanji/__pycache__/tanji.cpython-311.pyc | Bin 0 -> 2261 bytes tanji/asymmetric.py | 40 + tanji/secrets.py | 1 + tanji/symmetric.py | 27 + tanji/tanji.py | 35 + tests/__init__.py | 0 tests/__pycache__/__init__.cpython-311.pyc | Bin 0 -> 135 bytes .../test_tanji.cpython-311-pytest-7.4.3.pyc | Bin 0 -> 3850 bytes tests/test_tanji.py | 33 + 63 files changed, 4069 insertions(+) create mode 100644 .github/workflows/test.yml create mode 100644 .gitignore create mode 100644 Makefile create mode 100644 README.md create mode 100644 build/.buildinfo create mode 100644 build/.doctrees/environment.pickle create mode 100644 build/.doctrees/index.doctree create mode 100644 build/.doctrees/modules/asymmetric.doctree create mode 100644 build/.doctrees/modules/symmetric.doctree create mode 100644 build/.doctrees/modules/tanji.doctree create mode 100644 build/.doctrees/readme.doctree create mode 100644 build/_sources/index.rst.txt create mode 100644 build/_sources/modules/asymmetric.rst.txt create mode 100644 build/_sources/modules/symmetric.rst.txt create mode 100644 build/_sources/modules/tanji.rst.txt create mode 100644 build/_sources/readme.rst.txt create mode 100644 build/_static/alabaster.css create mode 100644 build/_static/basic.css create mode 100644 build/_static/custom.css create mode 100644 build/_static/doctools.js create mode 100644 build/_static/documentation_options.js create mode 100644 build/_static/file.png create mode 100644 build/_static/language_data.js create mode 100644 build/_static/minus.png create mode 100644 build/_static/plus.png create mode 100644 build/_static/pygments.css create mode 100644 build/_static/searchtools.js create mode 100644 build/_static/sphinx_highlight.js create mode 100644 build/genindex.html create mode 100644 build/index.html create mode 100644 build/modules/asymmetric.html create mode 100644 build/modules/symmetric.html create mode 100644 build/modules/tanji.html create mode 100644 build/objects.inv create mode 100644 build/readme.html create mode 100644 build/search.html create mode 100644 build/searchindex.js create mode 100644 dist/tanji-1.0.0-py3-none-any.whl create mode 100644 dist/tanji-1.0.0.tar.gz create mode 100644 example.py create mode 100644 make.bat create mode 100644 pyproject.toml create mode 100644 requirements.txt create mode 100644 source/conf.py create mode 100644 source/index.rst create mode 100644 source/modules/asymmetric.rst create mode 100644 source/modules/symmetric.rst create mode 100644 source/modules/tanji.rst create mode 100644 source/readme.rst create mode 100644 tanji/__init__.py create mode 100644 tanji/__pycache__/__init__.cpython-311.pyc create mode 100644 tanji/__pycache__/asymmetric.cpython-311.pyc create mode 100644 tanji/__pycache__/secrets.cpython-311.pyc create mode 100644 tanji/__pycache__/symmetric.cpython-311.pyc create mode 100644 tanji/__pycache__/tanji.cpython-311.pyc create mode 100644 tanji/asymmetric.py create mode 100644 tanji/secrets.py create mode 100644 tanji/symmetric.py create mode 100644 tanji/tanji.py create mode 100644 tests/__init__.py create mode 100644 tests/__pycache__/__init__.cpython-311.pyc create mode 100644 tests/__pycache__/test_tanji.cpython-311-pytest-7.4.3.pyc create mode 100644 tests/test_tanji.py diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..128758a --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,28 @@ +name: Run Tests + +on: + push: + branches: + - main + +jobs: + test: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: 3.11 + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt # Adjust as needed + + - name: Run tests + run: | + pytest test_tanji.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4f585aa --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/.pytest_cache +/venv \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/README.md b/README.md new file mode 100644 index 0000000..5adb735 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# Tanji Encryption Library πŸ‘©β€πŸ’»πŸ” + +Tanji is a Python encryption library that provides a secure and flexible solution for encrypting and decrypting messages. It leverages both symmetric and asymmetric encryption techniques to ensure the confidentiality and integrity of your data. + +## Features πŸš€ + +- **Symmetric Encryption:** Utilizes the Advanced Encryption Standard (AES) algorithm for symmetric key encryption. +- **Asymmetric Encryption:** Employs RSA algorithm for secure asymmetric key encryption. +- **Base64 Encoding:** Efficiently encodes encrypted data using Base64 for safe transmission. +- **Key Pair Generation:** Automatically generates RSA key pairs for secure communication. +- **Random Initialization Vectors (IV):** Uses random IVs to enhance security. +- **Ease of Use:** Simple and straightforward interface for encrypting and decrypting messages. + +## How Tanji Differs πŸ€” + +- **Robust Security:** Tanji prioritizes the security of your data by combining symmetric and asymmetric encryption methods. +- **Key Pair Generation:** Automatically generates and manages RSA key pairs, simplifying the encryption process. +- **Dynamic Initialization Vectors:** Randomly generated IVs for each encryption enhance the resistance against cryptographic attacks. +- **Base64 Encoding:** Encoded data ensures compatibility and safe transmission across different systems. +- **Developer-Friendly:** Designed to be user-friendly and easily integrated into various Python projects. + +## Getting Started 🏁 + +1. Install Tanji: + + ```bash + pip install tanji + ``` + +2. Use Tanji in your Python project: + + ```python + from tanji import Tanji + + # Example Usage + tanji = Tanji() + encrypted_message, ciphertext = tanji.encrypt_message("Hello, Tanji!") + decrypted_message = tanji.decrypt_message(encrypted_message, ciphertext) + + print("Original Message:", "Hello, Tanji!") + print("Encrypted Message:", encrypted_message) + print("Decrypted Message:", decrypted_message) + ``` + +## Contributing 🀝 + +Contributions are welcome! Feel free to submit issues or pull requests. + +## License πŸ“„ + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. diff --git a/build/.buildinfo b/build/.buildinfo new file mode 100644 index 0000000..af3fcbc --- /dev/null +++ b/build/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 009433cc63dc96753b2cf1a0b5040b49 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/build/.doctrees/environment.pickle b/build/.doctrees/environment.pickle new file mode 100644 index 0000000000000000000000000000000000000000..2395fca2fd75620942ffed6419300eda7d54c103 GIT binary patch literal 43294 zcmeHwd5|2}c^}Tbcd@%zfB?@1Kmv<3cfngUDA|Mv5Lzv;gmF-eL~z(M)4SadGt{P-=H2VI!S1O)J1-;QY{ISN1jmc=MU9C3eqk*Dd2y2d0^lFW0LYGkwz0ypsYKLyg z%QvFF+_|uJ249UgDC5baPdB3N=k1E}@Xk{Wji`S{7ZfzY#@R;H6VwV+rrR$W+(88S z^;*Gce1hW(er3U1Y(&GlPV?RKm_)>Y_WPHeTFomu0pO0d2ToXLz@4k1Qwco35;QIX z#*$rGtlNtYsy?$6x_+e*^;T=XatdJsmG>9?>Qc>Hbb*zf_uX^f{dZf(D)p*ewocpi z+LDcIb{*M(h2f@%-kMW#>;NTizjx-InR^=1Na&QSB|CHiMiSLOkc-0_b~Nf-EtKj- zhoVELCLj*DVY!qGU8jtq`t6dPw*y3?mpCE_?a(X41@`770HuvM)p|Zx2!h;#R{|PP z-3VvN1PybLN+lYu)XTteZo#jW?T~xDHvm3>GXQ)}{#kbgXgiYCYXGbFac^;kgSLlu zzJ!pz^YrGRfr4Ljrt>Aga0&TOc|qt^7AdA4^<1_~b?%`_cR$d*6=c|$|3t&R%RT6x zz@KPLcSbJN5t|y(HiDW{9&qn;KS(Ki(cjds4R@Bax`*6JDPw!+7wshz9`*BQZlN4D z<|U=&?vs>*0MafwIglXZt5?2*hAr`Xq`^5uHH_JcO+B;wg_`e&FV4JR;$D0Kr1oM% zGFpocdh}|Tvr8raN^YV4{PRn>ux3{R&;t|Wa@4ESP_v?2Q;|8~V6o<)BMT)v2!O9; zDRrRCq>#fH0+o4{qH|T(*GIr`xSN->!!nF=L49GtyGmnX+e|H>!H$x{TD=gWCyNAQ zBaj?BbPlJ24n&uM`s(4r^uyDEw_TA<(>n2+mF`(DwdQi8HytfNZ^%W=eb=ofN+owZ}ALnl{r797A)aB@M_2G`M;9^xWosK@9ZsV*%N!wfLy zmbh6=h~qB!MTvMuOedgDjR0NiSdzxC3IS+RaSyvwLeM)5Yslrn$H1cIC4Bgj<5Y83 z>{n{k~rp~u533@$i#s`R4)4!(33+nfOrOY0CbRZs$R)oG+o0%AiGr1 zI3tSKHRvU`P_j|C?x&F|aA?<-KyZxNXiF8tjnO+)fsg=#Sjsf!=ZUsQB`n2>UqlQd zhRSxO3T7PS>NSjRDWR|8g;lR`X{oWyiAMBy&ReYbU_KWm??g5j9l40npd)*PrJ3H` zsW}|D8vf;qP8C9GZZp^C{-}FYQ%2do>Xi`>dau|tJaQ$kf`?OCM0yS04)91fhhp+h zjYhYrV~oR{=YVR%Np+4vlLO4eU~nKT1vxM}g>vo+`5`rL6xcgjRMUdtR3lao=u;a<%CwkR8Nq>p7am@BXeIgUO8 z?_fsZ)HSArhI0^at{r#*1Xu}xyMC!i+4LA1W_bkZF+mzSP@@s+l2o9m`ZPGTyypn_e)j>XQE+B-j7*|PPyybl2g6n= zRM1Aj(4O>YkCO(F$-wYS>H5J}a^M9R!=~FOxSbeF5}v!_6=}3>l3dan=B^m?#GSng zjWUfni3Zi@M7q5qEg9u9q1zQ|9sqY*S>T&>k`*lNHQ&_= z9AF4@;VScpHkgq&{ah(HwGW=aU<`4{f_>QoB6Ohpp!*QVy6FONxe;k*imW&|D#}S#9EKM0E^6n|T|<90H7kB@;w9Fzr|D5{e{pFwr}?Opz4S zt6qT_7iSefsty!S5Wyv4XdFJld6MuPH!Rxn`(M^|iej6l6V9hGTrGK_CZJ_0P$EdD z%xUu?QxnspL=YSXjNJ@I5^j_!s8S*HCMjClN1$MIR07AY6GkJBF2|!d? zQ-l=903|B026m6YL)wkhgS=%D#0KD)!jM2Du+AwILc@d!ep1wQoDC zeY$x<{!k>K9znr@HXrwrbi4>vl7?E5ovNizZQA5GaDQ65S&v?|o1l+lAlX9B!-}O&%b_izKW^O*olTY)9&dArnz2 zIk+sT$4wxlwVxA5ffhYC$59D)3GEs}NjVXTa+65|TM2ws+gN0w?|uBjsZ-YcvC}84 z_ntU?Z1&Wn$BrLAd*a-=A8Sa>yOONp6@Ybam*L5Yvkv9vVS|z%WQNkkK9S)j2SN`ttvUo#2qTKi z8j!Lyr{|zi34&7wq{*BVXyBMzB!>8q{42x!0^2Or%N1Zc4IHJp3Qi0STf+BBj?k}` zoXbuL%!PGGvH|BM#e}42;o|9HQ$l@9#n)i%l#ColaslcwX$qWgMB?B!VXKPR5{K`W z@RUS}br+5wlX&(#Xj686#zgF|F1fY1%GpO^hN~S(dqn*Pwd?NQ# zCOPF&Vn>BKS*|BsIF{5Dyaqd)9=#?D^1=IJbm@9tm5^4Bz z+gmc(l>!tSk_}wko}?xnlOQD8^2|O%<5s71WJIx9cvuR&HAz^*cmw|~L&zIYPd-}v zJ+>nxaX*HVRzpA;7=Lh6u^)0UrK1tz4%%~@U8aZ%+UJC} zSHftn8`SJEv4xrshgR%vi3x?O2n}irE-98#@6`LIe{%niJgYhUFej-vR|qkP-d3-` zn<3nPC&!WBDAq%$Xtu8iGA>$M>lyt-EU>F^wZc0RhOrsGqmc88IrwAQo7i# zPFH9I?czoYInkysIZGHLMeg6I7fLNW3Dh9|=Pv+uFsTv(NMe>q8uXL(Ov8#e%lu|gI?gB{}3U=dN_ zv4Ok`BNWWSDOI8DREpZy$+Hh}OoMcZo$;qh2&HLW9ow>L6GcxX(M9JnIl$Oszul=! zgE7R(_9V%4b;kD+ZN4{2Hj*S0D>5!1RnMh7`KF6-9ycOkrPDIk5hor^ia}y_>&0=Y zf@)5gysz2#o07cZzBDprIWA&vlBDcapsv-*v41X3l)_s8okj+vyDyGU!6^QIc!J`{ z9Z3z^MjsHF@d0#Lg05SVWMos2%Mg5nJVIb4Ngt(cyn2-AP&8ZkSSHOYAsO z4{As9Uge1E(PUeaC55WET*)&Q=P?mUE-R@BbV?I8#I`W;L?jBn1QLz$FbbLy8ciH{ z5gkqV|$3t(+tzN%!C9- z>|m)}cEH#$>oaBoQ(<~0C>l0#qU^jLjWQjfYf157C+v%;pr471Cxg^A@RDdiYLt+O zLTCm7lQ8M3CH6In-DP597$oxVQDh7t10fNwBccvyG!z676Dy!$2-F)$pr~fmpa<2W zK1B~IQvD1)s0{V@@j!36r>PyI8u_BS1T%%k+}3DMbD)a}U(7Lu)TK8yM|#>nhd47a z9+!rB@45bXuG<7N?x?K2O=TsLion>}6ibGCV{S{dt0`QhMq_SUOZ_xghYZbN1!0kb zd!(Gk+kcoW+6V{Y6r6kTrL$!rMD(^v)7v4!5#(n|z$c*QN3tRvQ z>ibjxuxqR*_&3+ToNXZZC`E2NzQT+p_v_P(-OGrB4+L+*E zix~z{w3|7c2M=J4TpsWc5Q8nE`8(6oFJ^|B)Jk`&`;*JjuyKr`_u!;<_eDdTA!jCe z>QNu8K^i^WQ9NW`?fsYAmp}98{XINbUhUm?n|#rLdA0YZlk!D_=GET%Gx9|P?A6}d zAMjT_!W=Dm5#aZu>C|WtHgicV9QxApmvAzKSkEDoLZB5yZKculM&l){&)_jjOlxRn z=E&I-$Bv&qF;gx!UJs%^JwaS-sDFiO)xW`mazw-Mr;#FSm#)}LLE{=`(sMN3N4`Aj z4QPKf3+6gRpnJsEMiDKM!aAZIdPITVDkO*jDpIqR1t9e*mj0T3Mc6KJ@VkD3839s^)0-RQhgh5Sd#3y&!ma04>=`h^o|w!7HbQK0_%8Y z20#}gWo$bSu}fIJe!iC)v<@fgk=g8q`ZK@~0mDKs8MsIikmu0x zuMg8X$p`7g?1#CCB^kY;4I2gWM*TMwt^OB1{*)TpPZ$?Gsy{}6J09)DnjUW6(}K*W z6G;*gUvR*h>Un8nA6Ym)^xL=>vglO*i7M&ER1+)w8GOb#SAT&-XrB5@yrD7uA9;OW zUVkmGzmXS1&ho4m@|l+ipws4KdHOPzF*Qj@3X0`bEX*1d+)ntu+;E~HP1nXFHK``H z0%N=Bv4OOh z7_MLZC^>6$)BbcWdVe``XSJwdhypCSDOg3&3MdhlOEniN%D4k z{6;%;uS{R5L1Tog+g9yRuIt!Bg~xQG{x8)l1e4S|U(Y*Dl||MS88p+OKh4U*bTDm5 zPQ1o;w!`BbG|V^$hFNot3{eP#?jr&o0o5KnCfh$jwD5~8rB15vWMiW7S#iEvcBKeF zz~*6Z371g+18LhPkdZ8qJOY$q6gOcc+gjD8C8;s`Fk!tduIEO~7#z&k!O~^cro%AQ zT&#D&0h+4>MTL0F~S2KDgbZ> z4dp7zTOlzO%abvk%VP}p8HgZGTO$KLx4evihA*!CSaVEh@0kxr0kEN z?2bdGZ4tzJ7C@g3QM3E`ixb)uzoTr(}D&lSpnWgKN<(qqbc5LXcQ+PX&2H%Ma|Db#DQ$c%Rk8u*Y2VZ&lx z{S!(yM(Q3LYYW)D096`-yyr<-R32*#WXQ}%{g9JzzSEL0e9&ShOsSMi(5HccD5HNpaR(n3W zMMBKv8&- zx~(ausR(6lqyCg~TNV{Xw`L=nGDoBFgbk2Di%J{n_XzNP(N0XdVrq?6?^}lY(G0vuoeyi#1`Gt&mkCvM34jbTyvcQ(r|Y7_}I&Jojw|i2COgu6~sY`T{+EjlX{#&sWsf z=szav;F0f>Q9!G&B5XI1N%vf``X|B)_&l%~f**k8z+Xk)F*xwjq2lyFFiKm9KS(bp ze+j~SDNz1Tst3WU)qV8%YkK?@9`&f7Qpf}zc_JvyGRH61*)2hVoQJ$7oJSFBuSdf% z$3S&l*)SA)?t5}fN(lK}O*)!2j>ggt9N%M6-LO|%OJgKnTm5=S%Z#A*c*@C4O=MrWt2 z)tH=BCr46?A8G7Z>~yqF^Nd@z>)XVq`|=mp+?N`0iKqAH35ATf&*2|jya$_Iys!`3 z&IGbIk&xTu!~z408#OJN;XcebZqrGuI7u6Kmr+^?wltLLixkiaf^213WjLWDE@B(X zA^zQi_Z+;X{7UPkst-Z)s-K^vfvO?=)xFMorrN=Aqx>A>=Quxi;;AO+u?vs6&1$#2 zZo+F`?cwKMe%?$GM$1#T(ARc#D@WbN&)e}d3Y@wFAFN}kee`cXJr2ZSchbMR=y8x9 zhv*>+l$ykU(wEd>{7EZHYKmgikMQ$ueopgqhM!0Hc@IDD#Z$0b(eD7PUgXkJ4{mr7od<45{bU zkK;+pF7SfG@G*Ivkk?6h&C2U5c&RVp5vaK&WI50RpQ99woj}b?{26(j#S2xOm)Dc> zdP-g&meRG&09uE78@TUbDbxsS_m zwOXPwd6ylFZ5RtCQ`s_;je6i&^M1uSY8|52c`)BYmTa@Mu(8Xk_*Oj4WF3l&3l7Z; zoUbiW75hn>kRiO^LXLusRTmys=BFwr{i#W8zwMz-v)TWGK3J#j@C_8v$|_f6R7NOn zHbQaR?EK?T#1e5^mXoze#Ae2xVwu|@z&g=Yt15Qq1=-q`>QEBWnVxUz-PL7Dqxk#l zNAdq=6sy0BS8BjSPtMF(35^~-D)UA&iHsVsEbC~QRx{Lsqx=D_(=SYCf@oplv{%9A zKq&CoEPOO8r*BjxX%zKrUn>==PXZSzBD~0CV4|xLvY@Mx4D3=@+iJ*i`-!t>pTNAn z*3{NPm%Rka&jKVc&`;wvuRbFmpXHBOO9A=vvY_?rU!&*D!m76FS8H^-Lk_LELt3=2 zJ5hw_HT&=n+Sgs3w69pDk_Ah;}NS~6q2Z36s2h3ysLV>^Hr}L^>d4fxe}MrJeH=g z#VzqPidd)WrTzi}sEvT5!PugBHS_co!+aYmUeB)|!B-f;EsEEL_KH_5eKtbxxMJfPvE?$7Wew}NG7ZA49x3W>` zUiimr?u8az>z7c3C^El*f6%q|b<(wXW!ZJ~tRYU+Nyn1dRq0m*Od2fpWeQlIe#J$+ zt6z1aUoq<5(fZYI5q*6Xk66E=kVL;O{enTlA}+Xs=(fT-pfT>IRgbmgxOGYo)vu^eRFT^eU#88>3gP zl@wQ_SCQz4UKNoWV9k0}>!S3Yv$Ai{tX-5fh&nKh`on8ReTy=65JiaAasdCJOx@h9 zOwk@6xczAtTdd8rO!H42klixYiAtfi#Cs&HQ(nG?&G6QD-~6f1|LI3x`|g`R{k8AD z*?2wca9vBrbkiU1w&}7YI_gjMI7zEEi;-7T5w$AVdbj-=bZN~Ar z+~&}=Lptfy~j+fSaHno2Fu$x_`39N*$E z1=iVf$C@chGwrog)-{68P*w#Wsj(5=+!>fGJ?(A}bB3TAD7-7ZKOv}}LJ@|b-fOJ~ z9ciMWQa6TZ`h;j+V=&)BqWQ?w)cdj1{hRq$6^!vZ(qq)%$K9{WBDuqlXapuTq|l^>#69ZBWTDnZCn&Vf~c zogt*Hz3UcQn^1%iT6b9&R)di=wNUnrp_W0RmcMzcspXlesS}V+WT&C^L>A{fI*5+V zIH<8UU1I>@gRMkGi?_QhU=Pk}ZOwtWhntk<=;95n*Hk;Hnzg3U=6X$1VJ1UqWMqi# z@cN1Et`xDI-cUSeAf;+HhA4-GDEBekH;#p^Ws{-$9!$h&^R(G+pf^*t*aioQKgEhY zhIlgp?u8}%0so5jHy!sDaP0?~#J||cQp5`B(wtzvTk>czZbk&@Ee%+`ZTvjgub;06 zp>Sy-Z+tGMhI{ zjr}BdSQq$BXzms6BB8kt-6$-jiHs`T7$VbWHhi30&;=3_?RITM_VKBy<4f2;;1xQk zx5Vm1kxZFJMQaucE<4C^l31FUoQi0?L}S>=hC^>y0k#)$K@=D$yU($89S7Q=M(lmS z*69@}@1Fu49Vzd?DnQRNy*sYc)C>>&HSXIkx+0;+U*X;qdbDpm7SohTRc{Ps>Qf*- z&u!@f9o!X!?eqDM+(BL7Ga;}4z+EEbb?!!BCQVRO*~SpmPEpAIEkoZ00=gwA5B!1- ze84R-wdu#PhYKe%ED?J<&Zi55s4x+i$EIlPznxyt@ocx@)=3ZCPiEn8&IMa;zIEA# z@>dVcd?Vy2-JciCbhgsmw+aNq_gW3Mn>v7CatJx?Y=fx`cl^Qn$@i~PXf}uYD{_ z8y!=n*~J~Wb*`%kkQV!GcL)28&p+6Kn-I!$2n`N5r4#nDQ-mwbciuY-bp-BSu}qE* z3|P-T`z%h-bqB1fSH)15SZFWG5Ne?+oMx|Jy$vLp5qzdw zRLxU`JVX0IMot$3r-dYMmI5E|w!q`an701rbb-=+YZ?1`#3v&02sJnM)1)hDV`4sa z4TmqnO{vXuuOe$p^!gbs&-B=kQ=|uEk24Po3nnE_QIgCUKnJW7S8@Ime4Q8Qkdgt} z32MDh5==|QK8>7k`hTe>06x>izJ3ni_Qkk&{?*CC_p zBHxgaUVSqNMnESY&;)6gn@3xoO^$hFnxlX;QGK#4QPE-A_cb3{(sYiR5%}wCoI}Odxb%f@D)kAZCM`#!Wx35gt8F;7_8>5z5f|id7 zTAKB`FZ?YVOojkOL-<<xXfiK-mxolbDZdj>l zz+OD>VylI=5YbP#Qj;Ms z%8`;h#dv!5eB7XEEP;~k4Ieo*``C&3b0;oN>OY4qI#HD;ljL^G=Kj6Gb)^yc;D#ac z{`QD$W+?IHDa|MNnM=x6JZqZPSZ9p=_fPfX_N zn?Hc@p-#{sF~{~%NW8aslH(K$v(J!h>vRfQi)Zo3Y=w`Z)lNeT-q%_o)n ztYm1?Y7y=5OHO9hCLfig$l6xFOpjF~{**>MFGZw_df}yFZyX6-w?<1DVTjX=DJ^4N zQ?G1n(djOGVf|fpwSAWn@>cG$e?%!Zq|2xzMJ@^TO?s@l%hpWo8QWpaxzmXMne`+7 zjrNEq6s(N+KcW;XBOZ5qn&aSC8Y@(iA{$QqIXza5_>Cp#Os{Ng(djPx_4RkzueR?p zLf*<<_Ggr0L%NJgQe@}WH~u_WzRO^)FW~zY&AG6|(iJfYMFgt|1#Qnx#3A{70l|^f ze(cG4{6gGvXRFl7ilnU7^SEjfYddY)kfbke{MXo?9&OXtK=NVlJ#rBp-R&W_w>Djm z7Ef!6rMKEU4nB?UN?ux+#MHjn2YF$a@Ch? z6qkj*=7z=}61mYOmrbY8uVhRL)O1s*8mF8)>2WJPZllNTc;GblJLo^%q^b7dv8?v< z^8i2Z#1n^h-^CvX@l=QCF-Z@(e3OmbZE%$F&6|v-*>2H9>tzIHK~uAlzEWFTCg2YW zrkl1pC$u(=_|$Z05^-Or2&T?LZd})b{C5)5*oF; zEh2H|3i7+?KOzAm+&b~4=I!fA*LB&a*O8NNY*3ey#Kv{TE3%l^yTyIdeXn&}MACh) zc3Xt*KGqE0vhG`1$@rZO>OE@H^?L7X-Qq3jy{~jzMACa->b3~od#qNyWxdx~L;LR= z)N|CH>-F4sy2V-2bN{v5B9fl_cDF_7o@1T#E$g{<>g~kf#)v;^$@Thd40Wwj9UJMk zh@{U3yDdWctj>3k=jdWZy1T@~1>45lglaVdeZ@KM^edF=IF1A9*qWtVS0+f~YP!-rh(`I&_gv`Xp0#}4D-{_e zN_$OP!mo3tU2SVKrbnbO0Onu{()Pa^N7^ zT%dY!N1*THGDyA_uAx4I#z#FkNeGw3C1wQaow!aiz`>!mQyOUH|e} z5`t^|dgVSD!moRJj_%XLy@3^+MdpOuj$Zv4$M>1*>L{ABD7rBRy>o_N^=NCMTBSI3 z8Z@Rphc>Et{EJUt;#RA(2%1;t=t&nuqJ>Y?o}k-5N3g91H%o@j88nq|d>k?%$7+kX z0a9JytWWZj6#04eA^cxfPvMEXDL%|EsAJzp)w)$~-T+G`1p!C)1rigf;zgv27m+Gn zM5-4X^?I~L30*&pB0;CUa+6Mit8G}-=5kwgieX&KlfyhS_mSkKik7*aWv*tKYgy(> zmg|gj_vZ*ADMG!#bxB`rrSticI2}mWqa!e)m350gAInEo=>npjlAU*OdnP4GE+bdh zP%hRH3?T{Z9#4V~sI%CJE&DZpGttUkw3waGPj z&arFQ9C!w6fpx8!s?w|A33Y7eS#x!55XR zi+{PnJ%l@Q9lCw=MIwqGuS{EH(R7VUy6_fPKt7InXc~_fa4z3*x}%jT{#pZLtXN{+ z)KFhQ(b4d6|4OCg+eOL|NU~@g`@ne(agK}6k$Df2>nGaJY39N=(9@lyG{r)(6JVr- zC2&dLHW&L>qMNc2R6Bu2Er@ny~>z}E9K{|{Yqy-WZA literal 0 HcmV?d00001 diff --git a/build/.doctrees/index.doctree b/build/.doctrees/index.doctree new file mode 100644 index 0000000000000000000000000000000000000000..2a54f810e5b69995384cf9b333b2462c6fce195c GIT binary patch literal 4971 zcmbtYTW=&s751(@;~CpCzHD{{>~1tdA?qZJjSvsWQlvm4qG-W_XhmL@^wxCOOtsxN zs;bvxZc30gV5qk=@E3SS2oMqyF9?ZW5=BTzJoCVJs`}oOn{u!%a71c%?4Hu9`5j!L*j)B-hZAv|0@V1r5x)A2Fps z#P?3ZV)v~VfHU9%Z&6=GZ57F(w8)g}|GrdwI+({CO$jn z@wsg}_A00b?PX{c+CMg3$ytDBe^4BoL7WD8#MPlDlUvemMN;Q+%yG`Q`#8<@|;%nUWVm1$WrUf*Fd0A%NX!@_GiN=f65ezVk(n)b)x*`k$ zAnC#kN_jP*m*nw;OCA*WSImaRjY^Z~9K0I)_h|%t`Oi5%PODL zyo7Gc3v@5?mVTpqH*oK2bFT%+ri;QRigqf3*?TJqLZ7PoJ= z_+X?-ybny$-sg}L@}K{w^C*s{6t zQc>7Lm{2MnBNd}6*i_tRi}p= z%L8TW2jwNtQi+*VFNr$1244JC`>-E@dh`0U$-_O%TV_i=i%Tr@6i? zrDLTO=I+AIf{2rEU0Yc(LnpU+Lv{Mj<&A~IW`}eD!jyoCBIs0@LBx_-&So4I53ufj z^IQvb{N{$_ekubG-5;tquA=4>ou{8BQ>Y57gaJ^Brg2_~t{Jjir(Q!c*Fykn5ae;@ z)!>71Eg?knC=(Wuz->#h&?g8qq)hQVNWFPXu-ZYbO%?arCoNKZ?L7`v=wQ0-1)-vV zg)-$U*Q=mFfNen;g)nfP9gtJ9c~#?UZqYYfqPV0+7hWc50o=ZcKDAx~rn?kbKupeuXq~B}!$XkOL1vA8kjmL%VQvzq zeE>K;bY5_ghD&;&k3aW?FTtKeIrSIB6QvRVVkI5{%LuloTpom6PwgED{X?PS2$%Jd z*bqqpb@n}T7r2bQIz(#)Je3hjF3gTPPc)l*BAkf`A3OM@1ph4+GX&drbHuiSp>Ei< zTY6FIGdEM1yS_k==)>_Y=3r%OLYzL$Gh9K_ryUK-T!1+OlrWhB166X^qjaJ2$pT*( z6M&Q;(yqi#$xqlw$3(cgs;1V2!3OwOyE1 zo;)tlOqrfbDTrY}k;(&tLwl~vv(x4-9tCJ=WLCfiqZB1>vv-N=W>AnJZCWp=Y^Nn~So_9gK;{ zB|b)J00!N*pJH6GzeS*?tiN8;KZMnu6mKIgFn=JzFz_oNfiA=_K2+xlQB+Zz>Q?`V zQFmhIGY{y;j1eYxE(w+x^3stKC?f~e7`BY1noUlA4`(g*X6*sP^*OgseoIcJUknBj zW-Q4fZ-Q7kZN1UFcGa&b8?P?^s~-OU3#!%o>lNymKGOA(OB%>qh%PQ4bLzQH{(_^z zDNfzj(x#|Wm+mz;bFIJgmA8-II)1bHxuyPb2BIMSH&%Lk(5Hc$nZ3HOR4}k;+^oqq bq&LeSERaHG^xM%!K(((d6Es%klY@T)w%dCG literal 0 HcmV?d00001 diff --git a/build/.doctrees/modules/asymmetric.doctree b/build/.doctrees/modules/asymmetric.doctree new file mode 100644 index 0000000000000000000000000000000000000000..18bc33dd778799ca5d9fab6211dfd64feb9e0568 GIT binary patch literal 3497 zcmd5;$!Z)&7`82qq!~%0#R~y1G$yg+I2r|$Lzr6#NeIHSF^*3%O?7w8RC&6qI#t!u z%)yWx3=!1Loon(WNg&B<81e)mkC3l=n}saC1R@yJ_19nj`u)pSt#7~EyiokvEuAth z#yt{6LPk{Qb}f=&mQZ2xSNYwq^B4KPZ7Xu7Wu`)!+Y8_b8IL1HMgAW$4`h_#w&GoWLdVXAzhZfrJHzZs zN??V_*^Ul~?GOVoL1y5EvwDd~+F7_7#zbon@!b+6DZkdDES(+#5{?udIG)U|8ZvZO zIoo2_*@kWVO-R_1U8y5+=d=FF6C$4Tlag|h6!z;w(zw)9+T?aQ=7Q!&m$HDc8?cPs zf+agsu7mPnPMC)%-JZYnn#;Fwc?b5feb#|pOYAOw@3MRBy?N2K6jnWGEN1uY6{CpI zF>wjM~j_BMpi3qYJiE^Uw&#%;~#myJ4nWto_RSW4lpP3h$2Xnx@8ZF$9Em z8cYn76o!fjxq3?C456<<#kP)Zdq@RU#7LFn5D{d~kR-)ny;S2v_6WyLb<9+Z)25N3 z?=t3Yp{@nH)FijN11XJ=hR$3bU9_7HkRnU`@j$912c@e4l++I;kSC0W$m=DA#U?Or~q5mTg5e$c9kYJtImW zR^U*SB%rhr^pHBI@^5UHi!?Jn6`_p4mD_e^1_vJ=XpZk2^OrtVN-Ccb5yey?&d$^j zsN0g6nU~Tkq~!MI!p(vRc4E7w(5V6S(;M>_3oq@qa{%zt4DpHKP;NJ4B8C|mQiMCg zdF9c>FmwldSVlI$f8RBc9C zlKKtu5ZQvj0Xii}>;!HVlmgQ(|5H+`X%fHLu$`fMEVb?Q)ZZnyPB7&7)5AF>#~qHRit{SBQERN9vr3R@#k zmy2_G^kW&4DzrC4Mqm#TUltsqT!av>M_CFLZc-KVr)mV}K#vT$7ytuxXV`VULTAAO zA5R>BV@b+#bPau!12aiLBh>H&CNN43lw1wLHS%dfc^i@YJzuA3usBPO3%p`?{FLHMOT(evFf5&U$97zPCojpGOnRtU6fVbV3?s}gfeseAh+wG zjAH~AK45IDeq7OC!TFc@W1t`V1nLMIf=0fb!hI|)T|Ln#mYO`BVAH*(jfZ5YNXlkz z?e~wAM0F>ga{CQEMJxBp%<@y}6+_FzfK0r)MOL%kJC=g>y*>Bu36itt$>2H6_88Hg zkY2OrczcaFz1QnJQ4^=)wu@1@HQe^_A|yfzjyjo9?(*I%H?3>`e>=-{4?EAV*z=kd zYH`nTi^|Vn`e}C0T4b`VYGhxu%MSS1&OSf>^kK84EzfLAPT&u21Dx5kma~BUSgytO zUc1kJsR{P&FT_a5Gcgltr)4fDP2As%xpDrtH*x+o>}zA_asZyhet-r!n#JVPUeBB2 zqu=+8+hBXsWwhgYUO#c2P3eAd$OPKt!5m35d3L}BqY5nnbEscK>Aw=+1mTZ=3W9B8 znD@((f~khyOVueYHs;@v$JcIK&I0YZl(HW{0{@>8C3h8#Y*){5x iQM9i0hFo;{buPj(hE#R~y1G{&~%I2r|$LzrtwLJ*dXBj+U3RCm`*m8ZL^Q&laE z4u<4lh@funkYk=C2_$(9L!Kby5%N`UvyjD?Km>!j{`%`*zkm6v_3d|^3&o$^&?)0$ z+#^vWWJGmtS0Wi^2^A)Po!|dDf0^&vwj!rmW-6q)y#S7o@ivnl z)-*I+ism_Mu_dc(z;ZdkR&XtZRSz0-*#mpUC?a%B zTyFeS$)TdU3{}fWL*o44f?ch7XoO?t^j);wFjFqje&zb1U9TyHZ-;h8Q)9Ro0zF#| z90p1XLq&u{eL><3aj)^jHV$ojNCj2INR{Id5v0wKB*kH^RO3VT2*=gxn5h`2j*+47 z(&cWUt_8c)S#GxnQW_x*ow_`@XgdyzB1`=7K&m7MrK^FG)DI<4Cya*3>m`N8w4nH> z+%Ufe4K!8{DipzaMN_GaAJY?xpk1=7jKs~cWw+>i8e*mg^y69ej}H)b#9UfNCP0N|w=;uFK6+;(Cjh8Y=Bgge4{ z>B*U4XbkqUqM=lgAJG&5fhrDk9NMK&iUIsYNO%N@(g7dmY{_;>W~4tM*-IR#>O@(R z`VI0B*@D0UIweT#1a1_R0@E)46H=;a7D<1cI81HQaVj4FRxZ~Sf$Ca^Ga5Beloy0{DmH(>&ezahk@4~fjBdHI z0(8U>NQ`;HP5x+e$97Yi`Una|F@{CJ)*U4vu-#RMeTNy7>i+&d$hwyn!R|>l+|TV* z$5|KvPT$Z3DKbdO3g~-x-~Ryd?5aUHC*Dye;_ubsQLV&bc0^T=Q!^-ZpzimXNn$8# z8xo+5BE#~76?+q)O#G%k8wY%yI+UEdW+)69`-~4+j9<|-rNjQZP6#UP%M69B5va?> zxjg!@3`rH*n;|2x2Z=8W4pA;bh}WYmg$g&MiqTUwf^(ophFlDQfx0tnyI!HQV2+O` z4#2S_WjVTbK0*VhNkAji@EJ^Clo}|x8iH%&(}eKY$2@iYwJ>|Dnuq{vJSh9xxm}>* zBtOgoyHfTO6fmI3MZ{4Y#y3O_Df$xz!WN7Iv<#*!I(Ove)Jt@{8EQGpK!&tIb69dE zgfR&EvLlw?>>=CNw(SV!EQN(HbN29Dvs?JT&(^i=Oed>&-3d8T?$kqKNpUq<^Oa^! zQ%XJyVnT75z1wf0aK4`ms!)j<6nReMz11Ui=2YBvF)Fu)+a6woL`cC=CsWE@-h1Vib?yIeXSwTP=lK;&Ub8^W z?>TN!`58<bHAOtw{x?2C5M0Ux{BXNR9WZdSC#scp##{K2h%Q=8Ue7O)@7jksQE zciAsB!QOc$Mnay7sZcvDGdXGE{&vib^S`}~^KW2Z8$*`^@FeyFG|163CZF|s-UJ{0 zzGvL}+G|$PRnPPKiEC_1_lrX&&?Wa~NSevhJuVnk=m;1?{TfOCk@O}6fBaJjY#XDz zUk((^G<067PH3?&|Bfuaal3LB(7(k`1C50m8m*6?K7EY7P_6I(hK*%Nx7*F8Q8$dD hajiAvqQ|ds5yn~MX3EgD_tnTPL)G5k;FblwKLO1}Sa|>d literal 0 HcmV?d00001 diff --git a/build/.doctrees/modules/tanji.doctree b/build/.doctrees/modules/tanji.doctree new file mode 100644 index 0000000000000000000000000000000000000000..8c8e2a27641405f299d6f7a3394459357aa4b577 GIT binary patch literal 3462 zcmd5;$!;7)7*1l3?XhRZOBNwzQ4@vOA$W`;4rs0j5VGQgC~$Jrs_w3ts!VrPQ&nw` zg(ATr5|-+g=FF1-67U+4cml*D@KtZKNI)(~ShC&q*I)no{mVD4@4xO|D1PjwP8k=I zK8YeBBdT+|7RfM6s4)4f{NA_ui+sdk3{p$Uy zrlH|dG|yR!t+3T+IcwXN;U=atH@5SXi09mUD5DG)72EPtI&tb3ZeQlk9J`Vd=r%dq z)&a5W#2Cec%)oYM>k^N&vuibsiPj+EyCq0ceyv4WIz0p=94k6>JegfJWaO@Lw#lxu zj&1u*AlQ;!sr`TZ)4_3J^KnTzP72fYfpL!Xl{UFuj=7-u;iW7f>;{Ztw_rr4VAwC& zbHY4Cdqf3Q#7LFn5D}!xkR-)nqg3NV_87X@k*r>>Eq?^5J$p{@nH z)LCwKhEf_K4V}3>ylA@)cOpyt$xx~!2c@ThjMNWh;^3?y@_I?3F)b+mDL2fofdY-y zg9VO* zdPtp9`FFO*MVc9(icm)2%56I{!~GBUHOKdj`AeTFC6&*Jh+?V`XJ={%tZmB7%u8t% zQgVB9;buVuJGQ-2=+uDv>5ch|g_m~AIRJQRhWNyAD7W31h*3sH6yc6=UU__G7@B~+ ztY|1zWcZpG#gd0e)cYwin5G*v|jQsJaU$oU3ZDKcIjfzfSOR)CHe0f{kB zxXB-G?b=>SQy)R0D8{e|SjSNU0^416*teK5sU930fUNsz5$wKHql4UDb)1C(;Peem zkRpSWtbxA&&ifxAo;@`T7sNZtRQ%mqJgSvA%#Nw*b83c#4%GbtGf50(Z9@W-QDj(t zxMptxl!@QeXXAjcQ-_jsyQR;BArqhR5sUF#G)w8Q-_Z#{rG1s5ur&g8xj2_cKb9e> zLVGi01oj~DWx*lJMF{bFoTX6V22wF*szz`Q^vIBlAuv#Ph8@={bQUb|@x%c*mZU64 z*T%;=Fp~r{LJgn61V*WWlB*%O#y(95kA2Ke*Ix^>x2x#~u*So(ubtZ^Do*mFEU;^3 zKS2Qlid;k-#bJCy)QF-#VHj+~C_u|#qM~z0ZZ^F@$D5;;^9y818#ad(S3($lpszY& z`OO}%18v)mV9rul_#$Ty&NaJ*{|Bt2ZFe?V#p`a!k#eUV5=)A!$(pY;bCy!_!FVJ$ z31r;lzhJ$xKy0|%a}wLN*5c95oP6|GWn4qQx+trwLd&o64jk} ziUR)h1g+dFGs{n?R}3u=12XaI7Fo@D???(d@OIt5r%2AOCxhoO+has~LVC?&z?Ng64%s}9u$X6phND@ku;O1`&=-p&70%0#wG+pA_K`MBlLF2*cIbn)iYTgS+|(p7C22!M8z!?ecXwtyJF}g+ zlh_rNTGT>|E-KJLAS4tCfdC0qAqo=W7e7G=#H&*I3BUM(hy+rFDj~je@4URbUXPok zYDJ_ZyZ3d@J@0ew*=L8ocKE&x@{iaab!^99nlUWP4=ffXV$=%ExXpZ?ypkMxE_o)I z61C8{6a{f;vP5ja3e$ExD`b9hJ`oeNoI74LlkOjhn8}^M&$rt{_OLy2KAEy>Vu(B3 zW2GrEe3}_nn@Qq;L^ zaIF&t7ad3rR)X_!$TY*Zw5G?FoQB7=DDWU2*xwAo{0zS(7gMw{oF z$1XBZ5ob06ZfntUyUoCFQ*JVfuO*Z?Gi~2_D#jij08T`RaGPmn;5UJu&mF^a__930 z@i}XS^et#=%MfhMGPp65k^cYl^0^Rww1N=X4?uJ__Z6MVg9o*TnZdz;2*Ul%XEU<) zPUIj@Rs}g!0$CH|jo9-T*F6V%m|3f`xv9~N?r_#FO^c`M^)tCh6&iW8Ue_LnC3Bu8 zA%f`4S{Du9WL8;g&u~b$5n9^R?A)0{n&Gtq2$J2F;$2AQB3sUdJ@8Y>%GJv@GkZ83 z@i6dPW$bQR6}ya(d-`IZukL~Tkv2dXXn}-FIbMW(`RP8xt3b3V&@v%`=a8Wlf%7vb+{SN z_V!1tVA{)7m?k9CKB8UCWpc)ds*D*0&0oAK#ynB4f6R#3z4wqR1(xHtNZIC^O~-U# znmws36nyuXb~1cR%16UnaZpDme05 z6^{H^a^(26x=YTSA6I2g4b1t`RWavWy?z4b>QTc9wd2f(=Ouql44RF3(8f2@@W7&$ zngf$ahe$^{*b*trr*y~++U?lKdOD$pGk@yl%#Eu-&bYI?A7TZE-l)Q%*CmG@yz0y3 zta-gEYsSEuKU@`SPS)$E;ctSrHt#z!f_Yk!Ry&IrI{@vc=Fc9IehWdb2Ca}w&!#bu zP2NidWr%fp*zuokc6_iRw2V6kE8tcz>%Uc)^_FDT`?bfb+$ZPATU9wS4vxHeRUG+D zy*>v^Mu8)6B+{R8;8|4A3ukUPEt|toU7{F);>@sVfC&|Y-!VnnJWvqluPZnSZOSej z*<7b z6^bTe_PLdIPz=}-l-H%tGJ`z3| zTuqelcp?j2vb?;Apq_>a2pVz3wKHVVVKzv_RWjHK9g21H@K|Ph-AROx#w}aZVLrh-iuyFvdQkLLOdE3D21Td)umV*M|s%30pv<%0Gv5;k) zK$g9zO2av7Y`y&c9xm3+?}HT(%@q87Yh0<&_a91<4<;c=!4D*;#hEl}HZ0%v$o$>X!qlWGqXyRLv|R>)k<+*+3yAEtmD=T$*8qK@@40bX-W_VCW+h zS$bLi8{po}^0%3fxxbfm8%zgc>Te~zz|=F>4!t)&Xy-V^fBmU%Lgk_{A@6!&6sbd^Rnd0jL3netIDUru@WBx?VJ5lek2B86rK9c{lGI$e{PJ@dlB^+vEJM-}fg;E5wRx9roQR|)aa6+h2sG#lW*qC6!wiIqoWSL`0nZ+6!@ZgwMBIfM1cfT(8e1?HmuR2=XX?_m2glzTD8 zOpiX^I&ir{za~at!$Cx^R9|)<0VZUUVIXf(MCt>vklB-KU)23L9l6haSl+Q3w{OP! zkFCAleUOe;DGY5%CSFY3orZUu#PhVqN zGeikSijRgcHwd}f3_&}n%`F+S0Pr}yUyY@!9#9LW4vl3|6y!L4<2tOFPRC|YrzNgE zpf=2;;c~WS>cAt+^Mb?bnA;BEob<7*I49qm&g6U3vx=2vh=+hQGC7}59r#4(v>e~? zv{UNw?dXBSS})vmF$%ZzatRYqTHON)c&6)*skgnA>wE5i^|^GH)$z798I);gg_XI| z29S!X=4d~pXi*BNJB$Cal=&Q`l0Z3?j8z4rTP~FF6k^dsxiXJ(&Zet!&h~JphoJe^ z^$Nv$WMZ8nu}+ETFA!_eTnYsB7>q-Q@$xJS*CoRzHeI-o2@QSBrQ!=+QbFAWcO^#m z^SKy8*MMUsG<_%4c-$AT5mNG;l9JDtq(p4YLE%#l=^K3@-7^@{-Mx@txc3hhzXBrR zRyE?#aF=J~T}poO)%TbnXB>Xd;hhV~Pr8JpTMpAU4q4SZ*pFpjdRM7(s+N1j7vDW- z75ec@No;q8?yhDhe$~YoG6eSy*4_`7wU=PUjTNxmZ(=MB#>$4`FMUAWKN!?~y`Tn% zNm<-ImCMk;_2o#6EQRuo1Gn^##8%%TMk(m$%N?|t4Wo^!;h5C;MP_#?v4_!)730Nt z2{rZ^dD%lmyfkr1W5gQ~V;8R{yOF>=6!@xDjItP1*uRxoi2jqg8jftP9xF^|Sge44 zyZ{~eXpcfe(k14hyuxlngADT!RWiI~2U-+2+78$7o=xpbc;xP&tp#N^>SjVNo*{hA z&dcw(XB~Gu()W(rLE)2*iP{kZabI~p!?kBThk0-vFz@UO^Za8r`qI)s9aPgig@C2S zzQsaWeLgk+SdP~;o=meWZw~ z@owrP(i%Q%c+i0&h}*s(YH1rn5GMG7CK2ce5-@xjS71;s@E7rQEd3gX9=>hkfvHpL zC(Q!f5bz3@6S1=y1l&h1UYb0yQEa0oRv06F39`{nFfxJ1U8kc{hXb}oIC7sFVF)#8 zM8D*4ThAI$0WsZ>cBJC+A*0k$r|w1&ZIc+Y4KM#XBzB-<613uIor|(XLt@BcjkpDH z6L?alM>VVf!`m3Cf#@cqOC>Lg3CHimTt~(r`)d+Wi+OYU{%O<&6LHJRNu7mZ5b7xD zTOJERXF}CPE9>?k<||JblBXo%)~=bZBU~S1EGE>s1rFKnTUJhVZ5ESshX{nSK_U-# zO2jtL@LMr5YEaxFf1vX7MC=Ng8HAQ@u?}Pepd1Luf*6*4orQ}UXO&B4%{wBq*#*(6hobe#a5s%wMncd*-|Hnm|or~CB@|W zMJIC5q(NutmJ=DsNpKl-qY{=QnNmQ(w&F4os%%ojFt;sTrjv1!z07;*6M&$sOPw{~ zGM#3D?c-?8&c8xTcaUa5di)lI(R1Kel2el(6cZiR(LodjeZ*TFfNZ4^)X11l3LFQit*|9f9M|2b0Tb-UB}Z%ar_6e zT|+M0^=2 z*o<)i*<)hWqK>51@pSa!lZgd>FNz&>GO;{jUQ?O2m&9h~Urf;YC`Oe@feu3y9p7@G z99&1Kw#8tg&;-8&NI|r?Y{7<@q3s>b^gCCKs@8Z6w|^HWS_^(WP`Q6kyNlw{HZ!R}Fo zPF5BvjV6CGVUAn z&p|$qyt<^g5AH4n0KrFVEU7xhY+e`-zlpF%IT8&VI zldV%mzdWMW!4<$&wi|($dsDe|ch_LPy0+rPS_V~a+PUI .section { + text-align: left; +} + +div.footer { + width: 940px; + margin: 20px auto 30px auto; + font-size: 14px; + color: #888; + text-align: right; +} + +div.footer a { + color: #888; +} + +p.caption { + font-family: inherit; + font-size: inherit; +} + + +div.relations { + display: none; +} + + +div.sphinxsidebar a { + color: #444; + text-decoration: none; + border-bottom: 1px dotted #999; +} + +div.sphinxsidebar a:hover { + border-bottom: 1px solid #999; +} + +div.sphinxsidebarwrapper { + padding: 18px 10px; +} + +div.sphinxsidebarwrapper p.logo { + padding: 0; + margin: -10px 0 0 0px; + text-align: center; +} + +div.sphinxsidebarwrapper h1.logo { + margin-top: -10px; + text-align: center; + margin-bottom: 5px; + text-align: left; +} + +div.sphinxsidebarwrapper h1.logo-name { + margin-top: 0px; +} + +div.sphinxsidebarwrapper p.blurb { + margin-top: 0; + font-style: normal; +} + +div.sphinxsidebar h3, +div.sphinxsidebar h4 { + font-family: Georgia, serif; + color: #444; + font-size: 24px; + font-weight: normal; + margin: 0 0 5px 0; + padding: 0; +} + +div.sphinxsidebar h4 { + font-size: 20px; +} + +div.sphinxsidebar h3 a { + color: #444; +} + +div.sphinxsidebar p.logo a, +div.sphinxsidebar h3 a, +div.sphinxsidebar p.logo a:hover, +div.sphinxsidebar h3 a:hover { + border: none; +} + +div.sphinxsidebar p { + color: #555; + margin: 10px 0; +} + +div.sphinxsidebar ul { + margin: 10px 0; + padding: 0; + color: #000; +} + +div.sphinxsidebar ul li.toctree-l1 > a { + font-size: 120%; +} + +div.sphinxsidebar ul li.toctree-l2 > a { + font-size: 110%; +} + +div.sphinxsidebar input { + border: 1px solid #CCC; + font-family: Georgia, serif; + font-size: 1em; +} + +div.sphinxsidebar hr { + border: none; + height: 1px; + color: #AAA; + background: #AAA; + + text-align: left; + margin-left: 0; + width: 50%; +} + +div.sphinxsidebar .badge { + border-bottom: none; +} + +div.sphinxsidebar .badge:hover { + border-bottom: none; +} + +/* To address an issue with donation coming after search */ +div.sphinxsidebar h3.donation { + margin-top: 10px; +} + +/* -- body styles ----------------------------------------------------------- */ + +a { + color: #004B6B; + text-decoration: underline; +} + +a:hover { + color: #6D4100; + text-decoration: underline; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: Georgia, serif; + font-weight: normal; + margin: 30px 0px 10px 0px; + padding: 0; +} + +div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } +div.body h2 { font-size: 180%; } +div.body h3 { font-size: 150%; } +div.body h4 { font-size: 130%; } +div.body h5 { font-size: 100%; } +div.body h6 { font-size: 100%; } + +a.headerlink { + color: #DDD; + padding: 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + color: #444; + background: #EAEAEA; +} + +div.body p, div.body dd, div.body li { + line-height: 1.4em; +} + +div.admonition { + margin: 20px 0px; + padding: 10px 30px; + background-color: #EEE; + border: 1px solid #CCC; +} + +div.admonition tt.xref, div.admonition code.xref, div.admonition a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fafafa; +} + +div.admonition p.admonition-title { + font-family: Georgia, serif; + font-weight: normal; + font-size: 24px; + margin: 0 0 10px 0; + padding: 0; + line-height: 1; +} + +div.admonition p.last { + margin-bottom: 0; +} + +div.highlight { + background-color: #fff; +} + +dt:target, .highlight { + background: #FAF3E8; +} + +div.warning { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.danger { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.error { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.caution { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.attention { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.important { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.note { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.tip { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.hint { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.seealso { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.topic { + background-color: #EEE; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre, tt, code { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; + font-size: 0.9em; +} + +.hll { + background-color: #FFC; + margin: 0 -12px; + padding: 0 12px; + display: block; +} + +img.screenshot { +} + +tt.descname, tt.descclassname, code.descname, code.descclassname { + font-size: 0.95em; +} + +tt.descname, code.descname { + padding-right: 0.08em; +} + +img.screenshot { + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils { + border: 1px solid #888; + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils td, table.docutils th { + border: 1px solid #888; + padding: 0.25em 0.7em; +} + +table.field-list, table.footnote { + border: none; + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + +table.footnote { + margin: 15px 0; + width: 100%; + border: 1px solid #EEE; + background: #FDFDFD; + font-size: 0.9em; +} + +table.footnote + table.footnote { + margin-top: -15px; + border-top: none; +} + +table.field-list th { + padding: 0 0.8em 0 0; +} + +table.field-list td { + padding: 0; +} + +table.field-list p { + margin-bottom: 0.8em; +} + +/* Cloned from + * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68 + */ +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +table.footnote td.label { + width: .1px; + padding: 0.3em 0 0.3em 0.5em; +} + +table.footnote td { + padding: 0.3em 0.5em; +} + +dl { + margin-left: 0; + margin-right: 0; + margin-top: 0; + padding: 0; +} + +dl dd { + margin-left: 30px; +} + +blockquote { + margin: 0 0 0 30px; + padding: 0; +} + +ul, ol { + /* Matches the 30px from the narrow-screen "li > ul" selector below */ + margin: 10px 0 10px 30px; + padding: 0; +} + +pre { + background: #EEE; + padding: 7px 30px; + margin: 15px 0px; + line-height: 1.3em; +} + +div.viewcode-block:target { + background: #ffd; +} + +dl pre, blockquote pre, li pre { + margin-left: 0; + padding-left: 30px; +} + +tt, code { + background-color: #ecf0f3; + color: #222; + /* padding: 1px 2px; */ +} + +tt.xref, code.xref, a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fff; +} + +a.reference { + text-decoration: none; + border-bottom: 1px dotted #004B6B; +} + +/* Don't put an underline on images */ +a.image-reference, a.image-reference:hover { + border-bottom: none; +} + +a.reference:hover { + border-bottom: 1px solid #6D4100; +} + +a.footnote-reference { + text-decoration: none; + font-size: 0.7em; + vertical-align: top; + border-bottom: 1px dotted #004B6B; +} + +a.footnote-reference:hover { + border-bottom: 1px solid #6D4100; +} + +a:hover tt, a:hover code { + background: #EEE; +} + + +@media screen and (max-width: 870px) { + + div.sphinxsidebar { + display: none; + } + + div.document { + width: 100%; + + } + + div.documentwrapper { + margin-left: 0; + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + } + + div.bodywrapper { + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + margin-left: 0; + } + + ul { + margin-left: 0; + } + + li > ul { + /* Matches the 30px from the "ul, ol" selector above */ + margin-left: 30px; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .bodywrapper { + margin: 0; + } + + .footer { + width: auto; + } + + .github { + display: none; + } + + + +} + + + +@media screen and (max-width: 875px) { + + body { + margin: 0; + padding: 20px 30px; + } + + div.documentwrapper { + float: none; + background: #fff; + } + + div.sphinxsidebar { + display: block; + float: none; + width: 102.5%; + margin: 50px -30px -20px -30px; + padding: 10px 20px; + background: #333; + color: #FFF; + } + + div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, + div.sphinxsidebar h3 a { + color: #fff; + } + + div.sphinxsidebar a { + color: #AAA; + } + + div.sphinxsidebar p.logo { + display: none; + } + + div.document { + width: 100%; + margin: 0; + } + + div.footer { + display: none; + } + + div.bodywrapper { + margin: 0; + } + + div.body { + min-height: 0; + padding: 0; + } + + .rtd_doc_footer { + display: none; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .footer { + width: auto; + } + + .github { + display: none; + } +} + + +/* misc. */ + +.revsys-inline { + display: none!important; +} + +/* Make nested-list/multi-paragraph items look better in Releases changelog + * pages. Without this, docutils' magical list fuckery causes inconsistent + * formatting between different release sub-lists. + */ +div#changelog > div.section > ul > li > p:only-child { + margin-bottom: 0; +} + +/* Hide fugly table cell borders in ..bibliography:: directive output */ +table.docutils.citation, table.docutils.citation td, table.docutils.citation th { + border: none; + /* Below needed in some edge cases; if not applied, bottom shadows appear */ + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + + +/* relbar */ + +.related { + line-height: 30px; + width: 100%; + font-size: 0.9rem; +} + +.related.top { + border-bottom: 1px solid #EEE; + margin-bottom: 20px; +} + +.related.bottom { + border-top: 1px solid #EEE; +} + +.related ul { + padding: 0; + margin: 0; + list-style: none; +} + +.related li { + display: inline; +} + +nav#rellinks { + float: right; +} + +nav#rellinks li+li:before { + content: "|"; +} + +nav#breadcrumbs li+li:before { + content: "\00BB"; +} + +/* Hide certain items when printing */ +@media print { + div.related { + display: none; + } +} \ No newline at end of file diff --git a/build/_static/basic.css b/build/_static/basic.css new file mode 100644 index 0000000..30fee9d --- /dev/null +++ b/build/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/build/_static/custom.css b/build/_static/custom.css new file mode 100644 index 0000000..2a924f1 --- /dev/null +++ b/build/_static/custom.css @@ -0,0 +1 @@ +/* This file intentionally left blank. */ diff --git a/build/_static/doctools.js b/build/_static/doctools.js new file mode 100644 index 0000000..d06a71d --- /dev/null +++ b/build/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/build/_static/documentation_options.js b/build/_static/documentation_options.js new file mode 100644 index 0000000..372a955 --- /dev/null +++ b/build/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '1.0.0', + LANGUAGE: 'Python', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/build/_static/file.png b/build/_static/file.png new file mode 100644 index 0000000000000000000000000000000000000000..a858a410e4faa62ce324d814e4b816fff83a6fb3 GIT binary patch literal 286 zcmV+(0pb3MP)s`hMrGg#P~ix$^RISR_I47Y|r1 z_CyJOe}D1){SET-^Amu_i71Lt6eYfZjRyw@I6OQAIXXHDfiX^GbOlHe=Ae4>0m)d(f|Me07*qoM6N<$f}vM^LjV8( literal 0 HcmV?d00001 diff --git a/build/_static/language_data.js b/build/_static/language_data.js new file mode 100644 index 0000000..250f566 --- /dev/null +++ b/build/_static/language_data.js @@ -0,0 +1,199 @@ +/* + * language_data.js + * ~~~~~~~~~~~~~~~~ + * + * This script contains the language-specific data used by searchtools.js, + * namely the list of stopwords, stemmer, scorer and splitter. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; + + +/* Non-minified version is copied as a separate JS file, is available */ + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/build/_static/minus.png b/build/_static/minus.png new file mode 100644 index 0000000000000000000000000000000000000000..d96755fdaf8bb2214971e0db9c1fd3077d7c419d GIT binary patch literal 90 zcmeAS@N?(olHy`uVBq!ia0vp^+#t*WBp7;*Yy1LIik>cxAr*|t7R?Mi>2?kWtu=nj kDsEF_5m^0CR;1wuP-*O&G^0G}KYk!hp00i_>zopr08q^qX#fBK literal 0 HcmV?d00001 diff --git a/build/_static/plus.png b/build/_static/plus.png new file mode 100644 index 0000000000000000000000000000000000000000..7107cec93a979b9a5f64843235a16651d563ce2d GIT binary patch literal 90 zcmeAS@N?(olHy`uVBq!ia0vp^+#t*WBp7;*Yy1LIik>cxAr*|t7R?Mi>2?kWtu>-2 m3q%Vub%g%s<8sJhVPMczOq}xhg9DJoz~JfX=d#Wzp$Pyb1r*Kz literal 0 HcmV?d00001 diff --git a/build/_static/pygments.css b/build/_static/pygments.css new file mode 100644 index 0000000..57c7df3 --- /dev/null +++ b/build/_static/pygments.css @@ -0,0 +1,84 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #8f5902; font-style: italic } /* Comment */ +.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ +.highlight .g { color: #000000 } /* Generic */ +.highlight .k { color: #004461; font-weight: bold } /* Keyword */ +.highlight .l { color: #000000 } /* Literal */ +.highlight .n { color: #000000 } /* Name */ +.highlight .o { color: #582800 } /* Operator */ +.highlight .x { color: #000000 } /* Other */ +.highlight .p { color: #000000; font-weight: bold } /* Punctuation */ +.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #8f5902 } /* Comment.Preproc */ +.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #a40000 } /* Generic.Deleted */ +.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ +.highlight .ges { color: #000000 } /* Generic.EmphStrong */ +.highlight .gr { color: #ef2929 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #888888 } /* Generic.Output */ +.highlight .gp { color: #745334 } /* Generic.Prompt */ +.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ +.highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */ +.highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */ +.highlight .ld { color: #000000 } /* Literal.Date */ +.highlight .m { color: #990000 } /* Literal.Number */ +.highlight .s { color: #4e9a06 } /* Literal.String */ +.highlight .na { color: #c4a000 } /* Name.Attribute */ +.highlight .nb { color: #004461 } /* Name.Builtin */ +.highlight .nc { color: #000000 } /* Name.Class */ +.highlight .no { color: #000000 } /* Name.Constant */ +.highlight .nd { color: #888888 } /* Name.Decorator */ +.highlight .ni { color: #ce5c00 } /* Name.Entity */ +.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #000000 } /* Name.Function */ +.highlight .nl { color: #f57900 } /* Name.Label */ +.highlight .nn { color: #000000 } /* Name.Namespace */ +.highlight .nx { color: #000000 } /* Name.Other */ +.highlight .py { color: #000000 } /* Name.Property */ +.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #000000 } /* Name.Variable */ +.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ +.highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */ +.highlight .mb { color: #990000 } /* Literal.Number.Bin */ +.highlight .mf { color: #990000 } /* Literal.Number.Float */ +.highlight .mh { color: #990000 } /* Literal.Number.Hex */ +.highlight .mi { color: #990000 } /* Literal.Number.Integer */ +.highlight .mo { color: #990000 } /* Literal.Number.Oct */ +.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ +.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ +.highlight .sc { color: #4e9a06 } /* Literal.String.Char */ +.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ +.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ +.highlight .se { color: #4e9a06 } /* Literal.String.Escape */ +.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ +.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ +.highlight .sx { color: #4e9a06 } /* Literal.String.Other */ +.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ +.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ +.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ +.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #000000 } /* Name.Function.Magic */ +.highlight .vc { color: #000000 } /* Name.Variable.Class */ +.highlight .vg { color: #000000 } /* Name.Variable.Global */ +.highlight .vi { color: #000000 } /* Name.Variable.Instance */ +.highlight .vm { color: #000000 } /* Name.Variable.Magic */ +.highlight .il { color: #990000 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/build/_static/searchtools.js b/build/_static/searchtools.js new file mode 100644 index 0000000..7918c3f --- /dev/null +++ b/build/_static/searchtools.js @@ -0,0 +1,574 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + `Search finished, found ${resultCount} page(s) matching the search query.` + ); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent !== undefined) return docContent.textContent; + console.warn( + "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + /** + * execute search (requires search index to be loaded) + */ + query: (query) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + // array of [docname, title, anchor, descr, score, filename] + let results = []; + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + results.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id] of foundEntries) { + let score = Math.round(100 * queryLower.length / entry.length) + results.push([ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // lookup as object + objectTerms.forEach((term) => + results.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); + + // now sort the results by score (in opposite order of appearance, since the + // display function below uses pop() to retrieve items) and then + // alphabetically + results.sort((a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; + }); + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + results = results.reverse(); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord) && !terms[word]) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord) && !titleTerms[word]) + arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); + }); + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); + else fileMap.set(file, [word]); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords) => { + const text = Search.htmlToText(htmlText); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/build/_static/sphinx_highlight.js b/build/_static/sphinx_highlight.js new file mode 100644 index 0000000..8a96c69 --- /dev/null +++ b/build/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

' + + '' + + _("Hide Search Matches") + + "

" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/build/genindex.html b/build/genindex.html new file mode 100644 index 0000000..2efc27f --- /dev/null +++ b/build/genindex.html @@ -0,0 +1,105 @@ + + + + + + + Index — Tanji 1.0.0 documentation + + + + + + + + + + + + + + + + +
+
+
+ + +
+ + +

Index

+ +
+ +
+ + +
+ +
+
+ +
+
+
+ ©2023, Anupam Maurya. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.13 + +
+ + + + + + \ No newline at end of file diff --git a/build/index.html b/build/index.html new file mode 100644 index 0000000..67b511c --- /dev/null +++ b/build/index.html @@ -0,0 +1,125 @@ + + + + + + + + Welcome to Tanji's Documentation — Tanji 1.0.0 documentation + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Welcome to Tanji's DocumentationΒΆ

+
+

Contents:

+ +
+
+
+

Indices and tablesΒΆ

+ +
+ + +
+ +
+
+ +
+
+
+ ©2023, Anupam Maurya. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.13 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/build/modules/asymmetric.html b/build/modules/asymmetric.html new file mode 100644 index 0000000..deea196 --- /dev/null +++ b/build/modules/asymmetric.html @@ -0,0 +1,108 @@ + + + + + + + + Asymmetric Module — Tanji 1.0.0 documentation + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Asymmetric ModuleΒΆ

+
+ + +
+ +
+
+ +
+
+
+ ©2023, Anupam Maurya. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.13 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/build/modules/symmetric.html b/build/modules/symmetric.html new file mode 100644 index 0000000..dccb599 --- /dev/null +++ b/build/modules/symmetric.html @@ -0,0 +1,110 @@ + + + + + + + + Symmetric Module — Tanji 1.0.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Symmetric ModuleΒΆ

+
+ + +
+ +
+
+ +
+
+
+ ©2023, Anupam Maurya. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.13 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/build/modules/tanji.html b/build/modules/tanji.html new file mode 100644 index 0000000..1dacadb --- /dev/null +++ b/build/modules/tanji.html @@ -0,0 +1,110 @@ + + + + + + + + Tanji Module — Tanji 1.0.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Tanji ModuleΒΆ

+
+ + +
+ +
+
+ +
+
+
+ ©2023, Anupam Maurya. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.13 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/build/objects.inv b/build/objects.inv new file mode 100644 index 0000000000000000000000000000000000000000..9b55c4b80585054177e5deb8a22fc78c51dc6724 GIT binary patch literal 306 zcmV-20nPp+AX9K?X>NERX>N99Zgg*Qc_4OWa&u{KZXhxWBOp+6Z)#;@bUGkZVQy+^ z3L_v^WpZ8b#rNMXCQiPX<{x4c-n=Ky$-@K421VSMK-2_SlN(R7?3JJVh)Mb1|>0ST#3Ft zG;V3i@0R$^-|1X}H(tX{1kx)j&tOHq6lFi1SLCeNcF%0IX;hslah$*^bRY=DQTmIS z1+hWZIPfINpwArY4>8v^9|Y#?P&XF(Ko>t@Aw%mNP;FG2{;o1&J-V6p + + + + + + + Readme — Tanji 1.0.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

ReadmeΒΆ

+

# Tanji Encryption Library πŸ‘©β€πŸ’»πŸ”

+

Tanji is a Python encryption library that provides a secure and flexible solution for encrypting and decrypting messages. It leverages both symmetric and asymmetric encryption techniques to ensure the confidentiality and integrity of your data.

+

## Features πŸš€

+
    +

  • Symmetric Encryption: Utilizes the Advanced Encryption Standard (AES) algorithm for symmetric key encryption.

    • +

  • Asymmetric Encryption: Employs RSA algorithm for secure asymmetric key encryption.

    • +

  • Base64 Encoding: Efficiently encodes encrypted data using Base64 for safe transmission.

    • +

  • Key Pair Generation: Automatically generates RSA key pairs for secure communication.

    • +

  • Random Initialization Vectors (IV): Uses random IVs to enhance security.

    • +

  • Ease of Use: Simple and straightforward interface for encrypting and decrypting messages.

    • +
+

## How Tanji Differs πŸ€”

+
    +

  • Robust Security: Tanji prioritizes the security of your data by combining symmetric and asymmetric encryption methods.

    • +

  • Key Pair Generation: Automatically generates and manages RSA key pairs, simplifying the encryption process.

    • +

  • Dynamic Initialization Vectors: Randomly generated IVs for each encryption enhance the resistance against cryptographic attacks.

    • +

  • Base64 Encoding: Encoded data ensures compatibility and safe transmission across different systems.

    • +

  • Developer-Friendly: Designed to be user-friendly and easily integrated into various Python projects.

    • +
+

## Getting Started 🏁

+
    +

  1. Install Tanji:

    +
    +

    `bash +pip install tanji +`

    +
    +
    2. +

  2. Use Tanji in your Python project:

    +
    +

    ```python +from tanji import Tanji

    +

    # Example Usage +tanji = Tanji() +encrypted_message, ciphertext = tanji.encrypt_message("Hello, Tanji!") +decrypted_message = tanji.decrypt_message(encrypted_message, ciphertext)

    +

    print("Original Message:", "Hello, Tanji!") +print("Encrypted Message:", encrypted_message) +print("Decrypted Message:", decrypted_message) +```

    +
    +
    3. +
+

## Contributing 🀝

+

Contributions are welcome! Feel free to submit issues or pull requests.

+

## License πŸ“„

+

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

+
+ + +
+ +
+
+ +
+
+
+ ©2023, Anupam Maurya. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.13 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/build/search.html b/build/search.html new file mode 100644 index 0000000..f88bec6 --- /dev/null +++ b/build/search.html @@ -0,0 +1,124 @@ + + + + + + + Search — Tanji 1.0.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +

Search

+ + + + +

+ Searching for multiple words only shows matches that contain + all words. +

+ + +
+ + + +
+ + + +
+ +
+ + +
+ +
+
+ +
+
+
+ ©2023, Anupam Maurya. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.13 + +
+ + + + + + \ No newline at end of file diff --git a/build/searchindex.js b/build/searchindex.js new file mode 100644 index 0000000..bda91b5 --- /dev/null +++ b/build/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["index", "modules/asymmetric", "modules/symmetric", "modules/tanji", "readme"], "filenames": ["index.rst", "modules/asymmetric.rst", "modules/symmetric.rst", "modules/tanji.rst", "readme.rst"], "titles": ["Welcome to Tanji's Documentation", "Asymmetric Module", "Symmetric Module", "Tanji Module", "Readme"], "terms": {"readm": 0, "modul": 0, "symmetr": [0, 4], "asymmetr": [0, 4], "index": 0, "search": 0, "page": 0, "tanji": 4, "encrypt": 4, "librari": 4, "i": 4, "python": 4, "provid": 4, "secur": 4, "flexibl": 4, "solut": 4, "decrypt": 4, "messag": 4, "It": 4, "leverag": 4, "both": 4, "techniqu": 4, "ensur": 4, "confidenti": 4, "integr": 4, "your": 4, "data": 4, "featur": 4, "util": 4, "advanc": 4, "standard": 4, "ae": 4, "algorithm": 4, "kei": 4, "emploi": 4, "rsa": 4, "base64": 4, "encod": 4, "effici": 4, "us": 4, "safe": 4, "transmiss": 4, "pair": 4, "gener": 4, "automat": 4, "commun": 4, "random": 4, "initi": 4, "vector": 4, "iv": 4, "enhanc": 4, "eas": 4, "simpl": 4, "straightforward": 4, "interfac": 4, "how": 4, "differ": 4, "robust": 4, "priorit": 4, "combin": 4, "method": 4, "manag": 4, "simplifi": 4, "process": 4, "dynam": 4, "randomli": 4, "each": 4, "resist": 4, "against": 4, "cryptograph": 4, "attack": 4, "compat": 4, "across": 4, "system": 4, "develop": 4, "friendli": 4, "design": 4, "user": 4, "easili": 4, "variou": 4, "project": 4, "get": 4, "start": 4, "instal": 4, "bash": 4, "pip": 4, "from": 4, "import": 4, "exampl": 4, "usag": 4, "encrypted_messag": 4, "ciphertext": 4, "encrypt_messag": 4, "hello": 4, "decrypted_messag": 4, "decrypt_messag": 4, "print": 4, "origin": 4, "contribut": 4, "ar": 4, "welcom": 4, "feel": 4, "free": 4, "submit": 4, "issu": 4, "pull": 4, "request": 4, "licens": 4, "thi": 4, "under": 4, "mit": 4, "see": 4, "file": 4, "detail": 4}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"welcom": 0, "tanji": [0, 3], "": 0, "document": 0, "content": 0, "indic": 0, "tabl": 0, "asymmetr": 1, "modul": [1, 2, 3], "symmetr": 2, "readm": 4}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Welcome to Tanji's Documentation": [[0, "welcome-to-tanji-s-documentation"]], "Contents:": [[0, null]], "Indices and tables": [[0, "indices-and-tables"]], "Asymmetric Module": [[1, "asymmetric-module"]], "Symmetric Module": [[2, "symmetric-module"]], "Tanji Module": [[3, "tanji-module"]], "Readme": [[4, "readme"]]}, "indexentries": {}}) \ No newline at end of file diff --git a/dist/tanji-1.0.0-py3-none-any.whl b/dist/tanji-1.0.0-py3-none-any.whl new file mode 100644 index 0000000000000000000000000000000000000000..c58e5065da6fb07b6569aa9e9e9e1bb1e66207d9 GIT binary patch literal 3977 zcmZ`+XH*kg+YJGN^iBw!& zIAGjdCG6~6F|Iy#cH*7^!~o+z0Nn^=Y8Vj!03`(g7=HmAyaUi^l#iFIBLOlSKY$69 zq|-dm`5v0g!&_#M-cTAgQM}0A{#J)Gr>W#>YcZ%M(yK#f^ zbRQpFnlH_H%D(6q0hq59ec$M%Iu$i_v}?DuHviNLxC_6ChP{9 zzPozZXY^QknWON)HauRn+b_pTT-=MR@A&5XuII2~rX=)~c}j?h6K?xxFotO*4~^YW zg4t+Nmg%KwZ&huy@T-O}z(FFSp}-WMcf-cnZqtP#49^Pn4g&MuQ$=*w**c3-d0u`G z4By{g-AxbjC@(33HK^b5^Zh1S;=6a;C(Cj35hQ!IPWB0X3=Qcx3{h1e8J_hjx6mJC zPRgV5s{G|*F%$o_76UJbF56}EH@JO<>6spjPw56K4OJn*Vz%u<5#5O|f+Y_9gWCLf z^u79g`j7VwMzarIx(BZ{Ro+~`2)md&WFMV+VpZXNMX?=AgI8GqmeMy^f)ZRlUE32p zXP--U{o_*)sR!5K-;F#E=-fBKe~NZ&)-1(N5DP*mx?iGsqa3|ZKHdbyDE)kCyr`oO z{O+4oBXvw@bq5FfMf)w*R)D9}PtO>B;Y&~-L;?UX{3iMz@!PNlZe5ae;Rm332cFp8 z2^szZUM3(~Jurl$C80I&zbMApx?2!i*F*xT*#!W*YFt<6!m`S!yPwLB?u#WNQ>2JFTk)Hp3Uw zJ3`Cix}JPesANQqv7VO=cu)@8u(^1J?Bfw!G!+_@z;eT`hQd=T+*&#U>>eh!*D&B* zR@YKM)l@CGSmFR*LT?d?+8?)vFxHb~dFLEig-#Zpv#e+wVby{2meQnF!*1nFM@lE; zv)&27Oq~Eff__}>IZoC^R zousv3Rx?Ydlf+CsWrQ3>J>zb;Z;#Y&&JlK`G>tp77E;7nnrF0PlC#JpYCnY~4z9=S z!azF-KNxR0wk|8S{h;j#J?7Z4Ow(pBdE1U#jBuB&LBVa5?cs=qE${xyU9vybRuTE4 z;YkoloM2I!Un2c?j$r`tc;(pcG! zP2d9!N6R&>9n7^UmbIYcLM!T;tPA^w;WA7OW!HVQl5#LBLp#eh^<;2jL+OR|Ouq4a zCEe?bmpAObqzR5@Q{3bU8|x>>S}ARLRa>(8EJe*8mAz`>$yeqw4pS)CUVxO!Y(O~~ z1{sHl*0yw$9&T=Uop6_bLgevUztTfhW~IKw`g0-DwM{*zUs^Kzy0*NIW~)dF%FkH8 z4xO9i#|7jr^aYgBdKBw>E*k|@D1P_GUS_D^c?xOnBg5LuKcZ(5p>M7Ak4vJ}Q7>nV zJ=V*(Ux*ZMC_~+OS|aJ_7Ml^Ob|-pq`7Hv=fHT)9E> ze5!&4H&SI(*u@HMn;i;p^CSz~Nh})KIJ|o{+x@lnu40z4RGR^La&;{`Y@V~CfgioGN6~@K;y9q%C@P*^9JPiEUM(RwrBOKH-jF?2ojuJ`WeRwyBZw4g=5CeBM6xeG0j8dC+-nB;JltgNX3BPu_=A2{eGKdB;>eq%tmVi+ZQ z##O`Y`g4CsEkC$w1r8o8ZuL`(9`oizZK&WEtXW(jh?wNlM8LH-w#BHA`I!7+x1!pVKp8<>)&T z-#dg~bd@CRbX+wED~ne9p4QjY9yh<`E=Y5$K{A;?t;f!UN|;X5@F7WrmXKoglDD(l zc%KHj$Z=2wehcdTe4N3~#|X>$0l=-63NP@cTVk$vMW{Cn9Jwc2Kb75mn;figM>oVW;?K>(+M&uRtCvA(FA+=9I&f&PQLk`6D{=P>Lnygd9x}|+% z-r|M)j51m{4YE{!OhvqeDi`nPdF$Tu!v9sI_SUtgmhXon&*p!4`W_D0StM@O!3uP z)=kDMA*<7v#lf+XwlU7I#L+2^)B{#dFtU=Z%TO@yj);5hiNni-Ci=#Gost-=e-Q&3 z?4UCB?m07aEwj2(BAYq8u!+cK9G>KGvK1ZRuxBvJQ22m%{TG+2|~+wX5^JNThdsIC&l*41=O{Y z@TCZ!DomVZ@pn3&=4cJu3%=By@vhE`!=%g)-{vyXP;=`#^yF!8bFUc#bw7?MPjTvY8Bg0 zRPw5p-X*bmTNetHha{MWJnjq_%Thddk3HH*Ir9p`PRUz&GLfC(Yip7w-+-ytUH6SG zwJ*l888BERD+hx~h~p4W#07gV*g!;G+lRYrrWol1o4%MnmgV`!V$d^wY8x?A={0+U zm+RY&Et_vQ>cP{7150vErURL|TKc-Hnm2JS69SkK$8CShqRsu)(6yO{>_E|Yq#)eJ zxkDkfT60J;^S(B81UYiO1-FQ-Z)-M|0ecv&E^))BzYyif>Ca60=L%qgvuYh5a$xq} zT5pO4D{<%R1K)hCh~kKnfxfx-L7W1_HTtq@rOwZ(BmeNi8J5eX8r+Vhwox4KS>!zX zqB&L=?loQ8aOD;I6sX=PWL;VMoLp>OI`ftLzEWGu_b)+8G}1~`)`Fw#yaz>6W%zfK zl`_d(75?n(i|qTGd0pR@dlK++nfrMI45{Cqvn`K29PFD@{&R!=sv72jBy7x5m573{j9nxRaA|8>2=FZXGZ1Bfi=m#J()(!CiTyZY`GEJGE&%CXEL}asNL=WO|C7i5BwD1<1 zQo8-zi4|NqF^isYAU1KRnV#5p^Rv>Bb7p`%RDOCssvvvvteGcF2QatUenMQkDP+&9 z`|Lr2pPJ@_ca=J8tYU|1(O#wydxTK@Q7V6Om88{SSJc?KuPvO*p}lD%`!8$XM4-y= zD=OZ_IxHPjY<3@2FozDi1{$hA-YgX`H^Bf{j9!oFT_sYBx?^wJ(_nED)8-Av1twr` z`U1`F%R%uCY#;GklHV3qSKG`jE~MaT$kX;iS*HuRt?%vZu^a0X0hs{*-CGg#`+4Pu z{5Acn(>e`5-D&*|1_1Iyq<+Ew=(|o6oKF3}304We)Zg#_-2l5fc0>3QHm zf|O*h#B8kT3yDGZbWcyupu2%-^PYL{tLOObV}d6n-nkZNN!aw;YB^5vpSN2r+p>1h z+np^y$`Tv{`<XV-39vtksoz}i>IXEl}2=h{safJ6x7VI)FgBEre*OF-7?BXWKKxLB?-oqFt{5@d>Gj81OW_f zI;H&5GA&nF)Hw7)V1;>O%WRu2Z{zdDC5Yw=-rnZs*MS=}pkk(Gywz4V8R7A3JOfch zqhs2<%}Zyqg=FMNti?FOF(a`gwJp(>5SH+UJ>cx@is6j7CYo%)65@*~`!S_4k&`V) z*&K&4`LZY11fWQY5r_d}=Yv(s;Ap0gSs1_tj;QGW*R=l4UxokIuKItr_W!ox|LrgN zf9=jbtU&9)J=k-!19-#yzx;u84eS3L|F7+U&!_yqc8B9x77q!v|F;FWjiduNC_JPm z%4z%X{xARf&rg5+@cys={_y_iKl3NoO?3A7xNqM^4+*$k+zI&b{_j8WwkEoJcbGFR z^w+(67k!&hkG|tvfmeTWhQT45lywYFTrk1$1l9V3VI5&_76RwFFZ59imCe!O)9gf3-(71sC-EHD<(Z^IpRVs9*F6&Kh`fLE;JgkWZ&(KFl0TomFPTWH;A(-V}dhO_CUCaxEeq)9DQW?dZ&yMUHCSUb8fZ=dE z018exq@Y`A!wg17XY&LEdc$Xsn@v2$(8VQfSsB#h@Qqq~hjcmx9~~^~pFd}o^&%X> z&V+_aDlUUWj$+CuHn*-!?j@r|qXpN}2%Kf$e3_L3E%R`~K5eFWw>}QU+FY8o24Y-s zbh_YjaB)j4VT%}pP87?-1;m~p)A||Y+~pLP7*E6;3a#Vuyxes*shlIMSqghRzr-_4 z1JG(IxZp}j67bvEIcq@Jy|Q+>i7>9-2t*vweE+DJJ;LKSWDHHj{PHMEh7|dbv+%6> zFoq>I@x(MAg1oZ;*nx452&^u+KUMbyAA%W$zjC`0YJk5XI>TTY5E!bBS*3Dvb9+P* zVTQ2t#GK~C`#=4j-?CtD1)ac*N(1ZiMg;Kv_ur2&o6C!cMu;jj;WFen9NjkgI#C8n z18IlLa+JH3A)&mS#;_C?AvJY7K^3#EnhscQKI)GX00w8^G)egEwlz2 z(`Zg$ux}GU7DT4P%5ZACkBR4n4cXNfyQ(j>YKy*ddUYqKKbLDg8wIS{AgS#>iz&pY z*h9w>x4YXw>jh8*gM6bcQB+ti(;SjDG?f9>m*x-5<3Sj}mM}_%jlf3q58hrhh5@W{ z*m~a(4-B7t0gprC!Q>Ib&6K4hpC;fJF#e>4^%$jKCp>J1*gChsCo0GB;r-wKAe@Og zI1Vmdwg_~lQm(hlPmhwlcNWNr^CT_HT9>Crqq-B?}Q|ndYq^B z?REUG{r``P|2yu1yKlPg!M@va^$NOS@xSF60@W+`K&V)U5d28!^6XGm@t8~af2Ls>>PAyb@s$*F2T zhqB*ik~qGLM#}5vF;r z>hv{PobsGlt*!`E%zmbBq8`_(nd6sk)d~VZl#U=&J|%CXFd#wFb2}Ypud$57xiR{V z^z2r9f90Oies5(qvP24p(qF|*N>~!gEN+x3W0ItCP)2N&y2uhD8=S%POpWm#t{ij>x1KI;#juMh~L*|e9T96x$!)$*KrPuhezeB8G?ZmnK# zRH-*2ufg^3h0zE)l!`6Qch<$Sh@}oc zC*|f!_}ueI+W*)7e<}ZS;I#Kmr`2{2TH61=nf^b6eV!!j>e4?K=YJea`TuR(aryTj zw!7ET{{J>$IC$`4aB}+1;J5I&AKekJq2ln4etn|ze_MS1+tufPOF#d&^89y~^MAIx zZyq?VW$6vzrau3#I{kNH{txcv`M*|2= z2J-obg1;m)m}T3BpPFo2%Co7cK67o85SW~f_|cD=W7qj-Ms~+VBbu-aaw$0ndUja` zmMa)o5NTb40VXU@fr;c9J!=%%h-wB5yf&$sB7wrp{$R+7>uMg%2M@ol(KEQ*nEESa zKos|ocP)9Cc~d#lcN-0|?`d%&zRRIOl!`BTXn@4nH>B(G?#wirfHG_O_)PhUY3)v$ zOq=_6>UH#+684mTJVoD;+Am0kas6hQtX#jPPqwz8V8y;{3Js8ZT6b`^ek^b?;SqJt%$hv&b!KORW;_CPXo$a zSC1-4J!RkTmzgho#bS64hq6Oh40R&~k8d(*Dh~WARXJ!;(ljzAg~*iTP ze+;nPY3YlAvWUvfm8NWt+_nlPD%^yhzJj#o)CQk~)$<;55-L4z3L$QzL*Z&Ge*Ekh z4Q6a97T`yVN_r?HQ(k&i{3`j<>{NPKGqzkf-nBeORz4cI&bZc2P!>w9jH6Lm5$ABu z&e+IvgcVuDnWv+dmH27tbj~`9%w(%tWL0hJ45`BBbBvS9&;RG&JZc_2efaD;{Qq;F z|8Bdrx9b19md^ie1&&FA`MJjCOIhisi)_;}o?@SL<&ifdzafmo7^c3D<3$(U#IxXr zI*iukC)13+r~%YPOZ9(LYm@M*KV7u37?ANoRh4N7omY z|19BNPzGoTH#=Ad7|(`Bs2}lp0@7}`eC}?EPlR1S&3_`Dsja{C9b=s zgt57zgz-PEC$ar<62Fpa65A^#vBg>v#->UVMzxNFQLZAfzKBGIVO*+$gt1&d;=J+^ z#=7DW>uN__Vd;n~tsG%|Y~6@YC>!w!RU?WCTURo|xT=B?#%j3;<9drl82VL*1`QfC pXwaZRg9Z&6G-%MEL4yVj8Z>Coph1HM4I2Lc;lCMw3a$Wn000Wqcv}Df literal 0 HcmV?d00001 diff --git a/example.py b/example.py new file mode 100644 index 0000000..1d5a245 --- /dev/null +++ b/example.py @@ -0,0 +1,6 @@ +from tanji.tanji import Tanji + +tanji = Tanji() +tanji.generate_key_pair() +encrypted_message, ciphertext = tanji.encrypt_message("Hello, Tanji!") +decrypted_message = tanji.decrypt_message(encrypted_message, ciphertext) diff --git a/make.bat b/make.bat new file mode 100644 index 0000000..dc1312a --- /dev/null +++ b/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..ebe3989 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,24 @@ +[tool.poetry] +name = "tanji" +version = "1.0.0" +description = "Tanji is a Python encryption library that provides a secure and flexible solution for encrypting and decrypting messages. It leverages both symmetric and asymmetric encryption techniques to ensure the confidentiality and integrity of your data." +authors = ["Anupam Maurya "] +readme = "README.md" +license = "MIT" +classifiers=["Development Status :: 3 - Alpha","Intended Audience :: Developers","Topic :: Software Development :: Build Tools","Programming Language :: Python :: 3.11"] + +[tool.poetry.dependencies] +python = "^3.11" +cffi= "^1.16.0" +colorama= "^0.4.6" +cryptography= "^41.0.5" +iniconfig= "^2.0.0" +packaging= "^23.2" +pluggy= "^1.3.0" +pycparser= "^2.21" +pytest= "^7.4.3" + +[build-system] +requires = ["poetry-core>=1.0.0"] +build-backend = "poetry.core.masonry.api" + diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..553c94d2dce4a4f4df2f0a34b9655b143e5e7c20 GIT binary patch literal 272 zcmXw!OAf*?3`A#*#8ps#lof}mq7o_~M5QcxdEnU%itL5w*)#cmf-byCXI`xX)zd5O zwNubjcWTz42W3o!+EINWX06IvprUhGS0+Ywe$V)$vy&1&b~CwSbgFT;zhlNF=thsQ yiEft~wNQ;;$s~F+kHy6@o4O^=Oaplavb;3Xw|(2L%l=B*5p{9x#IF6Pb@c}g>nN=N literal 0 HcmV?d00001 diff --git a/source/conf.py b/source/conf.py new file mode 100644 index 0000000..ef92aa4 --- /dev/null +++ b/source/conf.py @@ -0,0 +1,28 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'Tanji' +copyright = '2023, Anupam Maurya' +author = 'Anupam Maurya' +release = '1.0.0' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [] + +templates_path = ['_templates'] +exclude_patterns = [] + +language = 'Python' + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'alabaster' +html_static_path = ['_static'] diff --git a/source/index.rst b/source/index.rst new file mode 100644 index 0000000..54368cd --- /dev/null +++ b/source/index.rst @@ -0,0 +1,18 @@ +Welcome to Tanji's Documentation +=============================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + readme + modules/tanji + modules/symmetric + modules/asymmetric + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/source/modules/asymmetric.rst b/source/modules/asymmetric.rst new file mode 100644 index 0000000..622dd26 --- /dev/null +++ b/source/modules/asymmetric.rst @@ -0,0 +1,7 @@ +Asymmetric Module +================== + +.. automodule:: tanji.asymmetric + :members: + :undoc-members: + :show-inheritance: diff --git a/source/modules/symmetric.rst b/source/modules/symmetric.rst new file mode 100644 index 0000000..41cc5b8 --- /dev/null +++ b/source/modules/symmetric.rst @@ -0,0 +1,7 @@ +Symmetric Module +================ + +.. automodule:: tanji.symmetric + :members: + :undoc-members: + :show-inheritance: diff --git a/source/modules/tanji.rst b/source/modules/tanji.rst new file mode 100644 index 0000000..5420892 --- /dev/null +++ b/source/modules/tanji.rst @@ -0,0 +1,7 @@ +Tanji Module +============= + +.. automodule:: tanji.tanji + :members: + :undoc-members: + :show-inheritance: diff --git a/source/readme.rst b/source/readme.rst new file mode 100644 index 0000000..8db7feb --- /dev/null +++ b/source/readme.rst @@ -0,0 +1,4 @@ +Readme +====== + +.. include:: ../README.md diff --git a/tanji/__init__.py b/tanji/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tanji/__pycache__/__init__.cpython-311.pyc b/tanji/__pycache__/__init__.cpython-311.pyc new file mode 100644 index 0000000000000000000000000000000000000000..921d5e481b67a63d2e0911076ce8ab97315a9e3d GIT binary patch literal 135 zcmZ3^%ge<81S_lqQbF`%5CH>>P{wCAAY(d13PUi1CZpd+T4mr6PyZ=VdvN2dJ7z(9_-eih>}>9M2Tw{L#$&6}C` zdo%hq7K;M5`DcsdW(eR<*6B5|tF*sIWfu%EI16kp&)IyQ=UAV&1Y69DzAjiHTgpqm zE}~!0Cxp11mpR~J4h(4<40(?SIKa2l@?j(V6ta=OSvSjj0(EpxuIh$imWx@=iyLG` zU$b0oSuZ>%Wdos@L#U}+=7#Q?m2#G&Y^jJ#CEY0zr_c%9k-d4^i`d@<0(s7WJWm9J z+lD>F4g&AIh$ugRh7c77P{|N+)gfWL9d6hZ~wSWt`2o>g~wHj3nm8~m=MM^30}Oq zwrrUNjjUHIWm0y%@N-hr9CL$saxcjuWm9-ck(3G5U7}T~`GS4Xm9n*Z(QXt3khP)9 z_Bh%dmiSEOO?vLrrSJ6es=4I)QV-IVtJb{HAU<0{RX6Fz&3`5|H{gTY0Ov7^E%+;u zJW1r5>B**=JX3BRDYs9Q+bvmqFM19rUNf;X)QUo4@>IQhtlm9Rr%%-BooF+j`uUqi z{7xf$r;U-I&?^+yiQvoj-~JuNE~fDneg|6}+)G5P1`+zuz{6!xyKOa~yPvc}ZV$`i zASjK0Gsb{JzQ08J57;JO$0FDl7Vv~bbgNjQrdzVH4g|ZnLKCCspjzb+3@&}^JmKSpXPsiaQJZl(cz

Z&o{1exrj?8wspT8{3Lw9y6lAbiFp(LtdrW$>4%81>&V$f(Gob0 qYr+?etDYu&(&&G#LLN4t?`gvQM*q_iCpk>lpg3pP>njZY!ruZ&8~A_# literal 0 HcmV?d00001 diff --git a/tanji/__pycache__/secrets.cpython-311.pyc b/tanji/__pycache__/secrets.cpython-311.pyc new file mode 100644 index 0000000000000000000000000000000000000000..77f20da79db9a644a79f6ef5019a2bc5136aa65e GIT binary patch literal 158 zcmZ3^%ge<81YcYNQYC@(V-N=h7@>^MASKfoQW&BbQW%37G?|LofdV0kd0Cl7`F@&= zx442`or7FM;=NrXS2BDC>G~z2KczG$)vkyQ bs1jsJF&~ilz|6?Vc!O8GfeQqSSb#zR7`Y?} literal 0 HcmV?d00001 diff --git a/tanji/__pycache__/symmetric.cpython-311.pyc b/tanji/__pycache__/symmetric.cpython-311.pyc new file mode 100644 index 0000000000000000000000000000000000000000..40b14345739b9f5824f8ea9a763a72b532932eba GIT binary patch literal 2452 zcmds2zi-<{6h4w7CCiRkrIO=cjos8yttNGY8VHi2XwoW4>s= zq@7BT3lARrA9!g2O)d<(fd7Op-9>?b1WpBt4%rl_Q>MO0>W675oig=Ee!Tnc?%jKj z-yMIwawSZl-2UzxRR|FB7dF}j+HPrn39lof5QWK-G``s^qqAvN=hB=WNCz0?xGb*= zX@MauNf9M*KotI%CFB$yucU(tvqTcY3v4bXI7dio`AwBNVL7|8O*L~V;pH_9JdV%!$vl~A0Dz`v=W-U3^65MdYrO;hBY!HzrH zZgJwZzG}NDOnS9FIfKb<7mUJ9_H9U|KiTGmaa(PjkP`7H-VC-)5wg|RIVoNGJSO_z zDt=9zF~_jZX=klHuEdqmtDfSYw-+b{$`{t|4ll9gP`A~sDXiafe+#S)bjNmU{#A?6 zvB#G{#V6b%?5$vHPZjwcbN$16i7>@LDCWW8K3`a(yjx2?{(@pm&VZWB&_dqarjD?a zS3qcv02J(0C$z5RE-)^eu$qv;44caPHvv=jCk*kPdIX}7dw zA*+VeTBlbQ7dlZ+#&ZBraOB!A;h%@ghBbQ29=-M3^4a(2^yJCelRv(;9xdCCmMf7J zE3#roRt|-Fbi5XwsYYk4Xxxs*4+s8?U9ZJ%R%18IS}lIJ8ozt~+=@T2;}5LZLp%2H z_xrWvay7YZC0Fg_suf#34A;f6N@&d6C7mx1j$kO*ZvLOt*rT()>g=zx{+hh3Kwt@Z$M`C=sTY7%4sWl$By1Pzh9eQsLn4~^C^2iWkpkm19fqa_vcz(P=06Mdf776w zxHDWmd9nNR@hbGGm)XzgN3b~lpN%{~gJT$`PKNj0t4_YEy#B6}dlmoP2#hcgbT7O_ L?w>v#ZW{gtM6L#E literal 0 HcmV?d00001 diff --git a/tanji/__pycache__/tanji.cpython-311.pyc b/tanji/__pycache__/tanji.cpython-311.pyc new file mode 100644 index 0000000000000000000000000000000000000000..4b9a7f8ba53f39e3c88f6b8c37675c3efb1c0e6d GIT binary patch literal 2261 zcma)7%}*Ow5P!Sg566aV*wl66+TaM(#0>!&p`@uul&V!CH4-u*hsq^d8Sf^wYZLeF zf(kM!2M#{;P7XcOL|l5Q#GwZt@&|aOJy=2#kT%DAN&g-!{*WgP$hq6$QHH4DD5uQ9G zy0}erX_qHt5569iM4ekC1^F$i^KUue1`Zn8CT(4G` z%vaY6yepVS{Taoon|N$K|1SOT^CcGKl7*pqe5$$b#xg_*vI=3oPB26TeKqgoloROQgjZ2}@FitNve-n|!1cVY1Ou z45l9O55|SG_!g;!rK#PvhreI-$KGm?;j9S7jWVaVK z?F_G2)ax0)NW6w6CVY?zv{QlaZj%WH9xn&r@fJ#wYxvT59! zb_I24De2`4r4TY7)ukE@;AcIuIn zdelxFWG9{MXZz{S#G7e5``F1o?#3@4Dk(=9>*hbTm79)o^Y;hN>{p$VJzI2Ui(RGI zjTb%Oh0TTQL*R8lISY6Iib&%C6k!tyIiA86f5K0&@O+;JKo$eYg#bJO9`OvoiLfUG z96%`wQ>i5dFp1O4a3gE2ZeVK%KmY~?3pU{lO$;r88Szt)84xIrG0ovgig!%da#sxu z$H<^r^c?XI0(kiCH!)-ej}RcfPv8*%@&XwwnYvzc_;Hp_xhZjx$9)^wv~h2 zxRbl_s%GczIJrCBc;;V;TpR}wz51ymIQNUTy5Oh_Z5hltz{%}>x%0uBboc8eJNwkh zJ_V@!spPxyJcENbTQa`BSIP}T)7*rnHD2heb(DuR?T6KJ-CLm-ARhJxq+=*u1@@YF zr?8hJCQFfF+x_UbAOn2*ydb9gB+7<3ae?cT0WQhRGQicOc%@HHGw)u!tswa=5C4(9 zH$|d+Y`}cILjj^lb{c#Azf@^Lr%>5*&Q=%+7? RauDcg_BY!8`Huw_#e2Er>f8VT literal 0 HcmV?d00001 diff --git a/tanji/asymmetric.py b/tanji/asymmetric.py new file mode 100644 index 0000000..a23a4fd --- /dev/null +++ b/tanji/asymmetric.py @@ -0,0 +1,40 @@ +from cryptography.hazmat.primitives.asymmetric import rsa, padding +from cryptography.hazmat.backends import default_backend +from cryptography.hazmat.primitives import serialization +from cryptography.hazmat.primitives.asymmetric import padding +from cryptography.hazmat.primitives import hashes + +class AsymmetricCipher: + @staticmethod + def generate_key_pair(): + private_key = rsa.generate_private_key( + public_exponent=65537, + key_size=2048, + backend=default_backend() + ) + public_key = private_key.public_key() + return private_key, public_key + + @staticmethod + def rsa_encrypt(message, public_key): + ciphertext = public_key.encrypt( + message, + padding.OAEP( + mgf=padding.MGF1(algorithm=hashes.SHA256()), + algorithm=hashes.SHA256(), + label=None + ) + ) + return ciphertext + + @staticmethod + def rsa_decrypt(ciphertext, private_key): + plaintext = private_key.decrypt( + ciphertext, + padding.OAEP( + mgf=padding.MGF1(algorithm=hashes.SHA256()), + algorithm=hashes.SHA256(), + label=None + ) + ) + return plaintext diff --git a/tanji/secrets.py b/tanji/secrets.py new file mode 100644 index 0000000..3243ce4 --- /dev/null +++ b/tanji/secrets.py @@ -0,0 +1 @@ +SECRET_KEY = b'Tanjiro' diff --git a/tanji/symmetric.py b/tanji/symmetric.py new file mode 100644 index 0000000..301b593 --- /dev/null +++ b/tanji/symmetric.py @@ -0,0 +1,27 @@ +import secrets +from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes +from cryptography.hazmat.backends import default_backend + +class SymmetricCipher: + @staticmethod + def generate_key(): + return secrets.token_bytes(32) # 256 bits + + @staticmethod + def generate_iv(): + return secrets.token_bytes(16) # 128 bits + + @staticmethod + def aes_encrypt(key, iv, plaintext): + cipher = Cipher(algorithms.AES(key), modes.CFB(iv), backend=default_backend()) + encryptor = cipher.encryptor() + # Ensure that the input is in bytes + ciphertext = encryptor.update(plaintext.encode('utf-8')) + encryptor.finalize() + return ciphertext + + @staticmethod + def aes_decrypt(key, iv, ciphertext): + cipher = Cipher(algorithms.AES(key), modes.CFB(iv), backend=default_backend()) + decryptor = cipher.decryptor() + plaintext = decryptor.update(ciphertext) + decryptor.finalize() + return plaintext.decode('utf-8') diff --git a/tanji/tanji.py b/tanji/tanji.py new file mode 100644 index 0000000..6237164 --- /dev/null +++ b/tanji/tanji.py @@ -0,0 +1,35 @@ +import base64 +from .symmetric import SymmetricCipher +from .asymmetric import AsymmetricCipher + +class Tanji: + def __init__(self, secret_key=None): + self.secret_key = secret_key + self.private_key = None + self.public_key = None + self.iv = None + + def generate_key_pair(self): + self.private_key, self.public_key = AsymmetricCipher.generate_key_pair() + + def encrypt_message(self, message): + sym_key = SymmetricCipher.generate_key() + self.iv = SymmetricCipher.generate_iv() + + ciphertext = SymmetricCipher.aes_encrypt(sym_key, self.iv, message) + encrypted_sym_key = AsymmetricCipher.rsa_encrypt(sym_key, self.public_key) + + return base64.b64encode(encrypted_sym_key), base64.b64encode(ciphertext) + + def decrypt_message(self, encrypted_sym_key, ciphertext): + # Decode base64 strings + decoded_sym_key = base64.b64decode(encrypted_sym_key) + decoded_ciphertext = base64.b64decode(ciphertext) + + # Decrypt the symmetric key + sym_key = AsymmetricCipher.rsa_decrypt(decoded_sym_key, self.private_key) + + # Decrypt the message using the symmetric key and IV + decrypted_message = SymmetricCipher.aes_decrypt(sym_key, self.iv, decoded_ciphertext) + + return decrypted_message diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/__pycache__/__init__.cpython-311.pyc b/tests/__pycache__/__init__.cpython-311.pyc new file mode 100644 index 0000000000000000000000000000000000000000..7256d78a860ac3aea68d092b8285d27bcec3c905 GIT binary patch literal 135 zcmZ3^%ge<81S_lqQbF`%5CH>>P{wCAAY(d13PUi1CZpd+%OniK1US>&ryk0@&FAkgB{FKt1RJ$Tppi+=w#r#0x12ZEd;|B&9QN#=s F0|2%!8+`x( literal 0 HcmV?d00001 diff --git a/tests/__pycache__/test_tanji.cpython-311-pytest-7.4.3.pyc b/tests/__pycache__/test_tanji.cpython-311-pytest-7.4.3.pyc new file mode 100644 index 0000000000000000000000000000000000000000..52e28825785ed81618daf8d459fd0f2395abb7f3 GIT binary patch literal 3850 zcmeHK&2Jk;6rbIlT|0K1H0cLP>4%Hbq?=ZuN!tV}f}jvlKrM*25?Ga1Tkj@acm1K+ zbxF)xick(5x%E<{o`RtK5fvwncI2wjN=Qfu32s3Zm!5btV^6&6xT0`n;(eKU?>Fzg znH|61_}fe-g`gEa{n-9WLFiXH=rp&(kv??jc{|YAXFs-q8O++62o(VTBknb)VucjXU<5E)(h~ zOkG=g=aZ%D#)nIveTSY>N6(JDckw364TL6d3@0UZm1SvqemUyoUnx0F=Egx@{8R3c^brUPoOH zq(H7pbtO=|?|pUGLxFl{&5{CTS+W>%S>D93De$yyiceE(w}O}-je8e)2O_?;&Wr#> zHyW3R0bN{+_0@O`BQS=F(nT3Ub|iH%f$q>}+04zW5o^kUV4 z8ub(%eF=NKD%B-;6xeIDd#GP<_Y?Fz{lEMCZT!34w-9`VlkgROra4}=RQ7eLws7)P zWo=IPQeU(?*~KjFoz=aW3UTh5zD>XAsd|=AVa5x($G)+;5-I?tVvdRnwIS2h}0z{dAUX5wqpl~+#K@bjYY@9a z^5tU1Bz8CmX5&`XaeXK?q2`tW;e}&{ce`A5Ee17K-105cHA-gD4hIa+T(+r)aOiEe z6sKHTBBV^h{l;>c6iwf-S1YbrGJUXwsfx&6*VvwfX&RDm!)*89eD~lSA8?QJ-GkRW zS{t&g5y}AJA-2AreIT!ZaS$Hwcc^IVXd90{!4q3}qKPM4c(Q>fxAANX&o=sh9`^?{ zJ0^}1L+~bM31zRQ7q%w`JjBxD8UV-eB329!!)<)Fh0iwne;)S-G&?4a5kv4MW(j4l zrWdv+20X;l;~D_R@FG?WFNV({!e!v@e@=uJ6lEYyL56UUL z;g7Hi-$^@`EqN92bYY&=ug>o~zW)A>hEAS)GI42Z;?kqnn-f=B6IYt}L<1lEx(254 zsV8IeTVwN$h08xpH^*+Y#%_S=FAb@wM(X&3@g_dq!lxVf^v`&pkvi7M&NlH}3(qz1 z9L!dy8(81MI!OL`jP+KhFO