diff --git a/code/backend/docs/_build/doctrees/environment.pickle b/code/backend/docs/_build/doctrees/environment.pickle index 30a1d6d..ae22f94 100644 Binary files a/code/backend/docs/_build/doctrees/environment.pickle and b/code/backend/docs/_build/doctrees/environment.pickle differ diff --git a/code/backend/docs/_build/doctrees/index.doctree b/code/backend/docs/_build/doctrees/index.doctree index 6adf1af..a35b352 100644 Binary files a/code/backend/docs/_build/doctrees/index.doctree and b/code/backend/docs/_build/doctrees/index.doctree differ diff --git a/code/backend/docs/_build/doctrees/modules.doctree b/code/backend/docs/_build/doctrees/modules.doctree deleted file mode 100644 index 2f565d5..0000000 Binary files a/code/backend/docs/_build/doctrees/modules.doctree and /dev/null differ diff --git a/code/backend/docs/_build/doctrees/nest_backend.database.doctree b/code/backend/docs/_build/doctrees/nest_backend.database.doctree deleted file mode 100644 index 792eac4..0000000 Binary files a/code/backend/docs/_build/doctrees/nest_backend.database.doctree and /dev/null differ diff --git a/code/backend/docs/_build/doctrees/nest_backend.database.tables.doctree b/code/backend/docs/_build/doctrees/nest_backend.database.tables.doctree deleted file mode 100644 index 3d379b7..0000000 Binary files a/code/backend/docs/_build/doctrees/nest_backend.database.tables.doctree and /dev/null differ diff --git a/code/backend/docs/_build/doctrees/nest_backend.doctree b/code/backend/docs/_build/doctrees/nest_backend.doctree deleted file mode 100644 index cd022c7..0000000 Binary files a/code/backend/docs/_build/doctrees/nest_backend.doctree and /dev/null differ diff --git a/code/backend/docs/_build/doctrees/nest_backend.routes.doctree b/code/backend/docs/_build/doctrees/nest_backend.routes.doctree deleted file mode 100644 index d12c810..0000000 Binary files a/code/backend/docs/_build/doctrees/nest_backend.routes.doctree and /dev/null differ diff --git a/code/backend/docs/_build/doctrees/nest_backend.routes.repository.doctree b/code/backend/docs/_build/doctrees/nest_backend.routes.repository.doctree deleted file mode 100644 index 9b80d7f..0000000 Binary files a/code/backend/docs/_build/doctrees/nest_backend.routes.repository.doctree and /dev/null differ diff --git a/code/backend/docs/_build/doctrees/nest_backend.routes.users.doctree b/code/backend/docs/_build/doctrees/nest_backend.routes.users.doctree deleted file mode 100644 index e10e0b0..0000000 Binary files a/code/backend/docs/_build/doctrees/nest_backend.routes.users.doctree and /dev/null differ diff --git a/code/backend/docs/_build/html/.buildinfo b/code/backend/docs/_build/html/.buildinfo index 1afac02..aaee3f6 100644 --- a/code/backend/docs/_build/html/.buildinfo +++ b/code/backend/docs/_build/html/.buildinfo @@ -1,4 +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: 5d92c0b9d3e4122c56ce600116527138 +config: 7a0fb47544de31020c9c117baf4c770c tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/code/backend/docs/_build/html/_sources/index.rst.txt b/code/backend/docs/_build/html/_sources/index.rst.txt index e7bd449..8d78751 100644 --- a/code/backend/docs/_build/html/_sources/index.rst.txt +++ b/code/backend/docs/_build/html/_sources/index.rst.txt @@ -7,10 +7,9 @@ Welcome to N.E.S.T. Backend's documentation! ============================================ .. toctree:: - :maxdepth: 2 - :caption: Contents: + :maxdepth: 4 - modules + python_api/index diff --git a/code/backend/docs/_build/html/_sources/modules.rst.txt b/code/backend/docs/_build/html/_sources/modules.rst.txt deleted file mode 100644 index 33b15f7..0000000 --- a/code/backend/docs/_build/html/_sources/modules.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -backend -======= - -.. toctree:: - :maxdepth: 4 - - nest_backend diff --git a/code/backend/docs/_build/html/_sources/nest_backend.database.rst.txt b/code/backend/docs/_build/html/_sources/nest_backend.database.rst.txt deleted file mode 100644 index 388a200..0000000 --- a/code/backend/docs/_build/html/_sources/nest_backend.database.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -nest\_backend.database package -============================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - nest_backend.database.tables - -Submodules ----------- - -nest\_backend.database.base module ----------------------------------- - -.. automodule:: nest_backend.database.base - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nest_backend.database - :members: - :undoc-members: - :show-inheritance: diff --git a/code/backend/docs/_build/html/_sources/nest_backend.database.tables.rst.txt b/code/backend/docs/_build/html/_sources/nest_backend.database.tables.rst.txt deleted file mode 100644 index fc36d40..0000000 --- a/code/backend/docs/_build/html/_sources/nest_backend.database.tables.rst.txt +++ /dev/null @@ -1,109 +0,0 @@ -nest\_backend.database.tables package -===================================== - -Submodules ----------- - -nest\_backend.database.tables.Alert module ------------------------------------------- - -.. automodule:: nest_backend.database.tables.Alert - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.Authorization module --------------------------------------------------- - -.. automodule:: nest_backend.database.tables.Authorization - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.BoolOperation module --------------------------------------------------- - -.. automodule:: nest_backend.database.tables.BoolOperation - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.Composed module ---------------------------------------------- - -.. automodule:: nest_backend.database.tables.Composed - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.Condition module ----------------------------------------------- - -.. automodule:: nest_backend.database.tables.Condition - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.Contains module ---------------------------------------------- - -.. automodule:: nest_backend.database.tables.Contains - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.Enums module ------------------------------------------- - -.. automodule:: nest_backend.database.tables.Enums - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.Notification module -------------------------------------------------- - -.. automodule:: nest_backend.database.tables.Notification - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.Repository module ------------------------------------------------ - -.. automodule:: nest_backend.database.tables.Repository - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.Tweet module ------------------------------------------- - -.. automodule:: nest_backend.database.tables.Tweet - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.User module ------------------------------------------ - -.. automodule:: nest_backend.database.tables.User - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.Uses module ------------------------------------------ - -.. automodule:: nest_backend.database.tables.Uses - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nest_backend.database.tables - :members: - :undoc-members: - :show-inheritance: diff --git a/code/backend/docs/_build/html/_sources/nest_backend.routes.repository.rst.txt b/code/backend/docs/_build/html/_sources/nest_backend.routes.repository.rst.txt deleted file mode 100644 index 0a1e100..0000000 --- a/code/backend/docs/_build/html/_sources/nest_backend.routes.repository.rst.txt +++ /dev/null @@ -1,45 +0,0 @@ -nest\_backend.routes.repository package -======================================= - -Submodules ----------- - -nest\_backend.routes.repository.repository\_add\_condition module ------------------------------------------------------------------ - -.. automodule:: nest_backend.routes.repository.repository_add_condition - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.routes.repository.repository\_create module ---------------------------------------------------------- - -.. automodule:: nest_backend.routes.repository.repository_create - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.routes.repository.repository\_edit module -------------------------------------------------------- - -.. automodule:: nest_backend.routes.repository.repository_edit - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.routes.repository.repository\_list module -------------------------------------------------------- - -.. automodule:: nest_backend.routes.repository.repository_list - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nest_backend.routes.repository - :members: - :undoc-members: - :show-inheritance: diff --git a/code/backend/docs/_build/html/_sources/nest_backend.routes.rst.txt b/code/backend/docs/_build/html/_sources/nest_backend.routes.rst.txt deleted file mode 100644 index bd2789a..0000000 --- a/code/backend/docs/_build/html/_sources/nest_backend.routes.rst.txt +++ /dev/null @@ -1,30 +0,0 @@ -nest\_backend.routes package -============================ - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - nest_backend.routes.repository - nest_backend.routes.users - -Submodules ----------- - -nest\_backend.routes.doa module -------------------------------- - -.. automodule:: nest_backend.routes.doa - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nest_backend.routes - :members: - :undoc-members: - :show-inheritance: diff --git a/code/backend/docs/_build/html/_sources/nest_backend.routes.users.rst.txt b/code/backend/docs/_build/html/_sources/nest_backend.routes.users.rst.txt deleted file mode 100644 index 2ce0ae4..0000000 --- a/code/backend/docs/_build/html/_sources/nest_backend.routes.users.rst.txt +++ /dev/null @@ -1,37 +0,0 @@ -nest\_backend.routes.users package -================================== - -Submodules ----------- - -nest\_backend.routes.users.login module ---------------------------------------- - -.. automodule:: nest_backend.routes.users.login - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.routes.users.user\_create module ----------------------------------------------- - -.. automodule:: nest_backend.routes.users.user_create - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.routes.users.user\_delete module ----------------------------------------------- - -.. automodule:: nest_backend.routes.users.user_delete - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nest_backend.routes.users - :members: - :undoc-members: - :show-inheritance: diff --git a/code/backend/docs/_build/html/_sources/nest_backend.rst.txt b/code/backend/docs/_build/html/_sources/nest_backend.rst.txt deleted file mode 100644 index 23aa860..0000000 --- a/code/backend/docs/_build/html/_sources/nest_backend.rst.txt +++ /dev/null @@ -1,30 +0,0 @@ -nest\_backend package -===================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - nest_backend.database - nest_backend.routes - -Submodules ----------- - -nest\_backend.gestione module ------------------------------ - -.. automodule:: nest_backend.gestione - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nest_backend - :members: - :undoc-members: - :show-inheritance: diff --git a/code/backend/docs/_build/html/_static/alabaster.css b/code/backend/docs/_build/html/_static/alabaster.css deleted file mode 100644 index 0eddaeb..0000000 --- a/code/backend/docs/_build/html/_static/alabaster.css +++ /dev/null @@ -1,701 +0,0 @@ -@import url("basic.css"); - -/* -- page layout ----------------------------------------------------------- */ - -body { - font-family: Georgia, serif; - font-size: 17px; - background-color: #fff; - color: #000; - margin: 0; - padding: 0; -} - - -div.document { - width: 940px; - margin: 30px auto 0 auto; -} - -div.documentwrapper { - float: left; - width: 100%; -} - -div.bodywrapper { - margin: 0 0 0 220px; -} - -div.sphinxsidebar { - width: 220px; - font-size: 14px; - line-height: 1.5; -} - -hr { - border: 1px solid #B1B4B6; -} - -div.body { - background-color: #fff; - color: #3E4349; - padding: 0 30px 0 30px; -} - -div.body > .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: 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/code/backend/docs/_build/html/_static/custom.css b/code/backend/docs/_build/html/_static/custom.css deleted file mode 100644 index 2a924f1..0000000 --- a/code/backend/docs/_build/html/_static/custom.css +++ /dev/null @@ -1 +0,0 @@ -/* This file intentionally left blank. */ diff --git a/code/backend/docs/_build/html/_static/documentation_options.js b/code/backend/docs/_build/html/_static/documentation_options.js index 2fa8c97..87d8188 100644 --- a/code/backend/docs/_build/html/_static/documentation_options.js +++ b/code/backend/docs/_build/html/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '', + VERSION: '0.1.0', LANGUAGE: 'None', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/code/backend/docs/_build/html/_static/pygments.css b/code/backend/docs/_build/html/_static/pygments.css index 87f8bd1..582d5c3 100644 --- a/code/backend/docs/_build/html/_static/pygments.css +++ b/code/backend/docs/_build/html/_static/pygments.css @@ -5,78 +5,70 @@ td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5 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 .gr { color: #ef2929 } /* Generic.Error */ +.highlight .c { color: #408080; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #008000; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #408080; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #BC7A00 } /* Comment.Preproc */ +.highlight .cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #408080; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .gr { color: #FF0000 } /* 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 .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { 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 .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 +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #008000 } /* Keyword.Pseudo */ +.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #B00040 } /* Keyword.Type */ +.highlight .m { color: #666666 } /* Literal.Number */ +.highlight .s { color: #BA2121 } /* Literal.String */ +.highlight .na { color: #7D9029 } /* Name.Attribute */ +.highlight .nb { color: #008000 } /* Name.Builtin */ +.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ +.highlight .no { color: #880000 } /* Name.Constant */ +.highlight .nd { color: #AA22FF } /* Name.Decorator */ +.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #0000FF } /* Name.Function */ +.highlight .nl { color: #A0A000 } /* Name.Label */ +.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #19177C } /* Name.Variable */ +.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #666666 } /* Literal.Number.Bin */ +.highlight .mf { color: #666666 } /* Literal.Number.Float */ +.highlight .mh { color: #666666 } /* Literal.Number.Hex */ +.highlight .mi { color: #666666 } /* Literal.Number.Integer */ +.highlight .mo { color: #666666 } /* Literal.Number.Oct */ +.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ +.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ +.highlight .sc { color: #BA2121 } /* Literal.String.Char */ +.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ +.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ +.highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ +.highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */ +.highlight .sx { color: #008000 } /* Literal.String.Other */ +.highlight .sr { color: #BB6688 } /* Literal.String.Regex */ +.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ +.highlight .ss { color: #19177C } /* Literal.String.Symbol */ +.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #0000FF } /* Name.Function.Magic */ +.highlight .vc { color: #19177C } /* Name.Variable.Class */ +.highlight .vg { color: #19177C } /* Name.Variable.Global */ +.highlight .vi { color: #19177C } /* Name.Variable.Instance */ +.highlight .vm { color: #19177C } /* Name.Variable.Magic */ +.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/code/backend/docs/_build/html/genindex.html b/code/backend/docs/_build/html/genindex.html index 051cea9..4d7abd5 100644 --- a/code/backend/docs/_build/html/genindex.html +++ b/code/backend/docs/_build/html/genindex.html @@ -1,40 +1,160 @@ + + + + + + + + Index — N.E.S.T. Backend 0.1.0 documentation + - - - - - Index — N.E.S.T. Backend documentation - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + - - - - - - - - -
-
-
+
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
    + +
  • »
  • + +
  • Index
  • + + +
  • + + + +
  • + +
+ + +
+
+
+

Index

- A + _ + | A | B | C | E @@ -55,39 +175,67 @@ | W
+

_

+ + +
+

A

@@ -96,7 +244,7 @@

B

@@ -104,55 +252,59 @@

C

E

@@ -160,13 +312,13 @@

F

@@ -174,7 +326,11 @@

G

+
@@ -182,7 +338,7 @@

H

@@ -190,27 +346,27 @@

I

@@ -218,11 +374,13 @@

J

@@ -230,14 +388,14 @@

L

@@ -250,61 +408,15 @@ module @@ -313,221 +425,60 @@

N

@@ -535,25 +486,25 @@

O

@@ -561,27 +512,13 @@

P

@@ -589,32 +526,34 @@

R

@@ -623,17 +562,17 @@

S

@@ -641,31 +580,39 @@

T

@@ -673,19 +620,17 @@

U

@@ -693,74 +638,54 @@

W

+
+
- +
+ +
+ +
+

+ © Copyright 2021, Gruppo 2. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
-
+
+ + - - - - -

Navigation

-

Contents:

- - -
-

Related Topics

- -
- - - - - - - - - - -
-
-
-
- - + + + - - + \ No newline at end of file diff --git a/code/backend/docs/_build/html/index.html b/code/backend/docs/_build/html/index.html index 699e0a1..bffc835 100644 --- a/code/backend/docs/_build/html/index.html +++ b/code/backend/docs/_build/html/index.html @@ -1,43 +1,172 @@ + + + + + + + + Welcome to N.E.S.T. Backend’s documentation! — N.E.S.T. Backend 0.1.0 documentation + - - - - - Welcome to N.E.S.T. Backend’s documentation! — N.E.S.T. Backend documentation - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + - - - - - - - - -
-
-
+
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
    + +
  • »
  • + +
  • Welcome to N.E.S.T. Backend’s documentation!
  • + + +
  • + + + View page source + + +
  • + +
+ + +
+
+
+ - +
-
+
+ + - - - - -

Navigation

-

Contents:

- - -
-

Related Topics

- -
- - - - - - - - - - -
-
-
-
- - + + + - - + \ No newline at end of file diff --git a/code/backend/docs/_build/html/modules.html b/code/backend/docs/_build/html/modules.html deleted file mode 100644 index 510a45a..0000000 --- a/code/backend/docs/_build/html/modules.html +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - - backend — N.E.S.T. Backend documentation - - - - - - - - - - - - - - - - - - - -
-
- -
- -
-
- - - - - - - \ No newline at end of file diff --git a/code/backend/docs/_build/html/nest_backend.database.html b/code/backend/docs/_build/html/nest_backend.database.html deleted file mode 100644 index cb86e68..0000000 --- a/code/backend/docs/_build/html/nest_backend.database.html +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - - nest_backend.database package — N.E.S.T. Backend documentation - - - - - - - - - - - - - - - - - - - -
-
- -
- -
-
- - - - - - - \ No newline at end of file diff --git a/code/backend/docs/_build/html/nest_backend.database.tables.html b/code/backend/docs/_build/html/nest_backend.database.tables.html deleted file mode 100644 index eb2085c..0000000 --- a/code/backend/docs/_build/html/nest_backend.database.tables.html +++ /dev/null @@ -1,632 +0,0 @@ - - - - - - - - nest_backend.database.tables package — N.E.S.T. Backend documentation - - - - - - - - - - - - - - - - - - - -
-
-
- - -
- -
-

nest_backend.database.tables package

-
-

Submodules

-
-
-

nest_backend.database.tables.Alert module

-

This module defines the Alert database class.

-
-
-class nest_backend.database.tables.Alert.Alert(**kwargs)
-

Bases: sqlalchemy.orm.decl_api.Model

-
-
-id
-
- -
-
-limit
-
- -
-
-name
-
- -
-
-notifications
-
- -
-
-operations
-
- -
-
-repository
-
- -
-
-repository_id
-
- -
-
-window_size
-
- -
- -
-
-

nest_backend.database.tables.Authorization module

-

This module defines the Authorization database class.

-
-
-class nest_backend.database.tables.Authorization.Authorization(**kwargs)
-

Bases: sqlalchemy.orm.decl_api.Model

-
-
-email
-
- -
-
-repository
-
- -
-
-rid
-
- -
-
-user
-
- -
- -
-
-

nest_backend.database.tables.BoolOperation module

-

This module defines the BoolOperation database class.

-
-
-class nest_backend.database.tables.BoolOperation.BoolOperation(**kwargs)
-

Bases: sqlalchemy.orm.decl_api.Model

-
-
-alert
-
- -
-
-alert_id
-
- -
-
-condition
-
- -
-
-condition_id
-
- -
-
-father_1
-
- -
-
-father_2
-
- -
-
-id
-
- -
-
-isRoot
-
- -
-
-node_1
-
- -
-
-node_1_id
-
- -
-
-node_2
-
- -
-
-node_2_id
-
- -
-
-operation
-
- -
- -
-
-

nest_backend.database.tables.Composed module

-

This module defines the Composed database class.

-
-
-class nest_backend.database.tables.Composed.Composed(**kwargs)
-

Bases: sqlalchemy.orm.decl_api.Model

-
-
-repository
-
- -
-
-rid
-
- -
-
-snowflake
-
- -
-
-tweet
-
- -
- -
-
-

nest_backend.database.tables.Condition module

-

This module defines the Condition database class.

-
-
-class nest_backend.database.tables.Condition.Condition(**kwargs)
-

Bases: sqlalchemy.orm.decl_api.Model

-
-
-content
-
- -
-
-id
-
- -
-
-operations
-
- -
-
-tweets
-
- -
-
-type
-
- -
-
-used
-
- -
- -
-
-

nest_backend.database.tables.Contains module

-

This module defines the Contains database class.

-
-
-class nest_backend.database.tables.Contains.Contains(**kwargs)
-

Bases: sqlalchemy.orm.decl_api.Model

-
-
-cid
-
- -
-
-condition
-
- -
-
-snowflake
-
- -
-
-tweet
-
- -
- -
-
-

nest_backend.database.tables.Enums module

-

This module contains the main enum definitions.

-
-
-class nest_backend.database.tables.Enums.ConditionType(value)
-

Bases: enum.Enum

-

An enumeration.

-
-
-hashtag = 0
-
- -
-
-location = 1
-
- -
-
-time = 2
-
- -
- -
-
-class nest_backend.database.tables.Enums.OperationType(value)
-

Bases: enum.Enum

-

An enumeration.

-
-
-assign = 3
-
- -
- -
-
-

nest_backend.database.tables.Notification module

-

This module defines the Notification database class.

-
-
-class nest_backend.database.tables.Notification.Notification(**kwargs)
-

Bases: sqlalchemy.orm.decl_api.Model

-
-
-alert
-
- -
-
-alert_id
-
- -
-
-id
-
- -
-
-ora
-
- -
- -
-
-

nest_backend.database.tables.Repository module

-

This module defines the Repository database class.

-
-
-class nest_backend.database.tables.Repository.Repository(**kwargs)
-

Bases: sqlalchemy.orm.decl_api.Model

-
-
-alerts
-
- -
-
-authorizations
-
- -
-
-end
-
- -
-
-id
-
- -
-
-isActive
-
- -
-
-name
-
- -
-
-owner
-
- -
-
-owner_id
-
- -
-
-start
-
- -
-
-to_json()
-
- -
-
-tweets
-
- -
-
-uses
-
- -
- -
-
-

nest_backend.database.tables.Tweet module

-

This module defines the Tweet database class.

-
-
-class nest_backend.database.tables.Tweet.Tweet(**kwargs)
-

Bases: sqlalchemy.orm.decl_api.Model

-
-
-conditions
-
- -
-
-content
-
- -
-
-location
-
- -
-
-poster
-
- -
-
-repositories
-
- -
-
-snowflake
-
- -
- -
-
-

nest_backend.database.tables.User module

-

This module defines the User database class.

-
-
-class nest_backend.database.tables.User.User(**kwargs)
-

Bases: sqlalchemy.orm.decl_api.Model

-
-
-authorizations
-
- -
-
-email
-
- -
-
-isAdmin
-
- -
-
-owner_of
-
- -
-
-password
-
- -
-
-to_json()
-
- -
-
-username
-
- -
- -
-
-

nest_backend.database.tables.Uses module

-

This module defines the Uses database class.

-
-
-class nest_backend.database.tables.Uses.Uses(**kwargs)
-

Bases: sqlalchemy.orm.decl_api.Model

-
-
-cid
-
- -
-
-condition
-
- -
-
-repository
-
- -
-
-rid
-
- -
- -
-
-

Module contents

-

This module contains all database classes.

-
-
- - -
- -
-
- -
-
- - - - - - - \ No newline at end of file diff --git a/code/backend/docs/_build/html/nest_backend.html b/code/backend/docs/_build/html/nest_backend.html deleted file mode 100644 index cad7733..0000000 --- a/code/backend/docs/_build/html/nest_backend.html +++ /dev/null @@ -1,242 +0,0 @@ - - - - - - - - nest_backend package — N.E.S.T. Backend documentation - - - - - - - - - - - - - - - - - - - -
-
-
- - -
- -
-

nest_backend package

- -
-

Submodules

-
-
-

nest_backend.gestione module

-
-

A utilities Python Module.

-

Gestione adds many fancy thingamajigs to the flask application, such as a login system and such.

-
-
-nest_backend.gestione.admin_or_403(f)
-
- -
-
-nest_backend.gestione.authenticate(username, password)
-

Authentication method. It checks if the combination of username+password is a valid match. If not, it returns None. -:param username: the user’s email -:param password: the user’s password -:return: if the credentials are correct, it returns the user. Else, it returns None.

-
- -
-
-nest_backend.gestione.find_user(email)
-
- -
-
-nest_backend.gestione.gen_password(password)
-

It generates an hashed password. -:param password: the password that needs to be hashed. -:return: the password’s hash.

-
- -
-
-nest_backend.gestione.identity(payload)
-

Authentication verification method. It checks if the user is in fact registered on the server. -It is required by Flask-JWT, and shouldnt be used alone. -:param payload: the reqest payload. -:return: an User or None. It depends whether the user is actually registered on the platform.

-
- -
-
-nest_backend.gestione.json_error(msg)
-

Returns an error in json format -:param msg: the error message. -:return: a json formatted string.

-
- -
-
-nest_backend.gestione.json_success(data)
-

An happy little function. Its happy because the operation was successful. -:param data: the thing you want to be returned -:return: a json formatted string

-
- -
-
-nest_backend.gestione.repository_auth(f)
-
- -
-
-
-

Module contents

-
-
- - -
- -
-
- -
-
- - - - - - - \ No newline at end of file diff --git a/code/backend/docs/_build/html/nest_backend.routes.html b/code/backend/docs/_build/html/nest_backend.routes.html deleted file mode 100644 index 60c693d..0000000 --- a/code/backend/docs/_build/html/nest_backend.routes.html +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - - nest_backend.routes package — N.E.S.T. Backend documentation - - - - - - - - - - - - - - - - - - - -
-
-
- - -
- -
-

nest_backend.routes package

- -
-

Submodules

-
-
-

nest_backend.routes.doa module

-

Page that displays a message if the server is on

-
-
-nest_backend.routes.doa.page_doa()
-

Dead or Alive page. If a client sees this, the server is probably fine. -:return: A friendly and calming message, that makes you happy that the server is not on fire.

-
- -
-
-

Module contents

-

This module imports all the routes that return something to the frontend.

-
-
- - -
- -
-
- -
-
- - - - - - - \ No newline at end of file diff --git a/code/backend/docs/_build/html/nest_backend.routes.repository.html b/code/backend/docs/_build/html/nest_backend.routes.repository.html deleted file mode 100644 index 7087ff8..0000000 --- a/code/backend/docs/_build/html/nest_backend.routes.repository.html +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - - - nest_backend.routes.repository package — N.E.S.T. Backend documentation - - - - - - - - - - - - - - - - - - - -
-
-
- - -
- -
-

nest_backend.routes.repository package

-
-

Submodules

-
-
-

nest_backend.routes.repository.repository_add_condition module

-
-
-nest_backend.routes.repository.repository_add_condition.page_repository_add_condition()
-

API call that allows to add conditions to a repository. -:parameter id: Repository ID -:parameter type: The type of the condition. It can either be an ‘hashtag’, a ‘location’ or ‘time’ -:parameter content: The content of the condition (#PdS2021, Roma, 18:00) -:returns: a JSON string that tells whether or not the procedure was a success.

-
- -
-
-

nest_backend.routes.repository.repository_create module

-
-
-nest_backend.routes.repository.repository_create.page_repository_create()
-

API call that allows an user to create a new repository. -:parameter name: The name of the repository. -:returns: If the user is logged in and has provided the repository name, a JSON string is returned containing -the return status of the operation and the repository in json format.

-
- -
-
-

nest_backend.routes.repository.repository_edit module

-
-
-nest_backend.routes.repository.repository_edit.page_repository_edit()
-

This API call allows to edit a repository. -:parameter name: If present, it changes the repository name. -:parameter close: If present, it closes the repository. -:returns: A JSON formatted string that either contains an error or the updated representation of the repository.

-
- -
-
-

nest_backend.routes.repository.repository_list module

-
-
-nest_backend.routes.repository.repository_list.page_repository_list()
-

API call that returns the list of repositories. -:returns: a JSON-formatted string that contains under the “content” field the list of repositories that belong to -the user (“owner”) and a list of repositories that he can spectate (“spectator”).

-
- -
-
-

Module contents

-
-
- - -
- -
-
- -
-
- - - - - - - \ No newline at end of file diff --git a/code/backend/docs/_build/html/nest_backend.routes.users.html b/code/backend/docs/_build/html/nest_backend.routes.users.html deleted file mode 100644 index baf0586..0000000 --- a/code/backend/docs/_build/html/nest_backend.routes.users.html +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - - - nest_backend.routes.users package — N.E.S.T. Backend documentation - - - - - - - - - - - - - - - - - - -
-
-
- - -
- -
-

nest_backend.routes.users package

-
-

Submodules

-
-
-

nest_backend.routes.users.login module

-
-
-nest_backend.routes.users.login.page_login()
-

The API call that allows to log-in. It requires: -:parameter email: The user’s email -:parameter password: The users’s password -:returns: Json-formatted data. If the login is successful, it will contain the access_token and the users data.

-

The access_token must be included in the Authorization header, using the format Bearer <token>.

-
- -
-
-

nest_backend.routes.users.user_create module

-
-
-nest_backend.routes.users.user_create.page_user_create()
-

The API call that allows to create new users. It requires: -:parameter email: The user’s email -:parameter password: The users’s password -:parameter username: The users’s username -:return: Json-formatted data. If something goes wrong, it returns a -{‘result’:’failure’, ‘content’:’something blew up’}, else it returns {‘result’:’success’, ‘content’:newUser.to_json().

-
- -
-
-

nest_backend.routes.users.user_delete module

-
-
-nest_backend.routes.users.user_delete.page_user_delete()
-

API call that allows an user to be deleted from NEST. -:parameter email: The email of the user that needs to be removed. -:return: JSON-formatted data. If the user has the privilege, the target user exists and differs from the current -user, the target gets deleted and a json containing the field “result”:”success” is returned.

-
- -
-
-

Module contents

-
-
- - -
- -
-
- -
-
- - - - - - - \ No newline at end of file diff --git a/code/backend/docs/_build/html/objects.inv b/code/backend/docs/_build/html/objects.inv index 6f897ea..126165d 100644 Binary files a/code/backend/docs/_build/html/objects.inv and b/code/backend/docs/_build/html/objects.inv differ diff --git a/code/backend/docs/_build/html/py-modindex.html b/code/backend/docs/_build/html/py-modindex.html index 6c4d9e4..089a0ef 100644 --- a/code/backend/docs/_build/html/py-modindex.html +++ b/code/backend/docs/_build/html/py-modindex.html @@ -1,37 +1,154 @@ + + + + + + + + Python Module Index — N.E.S.T. Backend 0.1.0 documentation + - - - - - Python Module Index — N.E.S.T. Backend documentation - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - -
-
-
+
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
    + +
  • »
  • + +
  • Python Module Index
  • + + +
  • + +
  • + +
+ + +
+
+
+

Python Module Index

@@ -48,207 +165,72 @@ - nest_backend + nest_backend     - nest_backend.database + nest_backend.database     - nest_backend.database.base + nest_backend.database.base     - nest_backend.database.tables + nest_backend.database.tables     - nest_backend.database.tables.Alert - - - -     - nest_backend.database.tables.Authorization - - - -     - nest_backend.database.tables.BoolOperation - - - -     - nest_backend.database.tables.Composed - - - -     - nest_backend.database.tables.Condition - - - -     - nest_backend.database.tables.Contains - - - -     - nest_backend.database.tables.Enums - - - -     - nest_backend.database.tables.Notification - - - -     - nest_backend.database.tables.Repository - - - -     - nest_backend.database.tables.Tweet - - - -     - nest_backend.database.tables.User - - - -     - nest_backend.database.tables.Uses - - - -     - nest_backend.gestione - - - -     - nest_backend.routes - - - -     - nest_backend.routes.doa - - - -     - nest_backend.routes.repository - - - -     - nest_backend.routes.repository.repository_add_condition - - - -     - nest_backend.routes.repository.repository_create - - - -     - nest_backend.routes.repository.repository_edit - - - -     - nest_backend.routes.repository.repository_list - - - -     - nest_backend.routes.users - - - -     - nest_backend.routes.users.login - - - -     - nest_backend.routes.users.user_create - - - -     - nest_backend.routes.users.user_delete + nest_backend.gestione +
+
- +
+ +
+ +
+

+ © Copyright 2021, Gruppo 2. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
-
+
+ + - - - - -

Navigation

-

Contents:

- - -
-

Related Topics

- -
- - - - - - - - - - -
-
-
-
- - + + + - - + \ No newline at end of file diff --git a/code/backend/docs/_build/html/search.html b/code/backend/docs/_build/html/search.html index 947a5fe..1be76aa 100644 --- a/code/backend/docs/_build/html/search.html +++ b/code/backend/docs/_build/html/search.html @@ -1,114 +1,216 @@ + + + + + + + + Search — N.E.S.T. Backend 0.1.0 documentation + - - - - - Search — N.E.S.T. Backend documentation - - + + + + + + + + + + + + + - - - - - - + + + + + + + + + + + + + - - - + + + + + - - - - - - - - - -
-
-
+
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
    + +
  • »
  • + +
  • Search
  • + + +
  • + +
  • + +
+ + +
+
+
+
+ + +
+
+
- +
+ +
+ +
+

+ © Copyright 2021, Gruppo 2. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
-
+
+ + - - - - -

Navigation

-

Contents:

- - -
-

Related Topics

- -
- - - - - - - - -
-
-
-
- - + + + + + + + - - + + \ No newline at end of file diff --git a/code/backend/docs/_build/html/searchindex.js b/code/backend/docs/_build/html/searchindex.js index 6feaf68..55a909a 100644 --- a/code/backend/docs/_build/html/searchindex.js +++ b/code/backend/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["index","modules","nest_backend","nest_backend.database","nest_backend.database.tables","nest_backend.routes","nest_backend.routes.repository","nest_backend.routes.users"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["index.rst","modules.rst","nest_backend.rst","nest_backend.database.rst","nest_backend.database.tables.rst","nest_backend.routes.rst","nest_backend.routes.repository.rst","nest_backend.routes.users.rst"],objects:{"":{nest_backend:[2,0,0,"-"]},"nest_backend.database":{base:[3,0,0,"-"],tables:[4,0,0,"-"]},"nest_backend.database.tables":{Alert:[4,0,0,"-"],Authorization:[4,0,0,"-"],BoolOperation:[4,0,0,"-"],Composed:[4,0,0,"-"],Condition:[4,0,0,"-"],Contains:[4,0,0,"-"],Enums:[4,0,0,"-"],Notification:[4,0,0,"-"],Repository:[4,0,0,"-"],Tweet:[4,0,0,"-"],User:[4,0,0,"-"],Uses:[4,0,0,"-"]},"nest_backend.database.tables.Alert":{Alert:[4,1,1,""]},"nest_backend.database.tables.Alert.Alert":{id:[4,2,1,""],limit:[4,2,1,""],name:[4,2,1,""],notifications:[4,2,1,""],operations:[4,2,1,""],repository:[4,2,1,""],repository_id:[4,2,1,""],window_size:[4,2,1,""]},"nest_backend.database.tables.Authorization":{Authorization:[4,1,1,""]},"nest_backend.database.tables.Authorization.Authorization":{email:[4,2,1,""],repository:[4,2,1,""],rid:[4,2,1,""],user:[4,2,1,""]},"nest_backend.database.tables.BoolOperation":{BoolOperation:[4,1,1,""]},"nest_backend.database.tables.BoolOperation.BoolOperation":{alert:[4,2,1,""],alert_id:[4,2,1,""],condition:[4,2,1,""],condition_id:[4,2,1,""],father_1:[4,2,1,""],father_2:[4,2,1,""],id:[4,2,1,""],isRoot:[4,2,1,""],node_1:[4,2,1,""],node_1_id:[4,2,1,""],node_2:[4,2,1,""],node_2_id:[4,2,1,""],operation:[4,2,1,""]},"nest_backend.database.tables.Composed":{Composed:[4,1,1,""]},"nest_backend.database.tables.Composed.Composed":{repository:[4,2,1,""],rid:[4,2,1,""],snowflake:[4,2,1,""],tweet:[4,2,1,""]},"nest_backend.database.tables.Condition":{Condition:[4,1,1,""]},"nest_backend.database.tables.Condition.Condition":{content:[4,2,1,""],id:[4,2,1,""],operations:[4,2,1,""],tweets:[4,2,1,""],type:[4,2,1,""],used:[4,2,1,""]},"nest_backend.database.tables.Contains":{Contains:[4,1,1,""]},"nest_backend.database.tables.Contains.Contains":{cid:[4,2,1,""],condition:[4,2,1,""],snowflake:[4,2,1,""],tweet:[4,2,1,""]},"nest_backend.database.tables.Enums":{ConditionType:[4,1,1,""],OperationType:[4,1,1,""]},"nest_backend.database.tables.Enums.ConditionType":{hashtag:[4,2,1,""],location:[4,2,1,""],time:[4,2,1,""]},"nest_backend.database.tables.Enums.OperationType":{assign:[4,2,1,""]},"nest_backend.database.tables.Notification":{Notification:[4,1,1,""]},"nest_backend.database.tables.Notification.Notification":{alert:[4,2,1,""],alert_id:[4,2,1,""],id:[4,2,1,""],ora:[4,2,1,""]},"nest_backend.database.tables.Repository":{Repository:[4,1,1,""]},"nest_backend.database.tables.Repository.Repository":{alerts:[4,2,1,""],authorizations:[4,2,1,""],end:[4,2,1,""],id:[4,2,1,""],isActive:[4,2,1,""],name:[4,2,1,""],owner:[4,2,1,""],owner_id:[4,2,1,""],start:[4,2,1,""],to_json:[4,3,1,""],tweets:[4,2,1,""],uses:[4,2,1,""]},"nest_backend.database.tables.Tweet":{Tweet:[4,1,1,""]},"nest_backend.database.tables.Tweet.Tweet":{conditions:[4,2,1,""],content:[4,2,1,""],location:[4,2,1,""],poster:[4,2,1,""],repositories:[4,2,1,""],snowflake:[4,2,1,""]},"nest_backend.database.tables.User":{User:[4,1,1,""]},"nest_backend.database.tables.User.User":{authorizations:[4,2,1,""],email:[4,2,1,""],isAdmin:[4,2,1,""],owner_of:[4,2,1,""],password:[4,2,1,""],to_json:[4,3,1,""],username:[4,2,1,""]},"nest_backend.database.tables.Uses":{Uses:[4,1,1,""]},"nest_backend.database.tables.Uses.Uses":{cid:[4,2,1,""],condition:[4,2,1,""],repository:[4,2,1,""],rid:[4,2,1,""]},"nest_backend.gestione":{admin_or_403:[2,4,1,""],authenticate:[2,4,1,""],find_user:[2,4,1,""],gen_password:[2,4,1,""],identity:[2,4,1,""],json_error:[2,4,1,""],json_success:[2,4,1,""],repository_auth:[2,4,1,""]},"nest_backend.routes":{doa:[5,0,0,"-"],repository:[6,0,0,"-"],users:[7,0,0,"-"]},"nest_backend.routes.doa":{page_doa:[5,4,1,""]},"nest_backend.routes.repository":{repository_add_condition:[6,0,0,"-"],repository_create:[6,0,0,"-"],repository_edit:[6,0,0,"-"],repository_list:[6,0,0,"-"]},"nest_backend.routes.repository.repository_add_condition":{page_repository_add_condition:[6,4,1,""]},"nest_backend.routes.repository.repository_create":{page_repository_create:[6,4,1,""]},"nest_backend.routes.repository.repository_edit":{page_repository_edit:[6,4,1,""]},"nest_backend.routes.repository.repository_list":{page_repository_list:[6,4,1,""]},"nest_backend.routes.users":{login:[7,0,0,"-"],user_create:[7,0,0,"-"],user_delete:[7,0,0,"-"]},"nest_backend.routes.users.login":{page_login:[7,4,1,""]},"nest_backend.routes.users.user_create":{page_user_create:[7,4,1,""]},"nest_backend.routes.users.user_delete":{page_user_delete:[7,4,1,""]},nest_backend:{database:[3,0,0,"-"],gestione:[2,0,0,"-"],routes:[5,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method","4":"py:function"},terms:{"class":4,"enum":[2,3],"function":2,"import":[3,5],"new":[6,7],"return":[2,5,6,7],Its:2,The:[6,7],Uses:[2,3],access_token:7,actual:2,add:[2,6],admin_or_403:2,alert:[2,3],alert_id:4,aliv:5,all:[3,4,5],allow:[6,7],alon:2,api:[6,7],applic:2,assign:4,authent:2,author:[2,3,7],base:[1,2,4],bearer:7,becaus:2,belong:6,blew:7,booloper:[2,3],call:[6,7],calm:5,can:6,chang:6,check:2,cid:4,client:5,close:6,combin:2,compos:[2,3],condit:[2,3,6],condition_id:4,conditiontyp:4,contain:[2,3,6,7],content:1,correct:2,creat:[3,6,7],credenti:2,current:7,data:[2,7],databas:[1,2],dead:5,decl_api:4,declar:3,defin:4,definit:4,delet:7,depend:2,differ:7,displai:5,doa:[1,2],edit:6,either:6,els:[2,7],email:[2,4,7],end:4,enumer:4,error:[2,6],exist:7,fact:2,failur:7,fanci:2,father_1:4,father_2:4,field:[6,7],find_us:2,fine:5,fire:5,flask:2,format:[2,6,7],friendli:5,from:7,frontend:5,gen_password:2,gener:2,gestion:1,get:7,goe:7,happi:[2,5],has:[6,7],hash:2,hashtag:[4,6],header:7,ident:2,includ:7,index:0,isact:4,isadmin:4,isroot:4,json:[2,6,7],json_error:2,json_success:2,jwt:2,kwarg:4,limit:4,list:6,littl:2,locat:[4,6],log:[6,7],login:[2,5],main:4,make:5,mani:2,match:2,messag:[2,5],method:2,model:4,modul:[0,1],msg:2,must:7,name:[4,6],need:[2,7],nest:7,nest_backend:[0,1],newus:7,node_1:4,node_1_id:4,node_2:4,node_2_id:4,none:2,notif:[2,3],oper:[2,4,6],operationtyp:4,ora:4,orm:4,owner:[4,6],owner_id:4,owner_of:4,packag:[0,1],page:[0,5],page_doa:5,page_login:7,page_repository_add_condit:6,page_repository_cr:6,page_repository_edit:6,page_repository_list:6,page_user_cr:7,page_user_delet:7,param:2,paramet:[6,7],password:[2,4,7],payload:2,pds2021:6,platform:2,poster:4,present:6,privileg:7,probabl:5,procedur:6,provid:6,python:1,regist:2,remov:7,repositori:[2,3,5],repository_add_condit:[2,5],repository_auth:2,repository_cr:[2,5],repository_edit:[2,5],repository_id:4,repository_list:[2,5],represent:6,reqest:2,requir:[2,7],result:7,rid:4,roma:6,rout:[1,2],search:0,see:5,server:[2,5],shouldnt:2,snowflak:4,someth:[5,7],spectat:6,sqlalchemi:4,start:4,statu:6,string:[2,6],submodul:1,subpackag:1,success:[2,6,7],system:2,tabl:[2,3],target:7,tell:6,thi:[3,4,5,6],thing:2,thingamajig:2,time:[4,6],to_json:[4,7],token:7,tweet:[2,3],type:[4,6],under:6,updat:6,used:[2,4],user:[2,3,5,6],user_cr:[2,5],user_delet:[2,5],usernam:[2,4,7],uses:4,using:7,util:1,valid:2,valu:4,verif:2,want:2,whether:[2,6],window_s:4,wrong:7,you:[2,5]},titles:["Welcome to N.E.S.T. Backend\u2019s documentation!","backend","nest_backend package","nest_backend.database package","nest_backend.database.tables package","nest_backend.routes package","nest_backend.routes.repository package","nest_backend.routes.users package"],titleterms:{"enum":4,Uses:4,alert:4,author:4,backend:[0,1],base:3,booloper:4,compos:4,condit:4,contain:4,content:[0,2,3,4,5,6,7],databas:[3,4],doa:5,document:0,gestion:2,indic:0,login:7,modul:[2,3,4,5,6,7],nest_backend:[2,3,4,5,6,7],notif:4,packag:[2,3,4,5,6,7],python:2,repositori:[4,6],repository_add_condit:6,repository_cr:6,repository_edit:6,repository_list:6,rout:[5,6,7],submodul:[2,3,4,5,6,7],subpackag:[2,3,5],tabl:[0,4],tweet:4,user:[4,7],user_cr:7,user_delet:7,util:2,welcom:0}}) \ No newline at end of file +Search.setIndex({docnames:["index","python_api/index","python_api/nest_backend"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.todo":2,sphinx:56},filenames:["index.rst","python_api/index.rst","python_api/nest_backend.rst"],objects:{"":{nest_backend:[2,0,0,"-"]},"nest_backend.database":{base:[2,0,0,"-"],tables:[2,0,0,"-"]},"nest_backend.database.tables":{Alert:[2,1,1,""],Authorization:[2,1,1,""],BoolOperation:[2,1,1,""],Composed:[2,1,1,""],Condition:[2,1,1,""],ConditionType:[2,1,1,""],Contains:[2,1,1,""],Notification:[2,1,1,""],OperationType:[2,1,1,""],Repository:[2,1,1,""],Tweet:[2,1,1,""],User:[2,1,1,""]},"nest_backend.database.tables.Alert":{__init__:[2,2,1,""],id:[2,3,1,""],limit:[2,3,1,""],name:[2,3,1,""],notifications:[2,3,1,""],operations:[2,3,1,""],repository:[2,3,1,""],repository_id:[2,3,1,""],to_json:[2,2,1,""],window_size:[2,3,1,""]},"nest_backend.database.tables.Authorization":{__init__:[2,2,1,""],email:[2,3,1,""],repository:[2,3,1,""],rid:[2,3,1,""],user:[2,3,1,""]},"nest_backend.database.tables.BoolOperation":{__init__:[2,2,1,""],alert:[2,3,1,""],alert_id:[2,3,1,""],condition:[2,3,1,""],condition_id:[2,3,1,""],father_1:[2,3,1,""],father_2:[2,3,1,""],get_chain_ids:[2,2,1,""],id:[2,3,1,""],isRoot:[2,3,1,""],node_1:[2,3,1,""],node_1_id:[2,3,1,""],node_2:[2,3,1,""],node_2_id:[2,3,1,""],operation:[2,3,1,""],to_json:[2,2,1,""]},"nest_backend.database.tables.Composed":{__init__:[2,2,1,""],repository:[2,3,1,""],rid:[2,3,1,""],snowflake:[2,3,1,""],tweet:[2,3,1,""]},"nest_backend.database.tables.Condition":{__init__:[2,2,1,""],content:[2,3,1,""],id:[2,3,1,""],operations:[2,3,1,""],repository:[2,3,1,""],repository_id:[2,3,1,""],to_json:[2,2,1,""],tweets:[2,3,1,""],type:[2,3,1,""]},"nest_backend.database.tables.ConditionType":{coordinates:[2,3,1,""],hashtag:[2,3,1,""],location:[2,3,1,""],place:[2,3,1,""],time:[2,3,1,""],user:[2,3,1,""]},"nest_backend.database.tables.Contains":{__init__:[2,2,1,""],cid:[2,3,1,""],condition:[2,3,1,""],snowflake:[2,3,1,""],tweet:[2,3,1,""]},"nest_backend.database.tables.Notification":{__init__:[2,2,1,""],alert:[2,3,1,""],alert_id:[2,3,1,""],id:[2,3,1,""],ora:[2,3,1,""],to_json:[2,2,1,""]},"nest_backend.database.tables.OperationType":{assign:[2,3,1,""]},"nest_backend.database.tables.Repository":{__init__:[2,2,1,""],alerts:[2,3,1,""],authorizations:[2,3,1,""],conditions:[2,3,1,""],end:[2,3,1,""],evaluation_mode:[2,3,1,""],id:[2,3,1,""],is_active:[2,3,1,""],name:[2,3,1,""],owner:[2,3,1,""],owner_id:[2,3,1,""],start:[2,3,1,""],to_json:[2,2,1,""],tweets:[2,3,1,""]},"nest_backend.database.tables.Tweet":{__init__:[2,2,1,""],conditions:[2,3,1,""],content:[2,3,1,""],location:[2,3,1,""],poster:[2,3,1,""],repositories:[2,3,1,""],snowflake:[2,3,1,""]},"nest_backend.database.tables.User":{__init__:[2,2,1,""],authorizations:[2,3,1,""],email:[2,3,1,""],isAdmin:[2,3,1,""],owner_of:[2,3,1,""],password:[2,3,1,""],to_json:[2,2,1,""],username:[2,3,1,""]},"nest_backend.gestione":{admin_or_403:[2,4,1,""],authenticate:[2,4,1,""],error_handler:[2,4,1,""],find_user:[2,4,1,""],gen_password:[2,4,1,""],identity:[2,4,1,""],json_error:[2,4,1,""],json_request_authorizer:[2,4,1,""],json_success:[2,4,1,""],repository_auth:[2,4,1,""]},nest_backend:{database:[2,0,0,"-"],gestione:[2,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:function"},terms:{"class":2,"enum":2,"function":2,"import":2,"return":2,Its:2,These:2,__init__:2,actual:2,add:2,admin_or_403:2,alert:2,alert_id:2,all:2,allow:2,alon:2,ani:2,api:0,applic:2,assign:2,attribut:2,authent:2,author:2,autogener:0,base:[0,1],becaus:2,booloper:2,check:2,cid:2,column:2,combin:2,compos:2,condit:2,condition_id:2,conditiontyp:2,construct:2,constructor:2,contain:2,content:2,coordin:2,core:[0,1],correct:2,could:2,credenti:2,data:2,databas:[0,1],decl_api:2,declar:2,dell:2,depend:2,els:2,email:2,end:2,enumer:2,error:2,error_handl:2,evaluation_mod:2,exampl:2,extens:[0,1],fact:2,fanci:2,father_1:2,father_2:2,find_us:2,flask:[0,1],format:2,from:2,gen_password:2,gener:2,gestion:[0,1],get_chain_id:2,gitlab:2,happi:2,hash:2,hashtag:2,ident:2,index:0,initi:2,instanc:2,is_act:2,isadmin:2,isroot:2,json:2,json_error:2,json_request_author:2,json_success:2,jwt:2,kei:2,kwarg:2,limit:2,littl:2,locat:2,login:2,mani:2,map:2,match:2,messag:2,method:[0,1],model:2,modul:[0,1],msg:2,name:2,need:2,nest_backend:[0,1],node_1:2,node_1_id:2,node_2:2,node_2_id:2,none:2,notif:2,onli:2,oper:2,operationtyp:2,ora:2,orm:2,owner:2,owner_id:2,owner_of:2,page:0,param:2,password:2,payload:2,place:2,platform:2,poster:2,present:2,python:0,refer:0,regist:2,relationship:2,repositori:2,repository_auth:2,repository_id:2,reqest:2,requir:2,rid:2,rout:[0,1],search:0,serializ:2,server:2,set:2,shouldnt:2,simpl:2,snowflak:2,specifica:2,sqlalchemi:2,start:2,string:2,success:2,system:2,tabl:1,thi:2,thing:2,thingamajig:2,time:2,to_json:2,tweet:2,type:2,used:2,user:2,usernam:2,using:2,util:[0,1],valid:2,valu:2,vedi:2,verif:2,want:2,whether:2,window_s:2,you:2},titles:["Welcome to N.E.S.T. Backend\u2019s documentation!","Autogenerated Python API reference","nest_backend - Core module"],titleterms:{api:[1,2],autogener:1,backend:0,base:2,core:2,databas:2,document:0,extens:2,flask:2,gestion:2,indic:0,method:2,modul:2,nest_backend:2,python:1,refer:1,rout:2,tabl:[0,2],util:2,welcom:0}}) \ No newline at end of file diff --git a/code/backend/docs/conf.py b/code/backend/docs/conf.py index 3d6b156..e9069fb 100644 --- a/code/backend/docs/conf.py +++ b/code/backend/docs/conf.py @@ -89,4 +89,5 @@ autodoc_default_options = { 'member-order': 'bysource', 'special-members': '__init__', 'undoc-members': True, + 'show-inheritance': True, } diff --git a/code/backend/docs/index.rst b/code/backend/docs/index.rst index e7bd449..8d78751 100644 --- a/code/backend/docs/index.rst +++ b/code/backend/docs/index.rst @@ -7,10 +7,9 @@ Welcome to N.E.S.T. Backend's documentation! ============================================ .. toctree:: - :maxdepth: 2 - :caption: Contents: + :maxdepth: 4 - modules + python_api/index diff --git a/code/backend/docs/modules.rst b/code/backend/docs/modules.rst deleted file mode 100644 index 33b15f7..0000000 --- a/code/backend/docs/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -backend -======= - -.. toctree:: - :maxdepth: 4 - - nest_backend diff --git a/code/backend/docs/nest_backend.database.rst b/code/backend/docs/nest_backend.database.rst deleted file mode 100644 index 388a200..0000000 --- a/code/backend/docs/nest_backend.database.rst +++ /dev/null @@ -1,29 +0,0 @@ -nest\_backend.database package -============================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - nest_backend.database.tables - -Submodules ----------- - -nest\_backend.database.base module ----------------------------------- - -.. automodule:: nest_backend.database.base - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nest_backend.database - :members: - :undoc-members: - :show-inheritance: diff --git a/code/backend/docs/nest_backend.database.tables.rst b/code/backend/docs/nest_backend.database.tables.rst deleted file mode 100644 index fc36d40..0000000 --- a/code/backend/docs/nest_backend.database.tables.rst +++ /dev/null @@ -1,109 +0,0 @@ -nest\_backend.database.tables package -===================================== - -Submodules ----------- - -nest\_backend.database.tables.Alert module ------------------------------------------- - -.. automodule:: nest_backend.database.tables.Alert - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.Authorization module --------------------------------------------------- - -.. automodule:: nest_backend.database.tables.Authorization - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.BoolOperation module --------------------------------------------------- - -.. automodule:: nest_backend.database.tables.BoolOperation - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.Composed module ---------------------------------------------- - -.. automodule:: nest_backend.database.tables.Composed - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.Condition module ----------------------------------------------- - -.. automodule:: nest_backend.database.tables.Condition - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.Contains module ---------------------------------------------- - -.. automodule:: nest_backend.database.tables.Contains - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.Enums module ------------------------------------------- - -.. automodule:: nest_backend.database.tables.Enums - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.Notification module -------------------------------------------------- - -.. automodule:: nest_backend.database.tables.Notification - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.Repository module ------------------------------------------------ - -.. automodule:: nest_backend.database.tables.Repository - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.Tweet module ------------------------------------------- - -.. automodule:: nest_backend.database.tables.Tweet - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.User module ------------------------------------------ - -.. automodule:: nest_backend.database.tables.User - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.database.tables.Uses module ------------------------------------------ - -.. automodule:: nest_backend.database.tables.Uses - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nest_backend.database.tables - :members: - :undoc-members: - :show-inheritance: diff --git a/code/backend/docs/nest_backend.routes.repository.rst b/code/backend/docs/nest_backend.routes.repository.rst deleted file mode 100644 index 0a1e100..0000000 --- a/code/backend/docs/nest_backend.routes.repository.rst +++ /dev/null @@ -1,45 +0,0 @@ -nest\_backend.routes.repository package -======================================= - -Submodules ----------- - -nest\_backend.routes.repository.repository\_add\_condition module ------------------------------------------------------------------ - -.. automodule:: nest_backend.routes.repository.repository_add_condition - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.routes.repository.repository\_create module ---------------------------------------------------------- - -.. automodule:: nest_backend.routes.repository.repository_create - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.routes.repository.repository\_edit module -------------------------------------------------------- - -.. automodule:: nest_backend.routes.repository.repository_edit - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.routes.repository.repository\_list module -------------------------------------------------------- - -.. automodule:: nest_backend.routes.repository.repository_list - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nest_backend.routes.repository - :members: - :undoc-members: - :show-inheritance: diff --git a/code/backend/docs/nest_backend.routes.rst b/code/backend/docs/nest_backend.routes.rst deleted file mode 100644 index bd2789a..0000000 --- a/code/backend/docs/nest_backend.routes.rst +++ /dev/null @@ -1,30 +0,0 @@ -nest\_backend.routes package -============================ - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - nest_backend.routes.repository - nest_backend.routes.users - -Submodules ----------- - -nest\_backend.routes.doa module -------------------------------- - -.. automodule:: nest_backend.routes.doa - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nest_backend.routes - :members: - :undoc-members: - :show-inheritance: diff --git a/code/backend/docs/nest_backend.routes.users.rst b/code/backend/docs/nest_backend.routes.users.rst deleted file mode 100644 index 2ce0ae4..0000000 --- a/code/backend/docs/nest_backend.routes.users.rst +++ /dev/null @@ -1,37 +0,0 @@ -nest\_backend.routes.users package -================================== - -Submodules ----------- - -nest\_backend.routes.users.login module ---------------------------------------- - -.. automodule:: nest_backend.routes.users.login - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.routes.users.user\_create module ----------------------------------------------- - -.. automodule:: nest_backend.routes.users.user_create - :members: - :undoc-members: - :show-inheritance: - -nest\_backend.routes.users.user\_delete module ----------------------------------------------- - -.. automodule:: nest_backend.routes.users.user_delete - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nest_backend.routes.users - :members: - :undoc-members: - :show-inheritance: diff --git a/code/backend/docs/nest_backend.rst b/code/backend/docs/nest_backend.rst deleted file mode 100644 index 23aa860..0000000 --- a/code/backend/docs/nest_backend.rst +++ /dev/null @@ -1,30 +0,0 @@ -nest\_backend package -===================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - nest_backend.database - nest_backend.routes - -Submodules ----------- - -nest\_backend.gestione module ------------------------------ - -.. automodule:: nest_backend.gestione - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nest_backend - :members: - :undoc-members: - :show-inheritance: diff --git a/code/backend/docs/python_api/index.rst b/code/backend/docs/python_api/index.rst new file mode 100644 index 0000000..eac9195 --- /dev/null +++ b/code/backend/docs/python_api/index.rst @@ -0,0 +1,7 @@ +Autogenerated Python API reference +================================== + +.. toctree:: + :maxdepth: 4 + + nest_backend diff --git a/code/backend/docs/python_api/nest_backend.rst b/code/backend/docs/python_api/nest_backend.rst new file mode 100644 index 0000000..d70d348 --- /dev/null +++ b/code/backend/docs/python_api/nest_backend.rst @@ -0,0 +1,37 @@ +``nest_backend`` - Core module +============================== + +.. automodule:: nest_backend + + +``.gestione`` - Utility methods +------------------------------- + +.. automodule:: nest_backend.gestione + + +``.database`` - Database +------------------------ + +.. automodule:: nest_backend.database + + +``.base`` - Flask extension +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: nest_backend.database.base + + +``.tables`` - Database tables +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: nest_backend.database.tables + :imported-members: + + +``.routes`` - API routes +------------------------ + +.. automodule:: nest_backend.database.routes + :imported-members: + diff --git a/code/backend/nest_backend/gestione.py b/code/backend/nest_backend/gestione.py index 4e38949..6b1f60e 100644 --- a/code/backend/nest_backend/gestione.py +++ b/code/backend/nest_backend/gestione.py @@ -1,7 +1,4 @@ """ -A utilities Python Module. --------------------------- - Gestione adds many fancy thingamajigs to the flask application, such as a login system and such. """ diff --git a/code/backend/poetry.lock b/code/backend/poetry.lock index 8aaf7de..131cdf3 100644 --- a/code/backend/poetry.lock +++ b/code/backend/poetry.lock @@ -279,6 +279,14 @@ MarkupSafe = ">=0.23" [package.extras] i18n = ["Babel (>=0.8)"] +[[package]] +name = "joblib" +version = "1.0.1" +description = "Lightweight pipelining with Python functions" +category = "main" +optional = false +python-versions = ">=3.6" + [[package]] name = "jsonschema" version = "3.2.0" @@ -296,14 +304,6 @@ six = ">=1.11.0" format = ["idna", "jsonpointer (>1.13)", "rfc3987", "strict-rfc3339", "webcolors"] format_nongpl = ["idna", "jsonpointer (>1.13)", "webcolors", "rfc3986-validator (>0.1.0)", "rfc3339-validator"] -[[package]] -name = "joblib" -version = "1.0.1" -description = "Lightweight pipelining with Python functions" -category = "main" -optional = false -python-versions = ">=3.6" - [[package]] name = "markupsafe" version = "1.1.1" @@ -326,6 +326,41 @@ docs = ["sphinx (==3.4.3)", "sphinx-issues (==1.2.0)", "alabaster (==0.7.12)", " lint = ["mypy (==0.812)", "flake8 (==3.9.0)", "flake8-bugbear (==21.3.2)", "pre-commit (>=2.4,<3.0)"] tests = ["pytest", "pytz", "simplejson"] +[[package]] +name = "nltk" +version = "3.6.2" +description = "Natural Language Toolkit" +category = "main" +optional = false +python-versions = ">=3.5.*" + +[package.dependencies] +click = "*" +joblib = "*" +regex = "*" +tqdm = "*" + +[package.extras] +all = ["matplotlib", "twython", "scipy", "numpy", "gensim (<4.0.0)", "python-crfsuite", "pyparsing", "scikit-learn", "requests"] +corenlp = ["requests"] +machine_learning = ["gensim (<4.0.0)", "numpy", "python-crfsuite", "scikit-learn", "scipy"] +plot = ["matplotlib"] +tgrep = ["pyparsing"] +twitter = ["twython"] + +[[package]] +name = "oauthlib" +version = "3.1.0" +description = "A generic, spec-compliant, thorough implementation of the OAuth request-signing logic" +category = "main" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" + +[package.extras] +rsa = ["cryptography"] +signals = ["blinker"] +signedtoken = ["cryptography", "pyjwt (>=1.0.0)"] + [[package]] name = "openapi-schema-validator" version = "0.1.5" @@ -362,41 +397,6 @@ six = "*" dev = ["pre-commit"] requests = ["requests"] -[[package]] -name = "nltk" -version = "3.6.2" -description = "Natural Language Toolkit" -category = "main" -optional = false -python-versions = ">=3.5.*" - -[package.dependencies] -click = "*" -joblib = "*" -regex = "*" -tqdm = "*" - -[package.extras] -all = ["matplotlib", "twython", "scipy", "numpy", "gensim (<4.0.0)", "python-crfsuite", "pyparsing", "scikit-learn", "requests"] -corenlp = ["requests"] -machine_learning = ["gensim (<4.0.0)", "numpy", "python-crfsuite", "scikit-learn", "scipy"] -plot = ["matplotlib"] -tgrep = ["pyparsing"] -twitter = ["twython"] - -[[package]] -name = "oauthlib" -version = "3.1.0" -description = "A generic, spec-compliant, thorough implementation of the OAuth request-signing logic" -category = "main" -optional = false -python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" - -[package.extras] -rsa = ["cryptography"] -signals = ["blinker"] -signedtoken = ["cryptography", "pyjwt (>=1.0.0)"] - [[package]] name = "packaging" version = "20.9" @@ -615,6 +615,21 @@ docs = ["sphinxcontrib-websupport"] lint = ["flake8 (>=3.5.0)", "isort", "mypy (>=0.800)", "docutils-stubs"] test = ["pytest", "pytest-cov", "html5lib", "cython", "typed-ast"] +[[package]] +name = "sphinx-rtd-theme" +version = "0.5.2" +description = "Read the Docs theme for Sphinx" +category = "dev" +optional = false +python-versions = "*" + +[package.dependencies] +docutils = "<0.17" +sphinx = "*" + +[package.extras] +dev = ["transifex-client", "sphinxcontrib-httpdomain", "bump2version"] + [[package]] name = "sphinxcontrib-applehelp" version = "1.0.2" @@ -783,7 +798,7 @@ watchdog = ["watchdog"] [metadata] lock-version = "1.1" python-versions = "^3.8.5" -content-hash = "aff9d3d076a3c5fed551f6a1a1502e6d34ee1e2c2e385695cf4c55015dceda8a" +content-hash = "9c4f3517887f1d12fc4196119a7d3398fa61a5214809fcfd1a324d87ca8baeaf" [metadata.files] alabaster = [ @@ -972,14 +987,14 @@ jinja2 = [ {file = "Jinja2-2.11.3-py2.py3-none-any.whl", hash = "sha256:03e47ad063331dd6a3f04a43eddca8a966a26ba0c5b7207a9a9e4e08f1b29419"}, {file = "Jinja2-2.11.3.tar.gz", hash = "sha256:a6d58433de0ae800347cab1fa3043cebbabe8baa9d29e668f1c768cb87a333c6"}, ] -jsonschema = [ - {file = "jsonschema-3.2.0-py2.py3-none-any.whl", hash = "sha256:4e5b3cf8216f577bee9ce139cbe72eca3ea4f292ec60928ff24758ce626cd163"}, - {file = "jsonschema-3.2.0.tar.gz", hash = "sha256:c8a85b28d377cc7737e46e2d9f2b4f44ee3c0e1deac6bf46ddefc7187d30797a"}, -] joblib = [ {file = "joblib-1.0.1-py3-none-any.whl", hash = "sha256:feeb1ec69c4d45129954f1b7034954241eedfd6ba39b5e9e4b6883be3332d5e5"}, {file = "joblib-1.0.1.tar.gz", hash = "sha256:9c17567692206d2f3fb9ecf5e991084254fe631665c450b443761c4186a613f7"}, ] +jsonschema = [ + {file = "jsonschema-3.2.0-py2.py3-none-any.whl", hash = "sha256:4e5b3cf8216f577bee9ce139cbe72eca3ea4f292ec60928ff24758ce626cd163"}, + {file = "jsonschema-3.2.0.tar.gz", hash = "sha256:c8a85b28d377cc7737e46e2d9f2b4f44ee3c0e1deac6bf46ddefc7187d30797a"}, +] markupsafe = [ {file = "MarkupSafe-1.1.1-cp27-cp27m-macosx_10_6_intel.whl", hash = "sha256:09027a7803a62ca78792ad89403b1b7a73a01c8cb65909cd876f7fcebd79b161"}, {file = "MarkupSafe-1.1.1-cp27-cp27m-manylinux1_i686.whl", hash = "sha256:e249096428b3ae81b08327a63a485ad0878de3fb939049038579ac0ef61e17e7"}, @@ -1034,6 +1049,10 @@ markupsafe = [ {file = "MarkupSafe-1.1.1-cp39-cp39-win_amd64.whl", hash = "sha256:b7d644ddb4dbd407d31ffb699f1d140bc35478da613b441c582aeb7c43838dd8"}, {file = "MarkupSafe-1.1.1.tar.gz", hash = "sha256:29872e92839765e546828bb7754a68c418d927cd064fd4708fab9fe9c8bb116b"}, ] +marshmallow = [ + {file = "marshmallow-3.11.1-py2.py3-none-any.whl", hash = "sha256:0dd42891a5ef288217ed6410917f3c6048f585f8692075a0052c24f9bfff9dfd"}, + {file = "marshmallow-3.11.1.tar.gz", hash = "sha256:16e99cb7f630c0ef4d7d364ed0109ac194268dde123966076ab3dafb9ae3906b"}, +] nltk = [ {file = "nltk-3.6.2-py3-none-any.whl", hash = "sha256:240e23ab1ab159ef9940777d30c7c72d7e76d91877099218a7585370c11f6b9e"}, {file = "nltk-3.6.2.zip", hash = "sha256:57d556abed621ab9be225cc6d2df1edce17572efb67a3d754630c9f8381503eb"}, @@ -1042,10 +1061,6 @@ oauthlib = [ {file = "oauthlib-3.1.0-py2.py3-none-any.whl", hash = "sha256:df884cd6cbe20e32633f1db1072e9356f53638e4361bef4e8b03c9127c9328ea"}, {file = "oauthlib-3.1.0.tar.gz", hash = "sha256:bee41cc35fcca6e988463cacc3bcb8a96224f470ca547e697b604cc697b2f889"}, ] -marshmallow = [ - {file = "marshmallow-3.11.1-py2.py3-none-any.whl", hash = "sha256:0dd42891a5ef288217ed6410917f3c6048f585f8692075a0052c24f9bfff9dfd"}, - {file = "marshmallow-3.11.1.tar.gz", hash = "sha256:16e99cb7f630c0ef4d7d364ed0109ac194268dde123966076ab3dafb9ae3906b"}, -] openapi-schema-validator = [ {file = "openapi-schema-validator-0.1.5.tar.gz", hash = "sha256:a4b2712020284cee880b4c55faa513fbc2f8f07f365deda6098f8ab943c9f0df"}, {file = "openapi_schema_validator-0.1.5-py2-none-any.whl", hash = "sha256:215b516d0942f4e8e2446cf3f7d4ff2ed71d102ebddcc30526d8a3f706ab1df6"}, @@ -1232,6 +1247,10 @@ sphinx = [ {file = "Sphinx-3.5.4-py3-none-any.whl", hash = "sha256:2320d4e994a191f4b4be27da514e46b3d6b420f2ff895d064f52415d342461e8"}, {file = "Sphinx-3.5.4.tar.gz", hash = "sha256:19010b7b9fa0dc7756a6e105b2aacd3a80f798af3c25c273be64d7beeb482cb1"}, ] +sphinx-rtd-theme = [ + {file = "sphinx_rtd_theme-0.5.2-py2.py3-none-any.whl", hash = "sha256:4a05bdbe8b1446d77a01e20a23ebc6777c74f43237035e76be89699308987d6f"}, + {file = "sphinx_rtd_theme-0.5.2.tar.gz", hash = "sha256:32bd3b5d13dc8186d7a42fc816a23d32e83a4827d7d9882948e7b837c232da5a"}, +] sphinxcontrib-applehelp = [ {file = "sphinxcontrib-applehelp-1.0.2.tar.gz", hash = "sha256:a072735ec80e7675e3f432fcae8610ecf509c5f1869d17e2eecff44389cdbc58"}, {file = "sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl", hash = "sha256:806111e5e962be97c29ec4c1e7fe277bfd19e9652fb1a4392105b43e01af885a"}, diff --git a/code/backend/pyproject.toml b/code/backend/pyproject.toml index 16f9d41..3f66410 100644 --- a/code/backend/pyproject.toml +++ b/code/backend/pyproject.toml @@ -32,6 +32,7 @@ nltk = "^3.6.2" [tool.poetry.dev-dependencies] pytest = "^6.2.3" Sphinx = "^3.5.4" +sphinx-rtd-theme = "^0.5.2" [build-system] requires = ["poetry-core>=1.0.0"]