mirror of
https://github.com/pds-nest/nest.git
synced 2024-11-22 13:04:19 +00:00
Merge remote-tracking branch 'origin/main' into main
This commit is contained in:
commit
cc788ef936
181 changed files with 8326 additions and 4287 deletions
|
@ -24,6 +24,8 @@
|
||||||
<option name="myCustomValuesEnabled" value="true" />
|
<option name="myCustomValuesEnabled" value="true" />
|
||||||
</inspection_tool>
|
</inspection_tool>
|
||||||
<inspection_tool class="InconsistentLineSeparators" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
|
<inspection_tool class="InconsistentLineSeparators" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
|
||||||
|
<inspection_tool class="JSUnresolvedFunction" enabled="true" level="ERROR" enabled_by_default="true" />
|
||||||
|
<inspection_tool class="JSUnresolvedVariable" enabled="true" level="ERROR" enabled_by_default="true" />
|
||||||
<inspection_tool class="JupyterPackageInspection" enabled="true" level="ERROR" enabled_by_default="true" />
|
<inspection_tool class="JupyterPackageInspection" enabled="true" level="ERROR" enabled_by_default="true" />
|
||||||
<inspection_tool class="LessResolvedByNameOnly" enabled="true" level="WARNING" enabled_by_default="true" />
|
<inspection_tool class="LessResolvedByNameOnly" enabled="true" level="WARNING" enabled_by_default="true" />
|
||||||
<inspection_tool class="LessUnresolvedMixin" enabled="true" level="ERROR" enabled_by_default="true" />
|
<inspection_tool class="LessUnresolvedMixin" enabled="true" level="ERROR" enabled_by_default="true" />
|
||||||
|
|
|
@ -6,6 +6,7 @@
|
||||||
<sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
|
<sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
|
||||||
<excludeFolder url="file://$MODULE_DIR$/doc" />
|
<excludeFolder url="file://$MODULE_DIR$/doc" />
|
||||||
<excludeFolder url="file://$MODULE_DIR$/database" />
|
<excludeFolder url="file://$MODULE_DIR$/database" />
|
||||||
|
<excludeFolder url="file://$MODULE_DIR$/.idea/dataSources" />
|
||||||
</content>
|
</content>
|
||||||
<orderEntry type="inheritedJdk" />
|
<orderEntry type="inheritedJdk" />
|
||||||
<orderEntry type="sourceFolder" forTests="false" />
|
<orderEntry type="sourceFolder" forTests="false" />
|
||||||
|
|
2
code/backend/.gitignore
vendored
2
code/backend/.gitignore
vendored
|
@ -74,7 +74,7 @@ instance/
|
||||||
.scrapy
|
.scrapy
|
||||||
|
|
||||||
# Sphinx documentation
|
# Sphinx documentation
|
||||||
docs/_build/
|
#docs/_build/
|
||||||
|
|
||||||
# PyBuilder
|
# PyBuilder
|
||||||
.pybuilder/
|
.pybuilder/
|
||||||
|
|
|
@ -26,6 +26,7 @@ Questo creerà un nuovo venv nelle cartelle interne di Poetry e vi installerà a
|
||||||
## Configurazione
|
## Configurazione
|
||||||
|
|
||||||
### Configurazione del Database
|
### Configurazione del Database
|
||||||
|
|
||||||
Dopo aver installato Postgres, è necessario creare un database dedicato all'applicazione (ad esempio PdSTest).
|
Dopo aver installato Postgres, è necessario creare un database dedicato all'applicazione (ad esempio PdSTest).
|
||||||
Se si desidera, si può anche creare un utente dedicato (l'utente postgres di default va benissimo).
|
Se si desidera, si può anche creare un utente dedicato (l'utente postgres di default va benissimo).
|
||||||
Per configurare l'URI del database che N.E.S.T. andrà a impiegare, è necessario eseguire
|
Per configurare l'URI del database che N.E.S.T. andrà a impiegare, è necessario eseguire
|
||||||
|
@ -37,6 +38,7 @@ export DATABASE_URI=postgresql://[postgresUser]:[postgresPassword]@localhost:[po
|
||||||
Ora il database è pronto per l'uso.
|
Ora il database è pronto per l'uso.
|
||||||
|
|
||||||
### Altre variabili d'ambiente
|
### Altre variabili d'ambiente
|
||||||
|
|
||||||
Questo ultimo passaggio è importante solo in un ambiente non-dev. La configurazione andrà a valore di default nel caso
|
Questo ultimo passaggio è importante solo in un ambiente non-dev. La configurazione andrà a valore di default nel caso
|
||||||
in cui queste variabili non siano definite.
|
in cui queste variabili non siano definite.
|
||||||
Per terminare la configurazione, eseguire:
|
Per terminare la configurazione, eseguire:
|
||||||
|
|
|
@ -7,6 +7,7 @@
|
||||||
<sourceFolder url="file://$MODULE_DIR$/nest_backend/test" isTestSource="true" />
|
<sourceFolder url="file://$MODULE_DIR$/nest_backend/test" isTestSource="true" />
|
||||||
<sourceFolder url="file://$MODULE_DIR$/old_unittest_tests" isTestSource="true" />
|
<sourceFolder url="file://$MODULE_DIR$/old_unittest_tests" isTestSource="true" />
|
||||||
<excludeFolder url="file://$MODULE_DIR$/docs/_build" />
|
<excludeFolder url="file://$MODULE_DIR$/docs/_build" />
|
||||||
|
<excludeFolder url="file://$MODULE_DIR$/.pytest_cache" />
|
||||||
</content>
|
</content>
|
||||||
<orderEntry type="jdk" jdkName="Poetry (backend)" jdkType="Python SDK" />
|
<orderEntry type="jdk" jdkName="Poetry (backend)" jdkType="Python SDK" />
|
||||||
<orderEntry type="sourceFolder" forTests="false" />
|
<orderEntry type="sourceFolder" forTests="false" />
|
||||||
|
|
BIN
code/backend/docs/_build/doctrees/environment.pickle
vendored
BIN
code/backend/docs/_build/doctrees/environment.pickle
vendored
Binary file not shown.
BIN
code/backend/docs/_build/doctrees/index.doctree
vendored
BIN
code/backend/docs/_build/doctrees/index.doctree
vendored
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
BIN
code/backend/docs/_build/doctrees/python_api/nest_backend.doctree
vendored
Normal file
BIN
code/backend/docs/_build/doctrees/python_api/nest_backend.doctree
vendored
Normal file
Binary file not shown.
2
code/backend/docs/_build/html/.buildinfo
vendored
2
code/backend/docs/_build/html/.buildinfo
vendored
|
@ -1,4 +1,4 @@
|
||||||
# Sphinx build info version 1
|
# 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.
|
# 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
|
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||||
|
|
|
@ -7,10 +7,9 @@ Welcome to N.E.S.T. Backend's documentation!
|
||||||
============================================
|
============================================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 4
|
||||||
:caption: Contents:
|
|
||||||
|
|
||||||
modules
|
python_api/index
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -1,7 +0,0 @@
|
||||||
backend
|
|
||||||
=======
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 4
|
|
||||||
|
|
||||||
nest_backend
|
|
|
@ -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:
|
|
|
@ -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:
|
|
|
@ -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:
|
|
|
@ -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:
|
|
|
@ -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:
|
|
|
@ -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:
|
|
7
code/backend/docs/_build/html/_sources/python_api/index.rst.txt
vendored
Normal file
7
code/backend/docs/_build/html/_sources/python_api/index.rst.txt
vendored
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
Autogenerated Python API reference
|
||||||
|
==================================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 4
|
||||||
|
|
||||||
|
nest_backend
|
37
code/backend/docs/_build/html/_sources/python_api/nest_backend.rst.txt
vendored
Normal file
37
code/backend/docs/_build/html/_sources/python_api/nest_backend.rst.txt
vendored
Normal file
|
@ -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:
|
||||||
|
|
701
code/backend/docs/_build/html/_static/alabaster.css
vendored
701
code/backend/docs/_build/html/_static/alabaster.css
vendored
|
@ -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;
|
|
||||||
}
|
|
||||||
}
|
|
1
code/backend/docs/_build/html/_static/css/badge_only.css
vendored
Normal file
1
code/backend/docs/_build/html/_static/css/badge_only.css
vendored
Normal file
|
@ -0,0 +1 @@
|
||||||
|
.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
|
BIN
code/backend/docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff2
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff2
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff2
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff2
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/css/fonts/fontawesome-webfont.eot
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/css/fonts/fontawesome-webfont.eot
vendored
Normal file
Binary file not shown.
2671
code/backend/docs/_build/html/_static/css/fonts/fontawesome-webfont.svg
vendored
Normal file
2671
code/backend/docs/_build/html/_static/css/fonts/fontawesome-webfont.svg
vendored
Normal file
File diff suppressed because it is too large
Load diff
After Width: | Height: | Size: 434 KiB |
BIN
code/backend/docs/_build/html/_static/css/fonts/fontawesome-webfont.ttf
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/css/fonts/fontawesome-webfont.ttf
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/css/fonts/fontawesome-webfont.woff
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/css/fonts/fontawesome-webfont.woff
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/css/fonts/fontawesome-webfont.woff2
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/css/fonts/fontawesome-webfont.woff2
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/css/fonts/lato-bold-italic.woff
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/css/fonts/lato-bold-italic.woff
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/css/fonts/lato-bold-italic.woff2
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/css/fonts/lato-bold-italic.woff2
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/css/fonts/lato-bold.woff
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/css/fonts/lato-bold.woff
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/css/fonts/lato-bold.woff2
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/css/fonts/lato-bold.woff2
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/css/fonts/lato-normal-italic.woff
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/css/fonts/lato-normal-italic.woff
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/css/fonts/lato-normal-italic.woff2
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/css/fonts/lato-normal-italic.woff2
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/css/fonts/lato-normal.woff
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/css/fonts/lato-normal.woff
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/css/fonts/lato-normal.woff2
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/css/fonts/lato-normal.woff2
vendored
Normal file
Binary file not shown.
4
code/backend/docs/_build/html/_static/css/theme.css
vendored
Normal file
4
code/backend/docs/_build/html/_static/css/theme.css
vendored
Normal file
File diff suppressed because one or more lines are too long
|
@ -1 +0,0 @@
|
||||||
/* This file intentionally left blank. */
|
|
|
@ -1,6 +1,6 @@
|
||||||
var DOCUMENTATION_OPTIONS = {
|
var DOCUMENTATION_OPTIONS = {
|
||||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||||
VERSION: '',
|
VERSION: '0.1.0',
|
||||||
LANGUAGE: 'None',
|
LANGUAGE: 'None',
|
||||||
COLLAPSE_INDEX: false,
|
COLLAPSE_INDEX: false,
|
||||||
BUILDER: 'html',
|
BUILDER: 'html',
|
||||||
|
|
BIN
code/backend/docs/_build/html/_static/fonts/Inconsolata-Bold.ttf
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Inconsolata-Bold.ttf
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Inconsolata-Regular.ttf
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Inconsolata-Regular.ttf
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Inconsolata.ttf
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Inconsolata.ttf
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Lato-Bold.ttf
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Lato-Bold.ttf
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Lato-Regular.ttf
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Lato-Regular.ttf
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-bold.eot
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-bold.eot
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-bold.ttf
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-bold.ttf
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-bold.woff
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-bold.woff
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-bold.woff2
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-bold.woff2
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-bolditalic.eot
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-bolditalic.eot
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-bolditalic.ttf
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-bolditalic.ttf
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-bolditalic.woff
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-bolditalic.woff
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-bolditalic.woff2
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-bolditalic.woff2
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-italic.eot
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-italic.eot
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-italic.ttf
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-italic.ttf
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-italic.woff
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-italic.woff
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-italic.woff2
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-italic.woff2
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-regular.eot
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-regular.eot
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-regular.ttf
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-regular.ttf
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-regular.woff
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-regular.woff
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-regular.woff2
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/Lato/lato-regular.woff2
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab-Bold.ttf
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab-Bold.ttf
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab-Regular.ttf
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab-Regular.ttf
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/fontawesome-webfont.eot
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/fontawesome-webfont.eot
vendored
Normal file
Binary file not shown.
2671
code/backend/docs/_build/html/_static/fonts/fontawesome-webfont.svg
vendored
Normal file
2671
code/backend/docs/_build/html/_static/fonts/fontawesome-webfont.svg
vendored
Normal file
File diff suppressed because it is too large
Load diff
After Width: | Height: | Size: 434 KiB |
BIN
code/backend/docs/_build/html/_static/fonts/fontawesome-webfont.ttf
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/fontawesome-webfont.ttf
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/fontawesome-webfont.woff
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/fontawesome-webfont.woff
vendored
Normal file
Binary file not shown.
BIN
code/backend/docs/_build/html/_static/fonts/fontawesome-webfont.woff2
vendored
Normal file
BIN
code/backend/docs/_build/html/_static/fonts/fontawesome-webfont.woff2
vendored
Normal file
Binary file not shown.
1
code/backend/docs/_build/html/_static/js/badge_only.js
vendored
Normal file
1
code/backend/docs/_build/html/_static/js/badge_only.js
vendored
Normal file
|
@ -0,0 +1 @@
|
||||||
|
!function(e){var t={};function r(n){if(t[n])return t[n].exports;var o=t[n]={i:n,l:!1,exports:{}};return e[n].call(o.exports,o,o.exports,r),o.l=!0,o.exports}r.m=e,r.c=t,r.d=function(e,t,n){r.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:n})},r.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)r.d(n,o,function(t){return e[t]}.bind(null,o));return n},r.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return r.d(t,"a",t),t},r.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r.p="",r(r.s=4)}({4:function(e,t,r){}});
|
4
code/backend/docs/_build/html/_static/js/html5shiv-printshiv.min.js
vendored
Normal file
4
code/backend/docs/_build/html/_static/js/html5shiv-printshiv.min.js
vendored
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
/**
|
||||||
|
* @preserve HTML5 Shiv 3.7.3-pre | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
|
||||||
|
*/
|
||||||
|
!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document);
|
4
code/backend/docs/_build/html/_static/js/html5shiv.min.js
vendored
Normal file
4
code/backend/docs/_build/html/_static/js/html5shiv.min.js
vendored
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
/**
|
||||||
|
* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
|
||||||
|
*/
|
||||||
|
!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document);
|
4
code/backend/docs/_build/html/_static/js/modernizr.min.js
vendored
Normal file
4
code/backend/docs/_build/html/_static/js/modernizr.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
1
code/backend/docs/_build/html/_static/js/theme.js
vendored
Normal file
1
code/backend/docs/_build/html/_static/js/theme.js
vendored
Normal file
|
@ -0,0 +1 @@
|
||||||
|
!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("<div class='wy-table-responsive'></div>"),n("table.docutils.footnote").wrap("<div class='wy-table-responsive footnote'></div>"),n("table.docutils.citation").wrap("<div class='wy-table-responsive citation'></div>"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n('<span class="toctree-expand"></span>'),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}t.length>0&&($(".wy-menu-vertical .current").removeClass("current"),t.addClass("current"),t.closest("li.toctree-l1").addClass("current"),t.closest("li.toctree-l1").parent().addClass("current"),t.closest("li.toctree-l1").addClass("current"),t.closest("li.toctree-l2").addClass("current"),t.closest("li.toctree-l3").addClass("current"),t.closest("li.toctree-l4").addClass("current"),t.closest("li.toctree-l5").addClass("current"),t[0].scrollIntoView())}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current"),e.find("> ul li.current").removeClass("current"),e.toggleClass("current")}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t<e.length&&!window.requestAnimationFrame;++t)window.requestAnimationFrame=window[e[t]+"RequestAnimationFrame"],window.cancelAnimationFrame=window[e[t]+"CancelAnimationFrame"]||window[e[t]+"CancelRequestAnimationFrame"];window.requestAnimationFrame||(window.requestAnimationFrame=function(e,t){var i=(new Date).getTime(),o=Math.max(0,16-(i-n)),r=window.setTimeout((function(){e(i+o)}),o);return n=i+o,r}),window.cancelAnimationFrame||(window.cancelAnimationFrame=function(n){clearTimeout(n)})}()}).call(window)},function(n,e){n.exports=jQuery},function(n,e,t){}]);
|
134
code/backend/docs/_build/html/_static/pygments.css
vendored
134
code/backend/docs/_build/html/_static/pygments.css
vendored
|
@ -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; }
|
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
||||||
.highlight .hll { background-color: #ffffcc }
|
.highlight .hll { background-color: #ffffcc }
|
||||||
.highlight { background: #f8f8f8; }
|
.highlight { background: #f8f8f8; }
|
||||||
.highlight .c { color: #8f5902; font-style: italic } /* Comment */
|
.highlight .c { color: #408080; font-style: italic } /* Comment */
|
||||||
.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */
|
.highlight .err { border: 1px solid #FF0000 } /* Error */
|
||||||
.highlight .g { color: #000000 } /* Generic */
|
.highlight .k { color: #008000; font-weight: bold } /* Keyword */
|
||||||
.highlight .k { color: #004461; font-weight: bold } /* Keyword */
|
.highlight .o { color: #666666 } /* Operator */
|
||||||
.highlight .l { color: #000000 } /* Literal */
|
.highlight .ch { color: #408080; font-style: italic } /* Comment.Hashbang */
|
||||||
.highlight .n { color: #000000 } /* Name */
|
.highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */
|
||||||
.highlight .o { color: #582800 } /* Operator */
|
.highlight .cp { color: #BC7A00 } /* Comment.Preproc */
|
||||||
.highlight .x { color: #000000 } /* Other */
|
.highlight .cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */
|
||||||
.highlight .p { color: #000000; font-weight: bold } /* Punctuation */
|
.highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */
|
||||||
.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */
|
.highlight .cs { color: #408080; font-style: italic } /* Comment.Special */
|
||||||
.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */
|
.highlight .gd { color: #A00000 } /* Generic.Deleted */
|
||||||
.highlight .cp { color: #8f5902 } /* Comment.Preproc */
|
.highlight .ge { font-style: italic } /* Generic.Emph */
|
||||||
.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */
|
.highlight .gr { color: #FF0000 } /* Generic.Error */
|
||||||
.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 .gh { color: #000080; font-weight: bold } /* Generic.Heading */
|
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
|
||||||
.highlight .gi { color: #00A000 } /* Generic.Inserted */
|
.highlight .gi { color: #00A000 } /* Generic.Inserted */
|
||||||
.highlight .go { color: #888888 } /* Generic.Output */
|
.highlight .go { color: #888888 } /* Generic.Output */
|
||||||
.highlight .gp { color: #745334 } /* Generic.Prompt */
|
.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
|
||||||
.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */
|
.highlight .gs { font-weight: bold } /* Generic.Strong */
|
||||||
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
|
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
|
||||||
.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */
|
.highlight .gt { color: #0044DD } /* Generic.Traceback */
|
||||||
.highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */
|
.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
|
||||||
.highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */
|
.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
|
||||||
.highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */
|
.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
|
||||||
.highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */
|
.highlight .kp { color: #008000 } /* Keyword.Pseudo */
|
||||||
.highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */
|
.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
|
||||||
.highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */
|
.highlight .kt { color: #B00040 } /* Keyword.Type */
|
||||||
.highlight .ld { color: #000000 } /* Literal.Date */
|
.highlight .m { color: #666666 } /* Literal.Number */
|
||||||
.highlight .m { color: #990000 } /* Literal.Number */
|
.highlight .s { color: #BA2121 } /* Literal.String */
|
||||||
.highlight .s { color: #4e9a06 } /* Literal.String */
|
.highlight .na { color: #7D9029 } /* Name.Attribute */
|
||||||
.highlight .na { color: #c4a000 } /* Name.Attribute */
|
.highlight .nb { color: #008000 } /* Name.Builtin */
|
||||||
.highlight .nb { color: #004461 } /* Name.Builtin */
|
.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
|
||||||
.highlight .nc { color: #000000 } /* Name.Class */
|
.highlight .no { color: #880000 } /* Name.Constant */
|
||||||
.highlight .no { color: #000000 } /* Name.Constant */
|
.highlight .nd { color: #AA22FF } /* Name.Decorator */
|
||||||
.highlight .nd { color: #888888 } /* Name.Decorator */
|
.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
|
||||||
.highlight .ni { color: #ce5c00 } /* Name.Entity */
|
.highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
|
||||||
.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */
|
.highlight .nf { color: #0000FF } /* Name.Function */
|
||||||
.highlight .nf { color: #000000 } /* Name.Function */
|
.highlight .nl { color: #A0A000 } /* Name.Label */
|
||||||
.highlight .nl { color: #f57900 } /* Name.Label */
|
.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
|
||||||
.highlight .nn { color: #000000 } /* Name.Namespace */
|
.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
|
||||||
.highlight .nx { color: #000000 } /* Name.Other */
|
.highlight .nv { color: #19177C } /* Name.Variable */
|
||||||
.highlight .py { color: #000000 } /* Name.Property */
|
.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
|
||||||
.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */
|
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
|
||||||
.highlight .nv { color: #000000 } /* Name.Variable */
|
.highlight .mb { color: #666666 } /* Literal.Number.Bin */
|
||||||
.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */
|
.highlight .mf { color: #666666 } /* Literal.Number.Float */
|
||||||
.highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */
|
.highlight .mh { color: #666666 } /* Literal.Number.Hex */
|
||||||
.highlight .mb { color: #990000 } /* Literal.Number.Bin */
|
.highlight .mi { color: #666666 } /* Literal.Number.Integer */
|
||||||
.highlight .mf { color: #990000 } /* Literal.Number.Float */
|
.highlight .mo { color: #666666 } /* Literal.Number.Oct */
|
||||||
.highlight .mh { color: #990000 } /* Literal.Number.Hex */
|
.highlight .sa { color: #BA2121 } /* Literal.String.Affix */
|
||||||
.highlight .mi { color: #990000 } /* Literal.Number.Integer */
|
.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
|
||||||
.highlight .mo { color: #990000 } /* Literal.Number.Oct */
|
.highlight .sc { color: #BA2121 } /* Literal.String.Char */
|
||||||
.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */
|
.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */
|
||||||
.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */
|
.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
|
||||||
.highlight .sc { color: #4e9a06 } /* Literal.String.Char */
|
.highlight .s2 { color: #BA2121 } /* Literal.String.Double */
|
||||||
.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */
|
.highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
|
||||||
.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */
|
.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
|
||||||
.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */
|
.highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
|
||||||
.highlight .se { color: #4e9a06 } /* Literal.String.Escape */
|
.highlight .sx { color: #008000 } /* Literal.String.Other */
|
||||||
.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */
|
.highlight .sr { color: #BB6688 } /* Literal.String.Regex */
|
||||||
.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */
|
.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
|
||||||
.highlight .sx { color: #4e9a06 } /* Literal.String.Other */
|
.highlight .ss { color: #19177C } /* Literal.String.Symbol */
|
||||||
.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */
|
.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
|
||||||
.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */
|
.highlight .fm { color: #0000FF } /* Name.Function.Magic */
|
||||||
.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */
|
.highlight .vc { color: #19177C } /* Name.Variable.Class */
|
||||||
.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */
|
.highlight .vg { color: #19177C } /* Name.Variable.Global */
|
||||||
.highlight .fm { color: #000000 } /* Name.Function.Magic */
|
.highlight .vi { color: #19177C } /* Name.Variable.Instance */
|
||||||
.highlight .vc { color: #000000 } /* Name.Variable.Class */
|
.highlight .vm { color: #19177C } /* Name.Variable.Magic */
|
||||||
.highlight .vg { color: #000000 } /* Name.Variable.Global */
|
.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
|
||||||
.highlight .vi { color: #000000 } /* Name.Variable.Instance */
|
|
||||||
.highlight .vm { color: #000000 } /* Name.Variable.Magic */
|
|
||||||
.highlight .il { color: #990000 } /* Literal.Number.Integer.Long */
|
|
757
code/backend/docs/_build/html/genindex.html
vendored
757
code/backend/docs/_build/html/genindex.html
vendored
File diff suppressed because it is too large
Load diff
266
code/backend/docs/_build/html/index.html
vendored
266
code/backend/docs/_build/html/index.html
vendored
|
@ -1,43 +1,172 @@
|
||||||
|
|
||||||
|
|
||||||
<!DOCTYPE html>
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
|
||||||
|
<title>Welcome to N.E.S.T. Backend’s documentation! — N.E.S.T. Backend 0.1.0 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="_static/js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script src="_static/jquery.js"></script>
|
||||||
|
<script src="_static/underscore.js"></script>
|
||||||
|
<script src="_static/doctools.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<title>Welcome to N.E.S.T. Backend’s documentation! — N.E.S.T. Backend documentation</title>
|
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
|
||||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|
||||||
<script src="_static/jquery.js"></script>
|
|
||||||
<script src="_static/underscore.js"></script>
|
|
||||||
<script src="_static/doctools.js"></script>
|
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="backend" href="modules.html" />
|
<link rel="next" title="Autogenerated Python API reference" href="python_api/index.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
</head><body>
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
<div class="document">
|
|
||||||
<div class="documentwrapper">
|
<a href="#" class="icon icon-home"> N.E.S.T. Backend
|
||||||
<div class="bodywrapper">
|
|
||||||
|
|
||||||
|
|
||||||
<div class="body" role="main">
|
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="python_api/index.html">Autogenerated Python API reference</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
|
||||||
|
|
||||||
|
<nav class="wy-nav-top" aria-label="top navigation">
|
||||||
|
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="#">N.E.S.T. Backend</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
|
||||||
|
<div class="rst-content">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
|
||||||
|
<li><a href="#" class="icon icon-home"></a> »</li>
|
||||||
|
|
||||||
|
<li>Welcome to N.E.S.T. Backend’s documentation!</li>
|
||||||
|
|
||||||
|
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
|
||||||
|
|
||||||
|
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
|
||||||
|
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div itemprop="articleBody">
|
||||||
|
|
||||||
<div class="section" id="welcome-to-n-e-s-t-backend-s-documentation">
|
<div class="section" id="welcome-to-n-e-s-t-backend-s-documentation">
|
||||||
<h1>Welcome to N.E.S.T. Backend’s documentation!<a class="headerlink" href="#welcome-to-n-e-s-t-backend-s-documentation" title="Permalink to this headline">¶</a></h1>
|
<h1>Welcome to N.E.S.T. Backend’s documentation!<a class="headerlink" href="#welcome-to-n-e-s-t-backend-s-documentation" title="Permalink to this headline">¶</a></h1>
|
||||||
<div class="toctree-wrapper compound">
|
<div class="toctree-wrapper compound">
|
||||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|
||||||
<ul>
|
<ul>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="modules.html">backend</a><ul>
|
<li class="toctree-l1"><a class="reference internal" href="python_api/index.html">Autogenerated Python API reference</a><ul>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.html">nest_backend package</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="python_api/nest_backend.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Core module</a><ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="python_api/nest_backend.html#module-nest_backend.gestione"><code class="docutils literal notranslate"><span class="pre">.gestione</span></code> - Utility methods</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="python_api/nest_backend.html#module-nest_backend.database"><code class="docutils literal notranslate"><span class="pre">.database</span></code> - Database</a><ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="python_api/nest_backend.html#module-nest_backend.database.base"><code class="docutils literal notranslate"><span class="pre">.base</span></code> - Flask extension</a></li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="python_api/nest_backend.html#module-nest_backend.database.tables"><code class="docutils literal notranslate"><span class="pre">.tables</span></code> - Database tables</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="python_api/nest_backend.html#routes-api-routes"><code class="docutils literal notranslate"><span class="pre">.routes</span></code> - API routes</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
@ -53,71 +182,50 @@
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
<footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||||
|
<a href="python_api/index.html" class="btn btn-neutral float-right" title="Autogenerated Python API reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>
|
||||||
|
© Copyright 2021, Gruppo 2.
|
||||||
|
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
|
||||||
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||||
|
|
||||||
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
|
</footer>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
||||||
<div class="sphinxsidebarwrapper">
|
</section>
|
||||||
<h1 class="logo"><a href="#">N.E.S.T. Backend</a></h1>
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript">
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
|
||||||
<h3>Navigation</h3>
|
|
||||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|
||||||
<ul>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="modules.html">backend</a></li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<div class="relations">
|
|
||||||
<h3>Related Topics</h3>
|
|
||||||
<ul>
|
|
||||||
<li><a href="#">Documentation overview</a><ul>
|
|
||||||
<li>Next: <a href="modules.html" title="next chapter">backend</a></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div id="searchbox" style="display: none" role="search">
|
|
||||||
<h3 id="searchlabel">Quick search</h3>
|
|
||||||
<div class="searchformwrapper">
|
|
||||||
<form class="search" action="search.html" method="get">
|
|
||||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
|
||||||
<input type="submit" value="Go" />
|
|
||||||
</form>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<script>$('#searchbox').show(0);</script>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="clearer"></div>
|
|
||||||
</div>
|
|
||||||
<div class="footer">
|
|
||||||
©2021, Gruppo 2.
|
|
||||||
|
|
||||||
|
|
|
||||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.4</a>
|
|
||||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
|
||||||
|
|
||||||
|
|
|
||||||
<a href="_sources/index.rst.txt"
|
|
||||||
rel="nofollow">Page source</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
</html>
|
141
code/backend/docs/_build/html/modules.html
vendored
141
code/backend/docs/_build/html/modules.html
vendored
|
@ -1,141 +0,0 @@
|
||||||
|
|
||||||
<!DOCTYPE html>
|
|
||||||
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<title>backend — N.E.S.T. Backend documentation</title>
|
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
|
||||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|
||||||
<script src="_static/jquery.js"></script>
|
|
||||||
<script src="_static/underscore.js"></script>
|
|
||||||
<script src="_static/doctools.js"></script>
|
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
|
||||||
<link rel="search" title="Search" href="search.html" />
|
|
||||||
<link rel="next" title="nest_backend package" href="nest_backend.html" />
|
|
||||||
<link rel="prev" title="Welcome to N.E.S.T. Backend’s documentation!" href="index.html" />
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
|
||||||
|
|
||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
|
||||||
|
|
||||||
</head><body>
|
|
||||||
|
|
||||||
|
|
||||||
<div class="document">
|
|
||||||
<div class="documentwrapper">
|
|
||||||
<div class="bodywrapper">
|
|
||||||
|
|
||||||
|
|
||||||
<div class="body" role="main">
|
|
||||||
|
|
||||||
<div class="section" id="backend">
|
|
||||||
<h1>backend<a class="headerlink" href="#backend" title="Permalink to this headline">¶</a></h1>
|
|
||||||
<div class="toctree-wrapper compound">
|
|
||||||
<ul>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="nest_backend.html">nest_backend package</a><ul>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.html#subpackages">Subpackages</a><ul>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="nest_backend.database.html">nest_backend.database package</a><ul>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.database.html#subpackages">Subpackages</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.database.html#submodules">Submodules</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.database.html#module-nest_backend.database.base">nest_backend.database.base module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.database.html#module-nest_backend.database">Module contents</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="nest_backend.routes.html">nest_backend.routes package</a><ul>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.routes.html#subpackages">Subpackages</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.routes.html#submodules">Submodules</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.routes.html#module-nest_backend.routes.doa">nest_backend.routes.doa module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.routes.html#module-nest_backend.routes">Module contents</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.html#submodules">Submodules</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.html#module-nest_backend.gestione">nest_backend.gestione module</a><ul>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="nest_backend.html#a-utilities-python-module">A utilities Python Module.</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.html#module-nest_backend">Module contents</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
||||||
<div class="sphinxsidebarwrapper">
|
|
||||||
<h1 class="logo"><a href="index.html">N.E.S.T. Backend</a></h1>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Navigation</h3>
|
|
||||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|
||||||
<ul class="current">
|
|
||||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">backend</a><ul>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.html">nest_backend package</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<div class="relations">
|
|
||||||
<h3>Related Topics</h3>
|
|
||||||
<ul>
|
|
||||||
<li><a href="index.html">Documentation overview</a><ul>
|
|
||||||
<li>Previous: <a href="index.html" title="previous chapter">Welcome to N.E.S.T. Backend’s documentation!</a></li>
|
|
||||||
<li>Next: <a href="nest_backend.html" title="next chapter">nest_backend package</a></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div id="searchbox" style="display: none" role="search">
|
|
||||||
<h3 id="searchlabel">Quick search</h3>
|
|
||||||
<div class="searchformwrapper">
|
|
||||||
<form class="search" action="search.html" method="get">
|
|
||||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
|
||||||
<input type="submit" value="Go" />
|
|
||||||
</form>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<script>$('#searchbox').show(0);</script>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="clearer"></div>
|
|
||||||
</div>
|
|
||||||
<div class="footer">
|
|
||||||
©2021, Gruppo 2.
|
|
||||||
|
|
||||||
|
|
|
||||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.4</a>
|
|
||||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
|
||||||
|
|
||||||
|
|
|
||||||
<a href="_sources/modules.rst.txt"
|
|
||||||
rel="nofollow">Page source</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
|
@ -1,150 +0,0 @@
|
||||||
|
|
||||||
<!DOCTYPE html>
|
|
||||||
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<title>nest_backend.database package — N.E.S.T. Backend documentation</title>
|
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
|
||||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|
||||||
<script src="_static/jquery.js"></script>
|
|
||||||
<script src="_static/underscore.js"></script>
|
|
||||||
<script src="_static/doctools.js"></script>
|
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
|
||||||
<link rel="search" title="Search" href="search.html" />
|
|
||||||
<link rel="next" title="nest_backend.database.tables package" href="nest_backend.database.tables.html" />
|
|
||||||
<link rel="prev" title="nest_backend package" href="nest_backend.html" />
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
|
||||||
|
|
||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
|
||||||
|
|
||||||
</head><body>
|
|
||||||
|
|
||||||
|
|
||||||
<div class="document">
|
|
||||||
<div class="documentwrapper">
|
|
||||||
<div class="bodywrapper">
|
|
||||||
|
|
||||||
|
|
||||||
<div class="body" role="main">
|
|
||||||
|
|
||||||
<div class="section" id="nest-backend-database-package">
|
|
||||||
<h1>nest_backend.database package<a class="headerlink" href="#nest-backend-database-package" title="Permalink to this headline">¶</a></h1>
|
|
||||||
<div class="section" id="subpackages">
|
|
||||||
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<div class="toctree-wrapper compound">
|
|
||||||
<ul>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="nest_backend.database.tables.html">nest_backend.database.tables package</a><ul>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.database.tables.html#submodules">Submodules</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Alert">nest_backend.database.tables.Alert module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Authorization">nest_backend.database.tables.Authorization module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.BoolOperation">nest_backend.database.tables.BoolOperation module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Composed">nest_backend.database.tables.Composed module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Condition">nest_backend.database.tables.Condition module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Contains">nest_backend.database.tables.Contains module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Enums">nest_backend.database.tables.Enums module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Notification">nest_backend.database.tables.Notification module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Repository">nest_backend.database.tables.Repository module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Tweet">nest_backend.database.tables.Tweet module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.User">nest_backend.database.tables.User module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Uses">nest_backend.database.tables.Uses module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables">Module contents</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="section" id="submodules">
|
|
||||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.database.base">
|
|
||||||
<span id="nest-backend-database-base-module"></span><h2>nest_backend.database.base module<a class="headerlink" href="#module-nest_backend.database.base" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<p>This module creates the declarative base</p>
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.database">
|
|
||||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-nest_backend.database" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<p>This module imports all the tables and the declarative base</p>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
||||||
<div class="sphinxsidebarwrapper">
|
|
||||||
<h1 class="logo"><a href="index.html">N.E.S.T. Backend</a></h1>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Navigation</h3>
|
|
||||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|
||||||
<ul class="current">
|
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">backend</a><ul class="current">
|
|
||||||
<li class="toctree-l2 current"><a class="reference internal" href="nest_backend.html">nest_backend package</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<div class="relations">
|
|
||||||
<h3>Related Topics</h3>
|
|
||||||
<ul>
|
|
||||||
<li><a href="index.html">Documentation overview</a><ul>
|
|
||||||
<li><a href="modules.html">backend</a><ul>
|
|
||||||
<li><a href="nest_backend.html">nest_backend package</a><ul>
|
|
||||||
<li>Previous: <a href="nest_backend.html" title="previous chapter">nest_backend package</a></li>
|
|
||||||
<li>Next: <a href="nest_backend.database.tables.html" title="next chapter">nest_backend.database.tables package</a></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div id="searchbox" style="display: none" role="search">
|
|
||||||
<h3 id="searchlabel">Quick search</h3>
|
|
||||||
<div class="searchformwrapper">
|
|
||||||
<form class="search" action="search.html" method="get">
|
|
||||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
|
||||||
<input type="submit" value="Go" />
|
|
||||||
</form>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<script>$('#searchbox').show(0);</script>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="clearer"></div>
|
|
||||||
</div>
|
|
||||||
<div class="footer">
|
|
||||||
©2021, Gruppo 2.
|
|
||||||
|
|
||||||
|
|
|
||||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.4</a>
|
|
||||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
|
||||||
|
|
||||||
|
|
|
||||||
<a href="_sources/nest_backend.database.rst.txt"
|
|
||||||
rel="nofollow">Page source</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
|
@ -1,632 +0,0 @@
|
||||||
|
|
||||||
<!DOCTYPE html>
|
|
||||||
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<title>nest_backend.database.tables package — N.E.S.T. Backend documentation</title>
|
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
|
||||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|
||||||
<script src="_static/jquery.js"></script>
|
|
||||||
<script src="_static/underscore.js"></script>
|
|
||||||
<script src="_static/doctools.js"></script>
|
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
|
||||||
<link rel="search" title="Search" href="search.html" />
|
|
||||||
<link rel="next" title="nest_backend.routes package" href="nest_backend.routes.html" />
|
|
||||||
<link rel="prev" title="nest_backend.database package" href="nest_backend.database.html" />
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
|
||||||
|
|
||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
|
||||||
|
|
||||||
</head><body>
|
|
||||||
|
|
||||||
|
|
||||||
<div class="document">
|
|
||||||
<div class="documentwrapper">
|
|
||||||
<div class="bodywrapper">
|
|
||||||
|
|
||||||
|
|
||||||
<div class="body" role="main">
|
|
||||||
|
|
||||||
<div class="section" id="nest-backend-database-tables-package">
|
|
||||||
<h1>nest_backend.database.tables package<a class="headerlink" href="#nest-backend-database-tables-package" title="Permalink to this headline">¶</a></h1>
|
|
||||||
<div class="section" id="submodules">
|
|
||||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.database.tables.Alert">
|
|
||||||
<span id="nest-backend-database-tables-alert-module"></span><h2>nest_backend.database.tables.Alert module<a class="headerlink" href="#module-nest_backend.database.tables.Alert" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<p>This module defines the Alert database class.</p>
|
|
||||||
<dl class="py class">
|
|
||||||
<dt id="nest_backend.database.tables.Alert.Alert">
|
|
||||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">nest_backend.database.tables.Alert.</span></code><code class="sig-name descname"><span class="pre">Alert</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.Alert.Alert" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">sqlalchemy.orm.decl_api.Model</span></code></p>
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Alert.Alert.id">
|
|
||||||
<code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#nest_backend.database.tables.Alert.Alert.id" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Alert.Alert.limit">
|
|
||||||
<code class="sig-name descname"><span class="pre">limit</span></code><a class="headerlink" href="#nest_backend.database.tables.Alert.Alert.limit" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Alert.Alert.name">
|
|
||||||
<code class="sig-name descname"><span class="pre">name</span></code><a class="headerlink" href="#nest_backend.database.tables.Alert.Alert.name" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Alert.Alert.notifications">
|
|
||||||
<code class="sig-name descname"><span class="pre">notifications</span></code><a class="headerlink" href="#nest_backend.database.tables.Alert.Alert.notifications" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Alert.Alert.operations">
|
|
||||||
<code class="sig-name descname"><span class="pre">operations</span></code><a class="headerlink" href="#nest_backend.database.tables.Alert.Alert.operations" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Alert.Alert.repository">
|
|
||||||
<code class="sig-name descname"><span class="pre">repository</span></code><a class="headerlink" href="#nest_backend.database.tables.Alert.Alert.repository" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Alert.Alert.repository_id">
|
|
||||||
<code class="sig-name descname"><span class="pre">repository_id</span></code><a class="headerlink" href="#nest_backend.database.tables.Alert.Alert.repository_id" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Alert.Alert.window_size">
|
|
||||||
<code class="sig-name descname"><span class="pre">window_size</span></code><a class="headerlink" href="#nest_backend.database.tables.Alert.Alert.window_size" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.database.tables.Authorization">
|
|
||||||
<span id="nest-backend-database-tables-authorization-module"></span><h2>nest_backend.database.tables.Authorization module<a class="headerlink" href="#module-nest_backend.database.tables.Authorization" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<p>This module defines the Authorization database class.</p>
|
|
||||||
<dl class="py class">
|
|
||||||
<dt id="nest_backend.database.tables.Authorization.Authorization">
|
|
||||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">nest_backend.database.tables.Authorization.</span></code><code class="sig-name descname"><span class="pre">Authorization</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.Authorization.Authorization" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">sqlalchemy.orm.decl_api.Model</span></code></p>
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Authorization.Authorization.email">
|
|
||||||
<code class="sig-name descname"><span class="pre">email</span></code><a class="headerlink" href="#nest_backend.database.tables.Authorization.Authorization.email" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Authorization.Authorization.repository">
|
|
||||||
<code class="sig-name descname"><span class="pre">repository</span></code><a class="headerlink" href="#nest_backend.database.tables.Authorization.Authorization.repository" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Authorization.Authorization.rid">
|
|
||||||
<code class="sig-name descname"><span class="pre">rid</span></code><a class="headerlink" href="#nest_backend.database.tables.Authorization.Authorization.rid" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Authorization.Authorization.user">
|
|
||||||
<code class="sig-name descname"><span class="pre">user</span></code><a class="headerlink" href="#nest_backend.database.tables.Authorization.Authorization.user" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.database.tables.BoolOperation">
|
|
||||||
<span id="nest-backend-database-tables-booloperation-module"></span><h2>nest_backend.database.tables.BoolOperation module<a class="headerlink" href="#module-nest_backend.database.tables.BoolOperation" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<p>This module defines the BoolOperation database class.</p>
|
|
||||||
<dl class="py class">
|
|
||||||
<dt id="nest_backend.database.tables.BoolOperation.BoolOperation">
|
|
||||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">nest_backend.database.tables.BoolOperation.</span></code><code class="sig-name descname"><span class="pre">BoolOperation</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.BoolOperation" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">sqlalchemy.orm.decl_api.Model</span></code></p>
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.BoolOperation.BoolOperation.alert">
|
|
||||||
<code class="sig-name descname"><span class="pre">alert</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.BoolOperation.alert" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.BoolOperation.BoolOperation.alert_id">
|
|
||||||
<code class="sig-name descname"><span class="pre">alert_id</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.BoolOperation.alert_id" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.BoolOperation.BoolOperation.condition">
|
|
||||||
<code class="sig-name descname"><span class="pre">condition</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.BoolOperation.condition" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.BoolOperation.BoolOperation.condition_id">
|
|
||||||
<code class="sig-name descname"><span class="pre">condition_id</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.BoolOperation.condition_id" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.BoolOperation.BoolOperation.father_1">
|
|
||||||
<code class="sig-name descname"><span class="pre">father_1</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.BoolOperation.father_1" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.BoolOperation.BoolOperation.father_2">
|
|
||||||
<code class="sig-name descname"><span class="pre">father_2</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.BoolOperation.father_2" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.BoolOperation.BoolOperation.id">
|
|
||||||
<code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.BoolOperation.id" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.BoolOperation.BoolOperation.isRoot">
|
|
||||||
<code class="sig-name descname"><span class="pre">isRoot</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.BoolOperation.isRoot" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.BoolOperation.BoolOperation.node_1">
|
|
||||||
<code class="sig-name descname"><span class="pre">node_1</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.BoolOperation.node_1" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.BoolOperation.BoolOperation.node_1_id">
|
|
||||||
<code class="sig-name descname"><span class="pre">node_1_id</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.BoolOperation.node_1_id" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.BoolOperation.BoolOperation.node_2">
|
|
||||||
<code class="sig-name descname"><span class="pre">node_2</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.BoolOperation.node_2" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.BoolOperation.BoolOperation.node_2_id">
|
|
||||||
<code class="sig-name descname"><span class="pre">node_2_id</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.BoolOperation.node_2_id" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.BoolOperation.BoolOperation.operation">
|
|
||||||
<code class="sig-name descname"><span class="pre">operation</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.BoolOperation.operation" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.database.tables.Composed">
|
|
||||||
<span id="nest-backend-database-tables-composed-module"></span><h2>nest_backend.database.tables.Composed module<a class="headerlink" href="#module-nest_backend.database.tables.Composed" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<p>This module defines the Composed database class.</p>
|
|
||||||
<dl class="py class">
|
|
||||||
<dt id="nest_backend.database.tables.Composed.Composed">
|
|
||||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">nest_backend.database.tables.Composed.</span></code><code class="sig-name descname"><span class="pre">Composed</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.Composed.Composed" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">sqlalchemy.orm.decl_api.Model</span></code></p>
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Composed.Composed.repository">
|
|
||||||
<code class="sig-name descname"><span class="pre">repository</span></code><a class="headerlink" href="#nest_backend.database.tables.Composed.Composed.repository" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Composed.Composed.rid">
|
|
||||||
<code class="sig-name descname"><span class="pre">rid</span></code><a class="headerlink" href="#nest_backend.database.tables.Composed.Composed.rid" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Composed.Composed.snowflake">
|
|
||||||
<code class="sig-name descname"><span class="pre">snowflake</span></code><a class="headerlink" href="#nest_backend.database.tables.Composed.Composed.snowflake" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Composed.Composed.tweet">
|
|
||||||
<code class="sig-name descname"><span class="pre">tweet</span></code><a class="headerlink" href="#nest_backend.database.tables.Composed.Composed.tweet" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.database.tables.Condition">
|
|
||||||
<span id="nest-backend-database-tables-condition-module"></span><h2>nest_backend.database.tables.Condition module<a class="headerlink" href="#module-nest_backend.database.tables.Condition" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<p>This module defines the Condition database class.</p>
|
|
||||||
<dl class="py class">
|
|
||||||
<dt id="nest_backend.database.tables.Condition.Condition">
|
|
||||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">nest_backend.database.tables.Condition.</span></code><code class="sig-name descname"><span class="pre">Condition</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.Condition.Condition" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">sqlalchemy.orm.decl_api.Model</span></code></p>
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Condition.Condition.content">
|
|
||||||
<code class="sig-name descname"><span class="pre">content</span></code><a class="headerlink" href="#nest_backend.database.tables.Condition.Condition.content" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Condition.Condition.id">
|
|
||||||
<code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#nest_backend.database.tables.Condition.Condition.id" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Condition.Condition.operations">
|
|
||||||
<code class="sig-name descname"><span class="pre">operations</span></code><a class="headerlink" href="#nest_backend.database.tables.Condition.Condition.operations" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Condition.Condition.tweets">
|
|
||||||
<code class="sig-name descname"><span class="pre">tweets</span></code><a class="headerlink" href="#nest_backend.database.tables.Condition.Condition.tweets" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Condition.Condition.type">
|
|
||||||
<code class="sig-name descname"><span class="pre">type</span></code><a class="headerlink" href="#nest_backend.database.tables.Condition.Condition.type" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Condition.Condition.used">
|
|
||||||
<code class="sig-name descname"><span class="pre">used</span></code><a class="headerlink" href="#nest_backend.database.tables.Condition.Condition.used" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.database.tables.Contains">
|
|
||||||
<span id="nest-backend-database-tables-contains-module"></span><h2>nest_backend.database.tables.Contains module<a class="headerlink" href="#module-nest_backend.database.tables.Contains" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<p>This module defines the Contains database class.</p>
|
|
||||||
<dl class="py class">
|
|
||||||
<dt id="nest_backend.database.tables.Contains.Contains">
|
|
||||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">nest_backend.database.tables.Contains.</span></code><code class="sig-name descname"><span class="pre">Contains</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.Contains.Contains" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">sqlalchemy.orm.decl_api.Model</span></code></p>
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Contains.Contains.cid">
|
|
||||||
<code class="sig-name descname"><span class="pre">cid</span></code><a class="headerlink" href="#nest_backend.database.tables.Contains.Contains.cid" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Contains.Contains.condition">
|
|
||||||
<code class="sig-name descname"><span class="pre">condition</span></code><a class="headerlink" href="#nest_backend.database.tables.Contains.Contains.condition" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Contains.Contains.snowflake">
|
|
||||||
<code class="sig-name descname"><span class="pre">snowflake</span></code><a class="headerlink" href="#nest_backend.database.tables.Contains.Contains.snowflake" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Contains.Contains.tweet">
|
|
||||||
<code class="sig-name descname"><span class="pre">tweet</span></code><a class="headerlink" href="#nest_backend.database.tables.Contains.Contains.tweet" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.database.tables.Enums">
|
|
||||||
<span id="nest-backend-database-tables-enums-module"></span><h2>nest_backend.database.tables.Enums module<a class="headerlink" href="#module-nest_backend.database.tables.Enums" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<p>This module contains the main enum definitions.</p>
|
|
||||||
<dl class="py class">
|
|
||||||
<dt id="nest_backend.database.tables.Enums.ConditionType">
|
|
||||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">nest_backend.database.tables.Enums.</span></code><code class="sig-name descname"><span class="pre">ConditionType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.Enums.ConditionType" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
|
|
||||||
<p>An enumeration.</p>
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Enums.ConditionType.hashtag">
|
|
||||||
<code class="sig-name descname"><span class="pre">hashtag</span></code><em class="property"> <span class="pre">=</span> <span class="pre">0</span></em><a class="headerlink" href="#nest_backend.database.tables.Enums.ConditionType.hashtag" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Enums.ConditionType.location">
|
|
||||||
<code class="sig-name descname"><span class="pre">location</span></code><em class="property"> <span class="pre">=</span> <span class="pre">1</span></em><a class="headerlink" href="#nest_backend.database.tables.Enums.ConditionType.location" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Enums.ConditionType.time">
|
|
||||||
<code class="sig-name descname"><span class="pre">time</span></code><em class="property"> <span class="pre">=</span> <span class="pre">2</span></em><a class="headerlink" href="#nest_backend.database.tables.Enums.ConditionType.time" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py class">
|
|
||||||
<dt id="nest_backend.database.tables.Enums.OperationType">
|
|
||||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">nest_backend.database.tables.Enums.</span></code><code class="sig-name descname"><span class="pre">OperationType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.Enums.OperationType" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
|
|
||||||
<p>An enumeration.</p>
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Enums.OperationType.assign">
|
|
||||||
<code class="sig-name descname"><span class="pre">assign</span></code><em class="property"> <span class="pre">=</span> <span class="pre">3</span></em><a class="headerlink" href="#nest_backend.database.tables.Enums.OperationType.assign" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.database.tables.Notification">
|
|
||||||
<span id="nest-backend-database-tables-notification-module"></span><h2>nest_backend.database.tables.Notification module<a class="headerlink" href="#module-nest_backend.database.tables.Notification" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<p>This module defines the Notification database class.</p>
|
|
||||||
<dl class="py class">
|
|
||||||
<dt id="nest_backend.database.tables.Notification.Notification">
|
|
||||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">nest_backend.database.tables.Notification.</span></code><code class="sig-name descname"><span class="pre">Notification</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.Notification.Notification" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">sqlalchemy.orm.decl_api.Model</span></code></p>
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Notification.Notification.alert">
|
|
||||||
<code class="sig-name descname"><span class="pre">alert</span></code><a class="headerlink" href="#nest_backend.database.tables.Notification.Notification.alert" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Notification.Notification.alert_id">
|
|
||||||
<code class="sig-name descname"><span class="pre">alert_id</span></code><a class="headerlink" href="#nest_backend.database.tables.Notification.Notification.alert_id" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Notification.Notification.id">
|
|
||||||
<code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#nest_backend.database.tables.Notification.Notification.id" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Notification.Notification.ora">
|
|
||||||
<code class="sig-name descname"><span class="pre">ora</span></code><a class="headerlink" href="#nest_backend.database.tables.Notification.Notification.ora" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.database.tables.Repository">
|
|
||||||
<span id="nest-backend-database-tables-repository-module"></span><h2>nest_backend.database.tables.Repository module<a class="headerlink" href="#module-nest_backend.database.tables.Repository" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<p>This module defines the Repository database class.</p>
|
|
||||||
<dl class="py class">
|
|
||||||
<dt id="nest_backend.database.tables.Repository.Repository">
|
|
||||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">nest_backend.database.tables.Repository.</span></code><code class="sig-name descname"><span class="pre">Repository</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.Repository.Repository" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">sqlalchemy.orm.decl_api.Model</span></code></p>
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Repository.Repository.alerts">
|
|
||||||
<code class="sig-name descname"><span class="pre">alerts</span></code><a class="headerlink" href="#nest_backend.database.tables.Repository.Repository.alerts" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Repository.Repository.authorizations">
|
|
||||||
<code class="sig-name descname"><span class="pre">authorizations</span></code><a class="headerlink" href="#nest_backend.database.tables.Repository.Repository.authorizations" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Repository.Repository.end">
|
|
||||||
<code class="sig-name descname"><span class="pre">end</span></code><a class="headerlink" href="#nest_backend.database.tables.Repository.Repository.end" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Repository.Repository.id">
|
|
||||||
<code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#nest_backend.database.tables.Repository.Repository.id" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Repository.Repository.isActive">
|
|
||||||
<code class="sig-name descname"><span class="pre">isActive</span></code><a class="headerlink" href="#nest_backend.database.tables.Repository.Repository.isActive" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Repository.Repository.name">
|
|
||||||
<code class="sig-name descname"><span class="pre">name</span></code><a class="headerlink" href="#nest_backend.database.tables.Repository.Repository.name" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Repository.Repository.owner">
|
|
||||||
<code class="sig-name descname"><span class="pre">owner</span></code><a class="headerlink" href="#nest_backend.database.tables.Repository.Repository.owner" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Repository.Repository.owner_id">
|
|
||||||
<code class="sig-name descname"><span class="pre">owner_id</span></code><a class="headerlink" href="#nest_backend.database.tables.Repository.Repository.owner_id" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Repository.Repository.start">
|
|
||||||
<code class="sig-name descname"><span class="pre">start</span></code><a class="headerlink" href="#nest_backend.database.tables.Repository.Repository.start" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt id="nest_backend.database.tables.Repository.Repository.to_json">
|
|
||||||
<code class="sig-name descname"><span class="pre">to_json</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.Repository.Repository.to_json" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Repository.Repository.tweets">
|
|
||||||
<code class="sig-name descname"><span class="pre">tweets</span></code><a class="headerlink" href="#nest_backend.database.tables.Repository.Repository.tweets" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Repository.Repository.uses">
|
|
||||||
<code class="sig-name descname"><span class="pre">uses</span></code><a class="headerlink" href="#nest_backend.database.tables.Repository.Repository.uses" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.database.tables.Tweet">
|
|
||||||
<span id="nest-backend-database-tables-tweet-module"></span><h2>nest_backend.database.tables.Tweet module<a class="headerlink" href="#module-nest_backend.database.tables.Tweet" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<p>This module defines the Tweet database class.</p>
|
|
||||||
<dl class="py class">
|
|
||||||
<dt id="nest_backend.database.tables.Tweet.Tweet">
|
|
||||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">nest_backend.database.tables.Tweet.</span></code><code class="sig-name descname"><span class="pre">Tweet</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.Tweet.Tweet" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">sqlalchemy.orm.decl_api.Model</span></code></p>
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Tweet.Tweet.conditions">
|
|
||||||
<code class="sig-name descname"><span class="pre">conditions</span></code><a class="headerlink" href="#nest_backend.database.tables.Tweet.Tweet.conditions" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Tweet.Tweet.content">
|
|
||||||
<code class="sig-name descname"><span class="pre">content</span></code><a class="headerlink" href="#nest_backend.database.tables.Tweet.Tweet.content" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Tweet.Tweet.location">
|
|
||||||
<code class="sig-name descname"><span class="pre">location</span></code><a class="headerlink" href="#nest_backend.database.tables.Tweet.Tweet.location" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Tweet.Tweet.poster">
|
|
||||||
<code class="sig-name descname"><span class="pre">poster</span></code><a class="headerlink" href="#nest_backend.database.tables.Tweet.Tweet.poster" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Tweet.Tweet.repositories">
|
|
||||||
<code class="sig-name descname"><span class="pre">repositories</span></code><a class="headerlink" href="#nest_backend.database.tables.Tweet.Tweet.repositories" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Tweet.Tweet.snowflake">
|
|
||||||
<code class="sig-name descname"><span class="pre">snowflake</span></code><a class="headerlink" href="#nest_backend.database.tables.Tweet.Tweet.snowflake" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.database.tables.User">
|
|
||||||
<span id="nest-backend-database-tables-user-module"></span><h2>nest_backend.database.tables.User module<a class="headerlink" href="#module-nest_backend.database.tables.User" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<p>This module defines the User database class.</p>
|
|
||||||
<dl class="py class">
|
|
||||||
<dt id="nest_backend.database.tables.User.User">
|
|
||||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">nest_backend.database.tables.User.</span></code><code class="sig-name descname"><span class="pre">User</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.User.User" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">sqlalchemy.orm.decl_api.Model</span></code></p>
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.User.User.authorizations">
|
|
||||||
<code class="sig-name descname"><span class="pre">authorizations</span></code><a class="headerlink" href="#nest_backend.database.tables.User.User.authorizations" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.User.User.email">
|
|
||||||
<code class="sig-name descname"><span class="pre">email</span></code><a class="headerlink" href="#nest_backend.database.tables.User.User.email" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.User.User.isAdmin">
|
|
||||||
<code class="sig-name descname"><span class="pre">isAdmin</span></code><a class="headerlink" href="#nest_backend.database.tables.User.User.isAdmin" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.User.User.owner_of">
|
|
||||||
<code class="sig-name descname"><span class="pre">owner_of</span></code><a class="headerlink" href="#nest_backend.database.tables.User.User.owner_of" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.User.User.password">
|
|
||||||
<code class="sig-name descname"><span class="pre">password</span></code><a class="headerlink" href="#nest_backend.database.tables.User.User.password" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt id="nest_backend.database.tables.User.User.to_json">
|
|
||||||
<code class="sig-name descname"><span class="pre">to_json</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.User.User.to_json" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.User.User.username">
|
|
||||||
<code class="sig-name descname"><span class="pre">username</span></code><a class="headerlink" href="#nest_backend.database.tables.User.User.username" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.database.tables.Uses">
|
|
||||||
<span id="nest-backend-database-tables-uses-module"></span><h2>nest_backend.database.tables.Uses module<a class="headerlink" href="#module-nest_backend.database.tables.Uses" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<p>This module defines the Uses database class.</p>
|
|
||||||
<dl class="py class">
|
|
||||||
<dt id="nest_backend.database.tables.Uses.Uses">
|
|
||||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">nest_backend.database.tables.Uses.</span></code><code class="sig-name descname"><span class="pre">Uses</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.Uses.Uses" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">sqlalchemy.orm.decl_api.Model</span></code></p>
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Uses.Uses.cid">
|
|
||||||
<code class="sig-name descname"><span class="pre">cid</span></code><a class="headerlink" href="#nest_backend.database.tables.Uses.Uses.cid" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Uses.Uses.condition">
|
|
||||||
<code class="sig-name descname"><span class="pre">condition</span></code><a class="headerlink" href="#nest_backend.database.tables.Uses.Uses.condition" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Uses.Uses.repository">
|
|
||||||
<code class="sig-name descname"><span class="pre">repository</span></code><a class="headerlink" href="#nest_backend.database.tables.Uses.Uses.repository" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt id="nest_backend.database.tables.Uses.Uses.rid">
|
|
||||||
<code class="sig-name descname"><span class="pre">rid</span></code><a class="headerlink" href="#nest_backend.database.tables.Uses.Uses.rid" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.database.tables">
|
|
||||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-nest_backend.database.tables" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<p>This module contains all database classes.</p>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
||||||
<div class="sphinxsidebarwrapper">
|
|
||||||
<h1 class="logo"><a href="index.html">N.E.S.T. Backend</a></h1>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Navigation</h3>
|
|
||||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|
||||||
<ul class="current">
|
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">backend</a><ul class="current">
|
|
||||||
<li class="toctree-l2 current"><a class="reference internal" href="nest_backend.html">nest_backend package</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<div class="relations">
|
|
||||||
<h3>Related Topics</h3>
|
|
||||||
<ul>
|
|
||||||
<li><a href="index.html">Documentation overview</a><ul>
|
|
||||||
<li><a href="modules.html">backend</a><ul>
|
|
||||||
<li><a href="nest_backend.html">nest_backend package</a><ul>
|
|
||||||
<li><a href="nest_backend.database.html">nest_backend.database package</a><ul>
|
|
||||||
<li>Previous: <a href="nest_backend.database.html" title="previous chapter">nest_backend.database package</a></li>
|
|
||||||
<li>Next: <a href="nest_backend.routes.html" title="next chapter">nest_backend.routes package</a></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div id="searchbox" style="display: none" role="search">
|
|
||||||
<h3 id="searchlabel">Quick search</h3>
|
|
||||||
<div class="searchformwrapper">
|
|
||||||
<form class="search" action="search.html" method="get">
|
|
||||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
|
||||||
<input type="submit" value="Go" />
|
|
||||||
</form>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<script>$('#searchbox').show(0);</script>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="clearer"></div>
|
|
||||||
</div>
|
|
||||||
<div class="footer">
|
|
||||||
©2021, Gruppo 2.
|
|
||||||
|
|
||||||
|
|
|
||||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.4</a>
|
|
||||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
|
||||||
|
|
||||||
|
|
|
||||||
<a href="_sources/nest_backend.database.tables.rst.txt"
|
|
||||||
rel="nofollow">Page source</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
242
code/backend/docs/_build/html/nest_backend.html
vendored
242
code/backend/docs/_build/html/nest_backend.html
vendored
|
@ -1,242 +0,0 @@
|
||||||
|
|
||||||
<!DOCTYPE html>
|
|
||||||
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<title>nest_backend package — N.E.S.T. Backend documentation</title>
|
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
|
||||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|
||||||
<script src="_static/jquery.js"></script>
|
|
||||||
<script src="_static/underscore.js"></script>
|
|
||||||
<script src="_static/doctools.js"></script>
|
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
|
||||||
<link rel="search" title="Search" href="search.html" />
|
|
||||||
<link rel="next" title="nest_backend.database package" href="nest_backend.database.html" />
|
|
||||||
<link rel="prev" title="backend" href="modules.html" />
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
|
||||||
|
|
||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
|
||||||
|
|
||||||
</head><body>
|
|
||||||
|
|
||||||
|
|
||||||
<div class="document">
|
|
||||||
<div class="documentwrapper">
|
|
||||||
<div class="bodywrapper">
|
|
||||||
|
|
||||||
|
|
||||||
<div class="body" role="main">
|
|
||||||
|
|
||||||
<div class="section" id="nest-backend-package">
|
|
||||||
<h1>nest_backend package<a class="headerlink" href="#nest-backend-package" title="Permalink to this headline">¶</a></h1>
|
|
||||||
<div class="section" id="subpackages">
|
|
||||||
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<div class="toctree-wrapper compound">
|
|
||||||
<ul>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="nest_backend.database.html">nest_backend.database package</a><ul>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.database.html#subpackages">Subpackages</a><ul>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="nest_backend.database.tables.html">nest_backend.database.tables package</a><ul>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.database.tables.html#submodules">Submodules</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Alert">nest_backend.database.tables.Alert module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Authorization">nest_backend.database.tables.Authorization module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.BoolOperation">nest_backend.database.tables.BoolOperation module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Composed">nest_backend.database.tables.Composed module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Condition">nest_backend.database.tables.Condition module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Contains">nest_backend.database.tables.Contains module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Enums">nest_backend.database.tables.Enums module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Notification">nest_backend.database.tables.Notification module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Repository">nest_backend.database.tables.Repository module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Tweet">nest_backend.database.tables.Tweet module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.User">nest_backend.database.tables.User module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables.Uses">nest_backend.database.tables.Uses module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.database.tables.html#module-nest_backend.database.tables">Module contents</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.database.html#submodules">Submodules</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.database.html#module-nest_backend.database.base">nest_backend.database.base module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.database.html#module-nest_backend.database">Module contents</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="nest_backend.routes.html">nest_backend.routes package</a><ul>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.html#subpackages">Subpackages</a><ul>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="nest_backend.routes.repository.html">nest_backend.routes.repository package</a><ul>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.routes.repository.html#submodules">Submodules</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.routes.repository.html#module-nest_backend.routes.repository.repository_add_condition">nest_backend.routes.repository.repository_add_condition module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.routes.repository.html#module-nest_backend.routes.repository.repository_create">nest_backend.routes.repository.repository_create module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.routes.repository.html#module-nest_backend.routes.repository.repository_edit">nest_backend.routes.repository.repository_edit module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.routes.repository.html#module-nest_backend.routes.repository.repository_list">nest_backend.routes.repository.repository_list module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.routes.repository.html#module-nest_backend.routes.repository">Module contents</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="nest_backend.routes.users.html">nest_backend.routes.users package</a><ul>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.routes.users.html#submodules">Submodules</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.routes.users.html#module-nest_backend.routes.users.login">nest_backend.routes.users.login module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.routes.users.html#module-nest_backend.routes.users.user_create">nest_backend.routes.users.user_create module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.routes.users.html#module-nest_backend.routes.users.user_delete">nest_backend.routes.users.user_delete module</a></li>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="nest_backend.routes.users.html#module-nest_backend.routes.users">Module contents</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.html#submodules">Submodules</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.html#module-nest_backend.routes.doa">nest_backend.routes.doa module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.html#module-nest_backend.routes">Module contents</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="section" id="submodules">
|
|
||||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.gestione">
|
|
||||||
<span id="nest-backend-gestione-module"></span><h2>nest_backend.gestione module<a class="headerlink" href="#module-nest_backend.gestione" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<div class="section" id="a-utilities-python-module">
|
|
||||||
<h3>A utilities Python Module.<a class="headerlink" href="#a-utilities-python-module" title="Permalink to this headline">¶</a></h3>
|
|
||||||
<p>Gestione adds many fancy thingamajigs to the flask application, such as a login system and such.</p>
|
|
||||||
<dl class="py function">
|
|
||||||
<dt id="nest_backend.gestione.admin_or_403">
|
|
||||||
<code class="sig-prename descclassname"><span class="pre">nest_backend.gestione.</span></code><code class="sig-name descname"><span class="pre">admin_or_403</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.gestione.admin_or_403" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py function">
|
|
||||||
<dt id="nest_backend.gestione.authenticate">
|
|
||||||
<code class="sig-prename descclassname"><span class="pre">nest_backend.gestione.</span></code><code class="sig-name descname"><span class="pre">authenticate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">username</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.gestione.authenticate" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>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.</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py function">
|
|
||||||
<dt id="nest_backend.gestione.find_user">
|
|
||||||
<code class="sig-prename descclassname"><span class="pre">nest_backend.gestione.</span></code><code class="sig-name descname"><span class="pre">find_user</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">email</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.gestione.find_user" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py function">
|
|
||||||
<dt id="nest_backend.gestione.gen_password">
|
|
||||||
<code class="sig-prename descclassname"><span class="pre">nest_backend.gestione.</span></code><code class="sig-name descname"><span class="pre">gen_password</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">password</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.gestione.gen_password" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>It generates an hashed password.
|
|
||||||
:param password: the password that needs to be hashed.
|
|
||||||
:return: the password’s hash.</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py function">
|
|
||||||
<dt id="nest_backend.gestione.identity">
|
|
||||||
<code class="sig-prename descclassname"><span class="pre">nest_backend.gestione.</span></code><code class="sig-name descname"><span class="pre">identity</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.gestione.identity" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>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.</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py function">
|
|
||||||
<dt id="nest_backend.gestione.json_error">
|
|
||||||
<code class="sig-prename descclassname"><span class="pre">nest_backend.gestione.</span></code><code class="sig-name descname"><span class="pre">json_error</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.gestione.json_error" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>Returns an error in json format
|
|
||||||
:param msg: the error message.
|
|
||||||
:return: a json formatted string.</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py function">
|
|
||||||
<dt id="nest_backend.gestione.json_success">
|
|
||||||
<code class="sig-prename descclassname"><span class="pre">nest_backend.gestione.</span></code><code class="sig-name descname"><span class="pre">json_success</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.gestione.json_success" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>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</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py function">
|
|
||||||
<dt id="nest_backend.gestione.repository_auth">
|
|
||||||
<code class="sig-prename descclassname"><span class="pre">nest_backend.gestione.</span></code><code class="sig-name descname"><span class="pre">repository_auth</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.gestione.repository_auth" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend">
|
|
||||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-nest_backend" title="Permalink to this headline">¶</a></h2>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
||||||
<div class="sphinxsidebarwrapper">
|
|
||||||
<h1 class="logo"><a href="index.html">N.E.S.T. Backend</a></h1>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Navigation</h3>
|
|
||||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|
||||||
<ul class="current">
|
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">backend</a><ul class="current">
|
|
||||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">nest_backend package</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<div class="relations">
|
|
||||||
<h3>Related Topics</h3>
|
|
||||||
<ul>
|
|
||||||
<li><a href="index.html">Documentation overview</a><ul>
|
|
||||||
<li><a href="modules.html">backend</a><ul>
|
|
||||||
<li>Previous: <a href="modules.html" title="previous chapter">backend</a></li>
|
|
||||||
<li>Next: <a href="nest_backend.database.html" title="next chapter">nest_backend.database package</a></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div id="searchbox" style="display: none" role="search">
|
|
||||||
<h3 id="searchlabel">Quick search</h3>
|
|
||||||
<div class="searchformwrapper">
|
|
||||||
<form class="search" action="search.html" method="get">
|
|
||||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
|
||||||
<input type="submit" value="Go" />
|
|
||||||
</form>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<script>$('#searchbox').show(0);</script>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="clearer"></div>
|
|
||||||
</div>
|
|
||||||
<div class="footer">
|
|
||||||
©2021, Gruppo 2.
|
|
||||||
|
|
||||||
|
|
|
||||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.4</a>
|
|
||||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
|
||||||
|
|
||||||
|
|
|
||||||
<a href="_sources/nest_backend.rst.txt"
|
|
||||||
rel="nofollow">Page source</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
|
@ -1,157 +0,0 @@
|
||||||
|
|
||||||
<!DOCTYPE html>
|
|
||||||
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<title>nest_backend.routes package — N.E.S.T. Backend documentation</title>
|
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
|
||||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|
||||||
<script src="_static/jquery.js"></script>
|
|
||||||
<script src="_static/underscore.js"></script>
|
|
||||||
<script src="_static/doctools.js"></script>
|
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
|
||||||
<link rel="search" title="Search" href="search.html" />
|
|
||||||
<link rel="next" title="nest_backend.routes.repository package" href="nest_backend.routes.repository.html" />
|
|
||||||
<link rel="prev" title="nest_backend.database.tables package" href="nest_backend.database.tables.html" />
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
|
||||||
|
|
||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
|
||||||
|
|
||||||
</head><body>
|
|
||||||
|
|
||||||
|
|
||||||
<div class="document">
|
|
||||||
<div class="documentwrapper">
|
|
||||||
<div class="bodywrapper">
|
|
||||||
|
|
||||||
|
|
||||||
<div class="body" role="main">
|
|
||||||
|
|
||||||
<div class="section" id="nest-backend-routes-package">
|
|
||||||
<h1>nest_backend.routes package<a class="headerlink" href="#nest-backend-routes-package" title="Permalink to this headline">¶</a></h1>
|
|
||||||
<div class="section" id="subpackages">
|
|
||||||
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<div class="toctree-wrapper compound">
|
|
||||||
<ul>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="nest_backend.routes.repository.html">nest_backend.routes.repository package</a><ul>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.repository.html#submodules">Submodules</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.repository.html#module-nest_backend.routes.repository.repository_add_condition">nest_backend.routes.repository.repository_add_condition module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.repository.html#module-nest_backend.routes.repository.repository_create">nest_backend.routes.repository.repository_create module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.repository.html#module-nest_backend.routes.repository.repository_edit">nest_backend.routes.repository.repository_edit module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.repository.html#module-nest_backend.routes.repository.repository_list">nest_backend.routes.repository.repository_list module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.repository.html#module-nest_backend.routes.repository">Module contents</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="nest_backend.routes.users.html">nest_backend.routes.users package</a><ul>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.users.html#submodules">Submodules</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.users.html#module-nest_backend.routes.users.login">nest_backend.routes.users.login module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.users.html#module-nest_backend.routes.users.user_create">nest_backend.routes.users.user_create module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.users.html#module-nest_backend.routes.users.user_delete">nest_backend.routes.users.user_delete module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.users.html#module-nest_backend.routes.users">Module contents</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="section" id="submodules">
|
|
||||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.routes.doa">
|
|
||||||
<span id="nest-backend-routes-doa-module"></span><h2>nest_backend.routes.doa module<a class="headerlink" href="#module-nest_backend.routes.doa" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<p>Page that displays a message if the server is on</p>
|
|
||||||
<dl class="py function">
|
|
||||||
<dt id="nest_backend.routes.doa.page_doa">
|
|
||||||
<code class="sig-prename descclassname"><span class="pre">nest_backend.routes.doa.</span></code><code class="sig-name descname"><span class="pre">page_doa</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.routes.doa.page_doa" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>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.</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.routes">
|
|
||||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-nest_backend.routes" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<p>This module imports all the routes that return something to the frontend.</p>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
||||||
<div class="sphinxsidebarwrapper">
|
|
||||||
<h1 class="logo"><a href="index.html">N.E.S.T. Backend</a></h1>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Navigation</h3>
|
|
||||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|
||||||
<ul class="current">
|
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">backend</a><ul class="current">
|
|
||||||
<li class="toctree-l2 current"><a class="reference internal" href="nest_backend.html">nest_backend package</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<div class="relations">
|
|
||||||
<h3>Related Topics</h3>
|
|
||||||
<ul>
|
|
||||||
<li><a href="index.html">Documentation overview</a><ul>
|
|
||||||
<li><a href="modules.html">backend</a><ul>
|
|
||||||
<li><a href="nest_backend.html">nest_backend package</a><ul>
|
|
||||||
<li>Previous: <a href="nest_backend.database.tables.html" title="previous chapter">nest_backend.database.tables package</a></li>
|
|
||||||
<li>Next: <a href="nest_backend.routes.repository.html" title="next chapter">nest_backend.routes.repository package</a></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div id="searchbox" style="display: none" role="search">
|
|
||||||
<h3 id="searchlabel">Quick search</h3>
|
|
||||||
<div class="searchformwrapper">
|
|
||||||
<form class="search" action="search.html" method="get">
|
|
||||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
|
||||||
<input type="submit" value="Go" />
|
|
||||||
</form>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<script>$('#searchbox').show(0);</script>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="clearer"></div>
|
|
||||||
</div>
|
|
||||||
<div class="footer">
|
|
||||||
©2021, Gruppo 2.
|
|
||||||
|
|
||||||
|
|
|
||||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.4</a>
|
|
||||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
|
||||||
|
|
||||||
|
|
|
||||||
<a href="_sources/nest_backend.routes.rst.txt"
|
|
||||||
rel="nofollow">Page source</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
|
@ -1,171 +0,0 @@
|
||||||
|
|
||||||
<!DOCTYPE html>
|
|
||||||
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<title>nest_backend.routes.repository package — N.E.S.T. Backend documentation</title>
|
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
|
||||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|
||||||
<script src="_static/jquery.js"></script>
|
|
||||||
<script src="_static/underscore.js"></script>
|
|
||||||
<script src="_static/doctools.js"></script>
|
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
|
||||||
<link rel="search" title="Search" href="search.html" />
|
|
||||||
<link rel="next" title="nest_backend.routes.users package" href="nest_backend.routes.users.html" />
|
|
||||||
<link rel="prev" title="nest_backend.routes package" href="nest_backend.routes.html" />
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
|
||||||
|
|
||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
|
||||||
|
|
||||||
</head><body>
|
|
||||||
|
|
||||||
|
|
||||||
<div class="document">
|
|
||||||
<div class="documentwrapper">
|
|
||||||
<div class="bodywrapper">
|
|
||||||
|
|
||||||
|
|
||||||
<div class="body" role="main">
|
|
||||||
|
|
||||||
<div class="section" id="nest-backend-routes-repository-package">
|
|
||||||
<h1>nest_backend.routes.repository package<a class="headerlink" href="#nest-backend-routes-repository-package" title="Permalink to this headline">¶</a></h1>
|
|
||||||
<div class="section" id="submodules">
|
|
||||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.routes.repository.repository_add_condition">
|
|
||||||
<span id="nest-backend-routes-repository-repository-add-condition-module"></span><h2>nest_backend.routes.repository.repository_add_condition module<a class="headerlink" href="#module-nest_backend.routes.repository.repository_add_condition" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<dl class="py function">
|
|
||||||
<dt id="nest_backend.routes.repository.repository_add_condition.page_repository_add_condition">
|
|
||||||
<code class="sig-prename descclassname"><span class="pre">nest_backend.routes.repository.repository_add_condition.</span></code><code class="sig-name descname"><span class="pre">page_repository_add_condition</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.routes.repository.repository_add_condition.page_repository_add_condition" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>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.</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.routes.repository.repository_create">
|
|
||||||
<span id="nest-backend-routes-repository-repository-create-module"></span><h2>nest_backend.routes.repository.repository_create module<a class="headerlink" href="#module-nest_backend.routes.repository.repository_create" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<dl class="py function">
|
|
||||||
<dt id="nest_backend.routes.repository.repository_create.page_repository_create">
|
|
||||||
<code class="sig-prename descclassname"><span class="pre">nest_backend.routes.repository.repository_create.</span></code><code class="sig-name descname"><span class="pre">page_repository_create</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.routes.repository.repository_create.page_repository_create" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>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.</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.routes.repository.repository_edit">
|
|
||||||
<span id="nest-backend-routes-repository-repository-edit-module"></span><h2>nest_backend.routes.repository.repository_edit module<a class="headerlink" href="#module-nest_backend.routes.repository.repository_edit" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<dl class="py function">
|
|
||||||
<dt id="nest_backend.routes.repository.repository_edit.page_repository_edit">
|
|
||||||
<code class="sig-prename descclassname"><span class="pre">nest_backend.routes.repository.repository_edit.</span></code><code class="sig-name descname"><span class="pre">page_repository_edit</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.routes.repository.repository_edit.page_repository_edit" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>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.</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.routes.repository.repository_list">
|
|
||||||
<span id="nest-backend-routes-repository-repository-list-module"></span><h2>nest_backend.routes.repository.repository_list module<a class="headerlink" href="#module-nest_backend.routes.repository.repository_list" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<dl class="py function">
|
|
||||||
<dt id="nest_backend.routes.repository.repository_list.page_repository_list">
|
|
||||||
<code class="sig-prename descclassname"><span class="pre">nest_backend.routes.repository.repository_list.</span></code><code class="sig-name descname"><span class="pre">page_repository_list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.routes.repository.repository_list.page_repository_list" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>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”).</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.routes.repository">
|
|
||||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-nest_backend.routes.repository" title="Permalink to this headline">¶</a></h2>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
||||||
<div class="sphinxsidebarwrapper">
|
|
||||||
<h1 class="logo"><a href="index.html">N.E.S.T. Backend</a></h1>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Navigation</h3>
|
|
||||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|
||||||
<ul class="current">
|
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">backend</a><ul class="current">
|
|
||||||
<li class="toctree-l2 current"><a class="reference internal" href="nest_backend.html">nest_backend package</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<div class="relations">
|
|
||||||
<h3>Related Topics</h3>
|
|
||||||
<ul>
|
|
||||||
<li><a href="index.html">Documentation overview</a><ul>
|
|
||||||
<li><a href="modules.html">backend</a><ul>
|
|
||||||
<li><a href="nest_backend.html">nest_backend package</a><ul>
|
|
||||||
<li><a href="nest_backend.routes.html">nest_backend.routes package</a><ul>
|
|
||||||
<li>Previous: <a href="nest_backend.routes.html" title="previous chapter">nest_backend.routes package</a></li>
|
|
||||||
<li>Next: <a href="nest_backend.routes.users.html" title="next chapter">nest_backend.routes.users package</a></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div id="searchbox" style="display: none" role="search">
|
|
||||||
<h3 id="searchlabel">Quick search</h3>
|
|
||||||
<div class="searchformwrapper">
|
|
||||||
<form class="search" action="search.html" method="get">
|
|
||||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
|
||||||
<input type="submit" value="Go" />
|
|
||||||
</form>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<script>$('#searchbox').show(0);</script>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="clearer"></div>
|
|
||||||
</div>
|
|
||||||
<div class="footer">
|
|
||||||
©2021, Gruppo 2.
|
|
||||||
|
|
||||||
|
|
|
||||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.4</a>
|
|
||||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
|
||||||
|
|
||||||
|
|
|
||||||
<a href="_sources/nest_backend.routes.repository.rst.txt"
|
|
||||||
rel="nofollow">Page source</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
|
@ -1,160 +0,0 @@
|
||||||
|
|
||||||
<!DOCTYPE html>
|
|
||||||
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<title>nest_backend.routes.users package — N.E.S.T. Backend documentation</title>
|
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
|
||||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|
||||||
<script src="_static/jquery.js"></script>
|
|
||||||
<script src="_static/underscore.js"></script>
|
|
||||||
<script src="_static/doctools.js"></script>
|
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
|
||||||
<link rel="search" title="Search" href="search.html" />
|
|
||||||
<link rel="prev" title="nest_backend.routes.repository package" href="nest_backend.routes.repository.html" />
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
|
||||||
|
|
||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
|
||||||
|
|
||||||
</head><body>
|
|
||||||
|
|
||||||
|
|
||||||
<div class="document">
|
|
||||||
<div class="documentwrapper">
|
|
||||||
<div class="bodywrapper">
|
|
||||||
|
|
||||||
|
|
||||||
<div class="body" role="main">
|
|
||||||
|
|
||||||
<div class="section" id="nest-backend-routes-users-package">
|
|
||||||
<h1>nest_backend.routes.users package<a class="headerlink" href="#nest-backend-routes-users-package" title="Permalink to this headline">¶</a></h1>
|
|
||||||
<div class="section" id="submodules">
|
|
||||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.routes.users.login">
|
|
||||||
<span id="nest-backend-routes-users-login-module"></span><h2>nest_backend.routes.users.login module<a class="headerlink" href="#module-nest_backend.routes.users.login" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<dl class="py function">
|
|
||||||
<dt id="nest_backend.routes.users.login.page_login">
|
|
||||||
<code class="sig-prename descclassname"><span class="pre">nest_backend.routes.users.login.</span></code><code class="sig-name descname"><span class="pre">page_login</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.routes.users.login.page_login" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>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.</p>
|
|
||||||
<p>The access_token must be included in the Authorization header, using the format Bearer <token>.</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.routes.users.user_create">
|
|
||||||
<span id="nest-backend-routes-users-user-create-module"></span><h2>nest_backend.routes.users.user_create module<a class="headerlink" href="#module-nest_backend.routes.users.user_create" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<dl class="py function">
|
|
||||||
<dt id="nest_backend.routes.users.user_create.page_user_create">
|
|
||||||
<code class="sig-prename descclassname"><span class="pre">nest_backend.routes.users.user_create.</span></code><code class="sig-name descname"><span class="pre">page_user_create</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.routes.users.user_create.page_user_create" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>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().</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.routes.users.user_delete">
|
|
||||||
<span id="nest-backend-routes-users-user-delete-module"></span><h2>nest_backend.routes.users.user_delete module<a class="headerlink" href="#module-nest_backend.routes.users.user_delete" title="Permalink to this headline">¶</a></h2>
|
|
||||||
<dl class="py function">
|
|
||||||
<dt id="nest_backend.routes.users.user_delete.page_user_delete">
|
|
||||||
<code class="sig-prename descclassname"><span class="pre">nest_backend.routes.users.user_delete.</span></code><code class="sig-name descname"><span class="pre">page_user_delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.routes.users.user_delete.page_user_delete" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>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.</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="module-nest_backend.routes.users">
|
|
||||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-nest_backend.routes.users" title="Permalink to this headline">¶</a></h2>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
||||||
<div class="sphinxsidebarwrapper">
|
|
||||||
<h1 class="logo"><a href="index.html">N.E.S.T. Backend</a></h1>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Navigation</h3>
|
|
||||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|
||||||
<ul class="current">
|
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">backend</a><ul class="current">
|
|
||||||
<li class="toctree-l2 current"><a class="reference internal" href="nest_backend.html">nest_backend package</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<div class="relations">
|
|
||||||
<h3>Related Topics</h3>
|
|
||||||
<ul>
|
|
||||||
<li><a href="index.html">Documentation overview</a><ul>
|
|
||||||
<li><a href="modules.html">backend</a><ul>
|
|
||||||
<li><a href="nest_backend.html">nest_backend package</a><ul>
|
|
||||||
<li><a href="nest_backend.routes.html">nest_backend.routes package</a><ul>
|
|
||||||
<li>Previous: <a href="nest_backend.routes.repository.html" title="previous chapter">nest_backend.routes.repository package</a></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div id="searchbox" style="display: none" role="search">
|
|
||||||
<h3 id="searchlabel">Quick search</h3>
|
|
||||||
<div class="searchformwrapper">
|
|
||||||
<form class="search" action="search.html" method="get">
|
|
||||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
|
||||||
<input type="submit" value="Go" />
|
|
||||||
</form>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<script>$('#searchbox').show(0);</script>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="clearer"></div>
|
|
||||||
</div>
|
|
||||||
<div class="footer">
|
|
||||||
©2021, Gruppo 2.
|
|
||||||
|
|
||||||
|
|
|
||||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.4</a>
|
|
||||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
|
||||||
|
|
||||||
|
|
|
||||||
<a href="_sources/nest_backend.routes.users.rst.txt"
|
|
||||||
rel="nofollow">Page source</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
BIN
code/backend/docs/_build/html/objects.inv
vendored
BIN
code/backend/docs/_build/html/objects.inv
vendored
Binary file not shown.
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue