Files
conference-room-booking-system/backend/docs/_build/index.html
Cliff Hill 16a71b2650 Adding docs.
Signed-off-by: Cliff Hill <xlorep@darkhelm.org>
2025-10-02 16:32:52 -04:00

817 lines
30 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html class="no-js" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1" />
<meta name="color-scheme" content="light dark" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Usage" href="usage.html" />
<!-- Generated with Sphinx 8.2.3 and Furo 2025.09.25 -->
<title>Backend documentation</title>
<link
rel="stylesheet"
type="text/css"
href="_static/pygments.css?v=d111a655"
/>
<link
rel="stylesheet"
type="text/css"
href="_static/styles/furo.css?v=580074bf"
/>
<link
rel="stylesheet"
type="text/css"
href="_static/styles/furo-extensions.css?v=8dab3a3b"
/>
<style>
body {
--color-code-background: #f2f2f2;
--color-code-foreground: #1e1e1e;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
</style>
</head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg
stroke="currentColor"
fill="currentColor"
stroke-width="0"
viewBox="0 0 1024 1024"
>
<path
d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"
/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 24 24"
fill="none"
stroke="currentColor"
stroke-width="2"
stroke-linecap="round"
stroke-linejoin="round"
class="feather-menu"
>
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 24 24"
fill="none"
stroke="currentColor"
stroke-width="2"
stroke-linecap="round"
stroke-linejoin="round"
class="feather-chevron-right"
>
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 24 24"
fill="none"
stroke="currentColor"
stroke-width="1"
stroke-linecap="round"
stroke-linejoin="round"
class="feather-sun"
>
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 24 24"
fill="none"
stroke="currentColor"
stroke-width="1"
stroke-linecap="round"
stroke-linejoin="round"
class="icon-tabler-moon"
>
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path
d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z"
/>
</svg>
</symbol>
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
<title>Auto light/dark, in light mode</title>
<svg
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 24 24"
fill="none"
stroke="currentColor"
stroke-width="1"
stroke-linecap="round"
stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon"
>
<path
style="opacity: 50%"
d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"
/>
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25" />
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85" />
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68" />
<line x1="19" y1="14.05" x2="20.414" y2="15.464" />
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55" />
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55" />
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42" />
<line x1="19" y1="5.05" x2="20.414" y2="3.636" />
<circle cx="14.5" cy="9.55" r="3.6" />
</svg>
</symbol>
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
<title>Auto light/dark, in dark mode</title>
<svg
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 24 24"
fill="none"
stroke="currentColor"
stroke-width="1"
stroke-linecap="round"
stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon"
>
<path
d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"
/>
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5" />
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5" />
<line
style="opacity: 50%"
x1="15.316"
y1="4.816"
x2="14.464"
y2="3.964"
/>
<line
style="opacity: 50%"
x1="20.711"
y1="10.212"
x2="21.563"
y2="11.063"
/>
<line
style="opacity: 50%"
x1="14.205"
y1="7.5"
x2="13.001"
y2="7.5"
/>
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5" />
<line
style="opacity: 50%"
x1="15.316"
y1="10.184"
x2="14.464"
y2="11.036"
/>
<line
style="opacity: 50%"
x1="20.711"
y1="4.789"
x2="21.563"
y2="3.937"
/>
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169" />
</svg>
</symbol>
<symbol id="svg-pencil" viewBox="0 0 24 24">
<svg
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 24 24"
fill="none"
stroke="currentColor"
stroke-width="1"
stroke-linecap="round"
stroke-linejoin="round"
class="icon-tabler-pencil-code"
>
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
<path d="M13.5 6.5l4 4" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
<symbol id="svg-eye" viewBox="0 0 24 24">
<svg
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 24 24"
fill="none"
stroke="currentColor"
stroke-width="1"
stroke-linecap="round"
stroke-linejoin="round"
class="icon-tabler-eye-code"
>
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
<path
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008"
/>
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
</svg>
<input
type="checkbox"
class="sidebar-toggle"
name="__navigation"
id="__navigation"
aria-label="Toggle site navigation sidebar"
/>
<input
type="checkbox"
class="sidebar-toggle"
name="__toc"
id="__toc"
aria-label="Toggle table of contents sidebar"
/>
<label class="overlay sidebar-overlay" for="__navigation"></label>
<label class="overlay toc-overlay" for="__toc"></label>
<a class="skip-to-content muted-link" href="#furo-main-content"
>Skip to content</a
>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<span class="icon"
><svg><use href="#svg-menu"></use></svg
></span>
</label>
</div>
<div class="header-center">
<a href="#"><div class="brand">Backend documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button
class="theme-toggle"
aria-label="Toggle Light / Dark / Auto color theme"
>
<svg class="theme-icon-when-auto-light">
<use href="#svg-sun-with-moon"></use>
</svg>
<svg class="theme-icon-when-auto-dark">
<use href="#svg-moon-with-sun"></use>
</svg>
<svg class="theme-icon-when-dark">
<use href="#svg-moon"></use>
</svg>
<svg class="theme-icon-when-light">
<use href="#svg-sun"></use>
</svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<span class="icon"
><svg><use href="#svg-toc"></use></svg
></span>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky">
<a class="sidebar-brand" href="#">
<span class="sidebar-brand-text">Backend documentation</span>
</a>
<form
class="sidebar-search-container"
method="get"
action="search.html"
role="search"
>
<input
class="sidebar-search"
placeholder="Search"
name="q"
aria-label="Search"
/>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<div id="searchbox"></div>
<div class="sidebar-scroll">
<div class="sidebar-tree">
<ul>
<li class="toctree-l1">
<a class="reference internal" href="usage.html">Usage</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="reference.html"
>Reference</a
>
</li>
<li class="toctree-l1">
<a class="reference internal" href="contributing.html"
>Contributor Guide</a
>
</li>
<li class="toctree-l1">
<a class="reference internal" href="codeofconduct.html"
>Code of Conduct</a
>
</li>
<li class="toctree-l1">
<a class="reference internal" href="license.html"
>License</a
>
</li>
<li class="toctree-l1">
<a
class="reference external"
href="https://github.com/xlorepdarkhelm/backend/releases"
>Changelog</a
>
</li>
</ul>
</div>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path
d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"
></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container">
<div class="view-this-page">
<a
class="muted-link"
href="_sources/index.md.txt"
title="View this page"
>
<svg><use href="#svg-eye"></use></svg>
<span class="visually-hidden">View this page</span>
</a>
</div>
<div class="theme-toggle-container theme-toggle-content">
<button
class="theme-toggle"
aria-label="Toggle Light / Dark / Auto color theme"
>
<svg class="theme-icon-when-auto-light">
<use href="#svg-sun-with-moon"></use>
</svg>
<svg class="theme-icon-when-auto-dark">
<use href="#svg-moon-with-sun"></use>
</svg>
<svg class="theme-icon-when-dark">
<use href="#svg-moon"></use>
</svg>
<svg class="theme-icon-when-light">
<use href="#svg-sun"></use>
</svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<span class="icon"
><svg><use href="#svg-toc"></use></svg
></span>
</label>
</div>
<article role="main" id="furo-main-content">
<section id="backend">
<h1>
Backend<a
class="headerlink"
href="#backend"
title="Link to this heading"
></a
>
</h1>
<p>
<a
class="reference external"
href="https://pypi.org/project/backend/"
><img
alt="PyPI"
src="https://img.shields.io/pypi/v/backend.svg"
/></a>
<a
class="reference external"
href="https://pypi.org/project/backend/"
><img
alt="Status"
src="https://img.shields.io/pypi/status/backend.svg"
/></a>
<a
class="reference external"
href="https://pypi.org/project/backend"
><img
alt="Python Version"
src="https://img.shields.io/pypi/pyversions/backend"
/></a>
<a class="reference internal" href="license.html"
><span class="doc std std-doc"
><img
alt="License"
src="https://img.shields.io/pypi/l/backend" /></span
></a>
</p>
<p>
<a
class="reference external"
href="https://backend.readthedocs.io/"
><img
alt="Read the documentation at https://backend.readthedocs.io/"
src="https://img.shields.io/readthedocs/backend/latest.svg?label=Read%20the%20Docs"
/></a>
<a
class="reference external"
href="https://github.com/xlorepdarkhelm/backend/actions?workflow=Tests"
><img
alt="Tests"
src="https://github.com/xlorepdarkhelm/backend/workflows/Tests/badge.svg"
/></a>
<a
class="reference external"
href="https://app.codecov.io/gh/xlorepdarkhelm/backend"
><img
alt="Codecov"
src="https://codecov.io/gh/xlorepdarkhelm/backend/branch/main/graph/badge.svg"
/></a>
</p>
<p>
<a
class="reference external"
href="https://github.com/pre-commit/pre-commit"
><img
alt="pre-commit"
src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&amp;logoColor=white"
/></a>
<a
class="reference external"
href="https://github.com/psf/black"
><img
alt="Black"
src="https://img.shields.io/badge/code%20style-black-000000.svg"
/></a>
</p>
<section id="features">
<h2>
Features<a
class="headerlink"
href="#features"
title="Link to this heading"
></a
>
</h2>
<ul class="simple">
<li>
<p>Room booking with optional title for each booking</p>
</li>
</ul>
</section>
<section id="requirements">
<h2>
Requirements<a
class="headerlink"
href="#requirements"
title="Link to this heading"
></a
>
</h2>
<ul class="simple">
<li><p>TODO</p></li>
</ul>
</section>
<section id="installation">
<h2>
Installation<a
class="headerlink"
href="#installation"
title="Link to this heading"
></a
>
</h2>
<p>
You can install <em>Backend</em> via
<a class="reference external" href="https://pip.pypa.io/"
>pip</a
>
from
<a class="reference external" href="https://pypi.org/"
>PyPI</a
>:
</p>
<div class="highlight-console notranslate">
<div class="highlight">
<pre><span></span><span class="gp">$ </span>pip<span class="w"> </span>install<span class="w"> </span>backend
</pre>
</div>
</div>
</section>
<section id="booking-model">
<h2>
Booking Model<a
class="headerlink"
href="#booking-model"
title="Link to this heading"
></a
>
</h2>
<p>
The
<code class="docutils literal notranslate"
><span class="pre">Booking</span></code
>
model supports the following fields:
</p>
<ul class="simple">
<li>
<p>
<code class="docutils literal notranslate"
><span class="pre">id</span></code
>: Unique identifier (auto-incremented)
</p>
</li>
<li>
<p>
<code class="docutils literal notranslate"
><span class="pre">room_id</span></code
>: The ID of the associated room
</p>
</li>
<li>
<p>
<code class="docutils literal notranslate"
><span class="pre">start_time</span></code
>: Start time of the booking
</p>
</li>
<li>
<p>
<code class="docutils literal notranslate"
><span class="pre">end_time</span></code
>: End time of the booking
</p>
</li>
<li>
<p>
<code class="docutils literal notranslate"
><span class="pre">title</span></code
>: (Optional) A title for the booking
</p>
</li>
</ul>
<p>
You can provide a
<code class="docutils literal notranslate"
><span class="pre">title</span></code
>
when creating or updating a booking. If omitted, the booking
will have no title.
</p>
</section>
<section id="usage">
<h2>
Usage<a
class="headerlink"
href="#usage"
title="Link to this heading"
></a
>
</h2>
<p>
Please see the
<a class="reference internal" href="usage.html"
><span class="doc std std-doc"
>Command-line Reference</span
></a
>
for details.
</p>
</section>
<section id="contributing">
<h2>
Contributing<a
class="headerlink"
href="#contributing"
title="Link to this heading"
></a
>
</h2>
<p>
Contributions are very welcome. To learn more, see the
<a class="reference internal" href="contributing.html"
><span class="doc std std-doc">Contributor Guide</span></a
>.
</p>
</section>
<section id="license">
<h2>
License<a
class="headerlink"
href="#license"
title="Link to this heading"
></a
>
</h2>
<p>
Distributed under the terms of the
<a class="reference internal" href="license.html"
><span class="doc std std-doc">MIT license</span></a
>, <em>Backend</em> is free and open source software.
</p>
</section>
<section id="issues">
<h2>
Issues<a
class="headerlink"
href="#issues"
title="Link to this heading"
></a
>
</h2>
<p>
If you encounter any problems, please
<a
class="reference external"
href="https://github.com/xlorepdarkhelm/backend/issues"
>file an issue</a
>
along with a detailed description.
</p>
</section>
<section id="credits">
<h2>
Credits<a
class="headerlink"
href="#credits"
title="Link to this heading"
></a
>
</h2>
<p>
This project was generated from
<a
class="reference external"
href="https://github.com/cjolowicz"
>&#64;cjolowicz</a
>s
<a
class="reference external"
href="https://github.com/cjolowicz/cookiecutter-hypermodern-python"
>Hypermodern Python Cookiecutter</a
>
template.
</p>
<div class="toctree-wrapper compound"></div>
</section>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="usage.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Usage</div>
</div>
<svg class="furo-related-icon">
<use href="#svg-arrow-right"></use>
</svg>
</a>
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">Copyright &#169; 2025, Cliff Hill</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and
<a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a
>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details"></div>
</div>
</footer>
</div>
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title"> On this page </span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li>
<a class="reference internal" href="#">Backend</a>
<ul>
<li>
<a class="reference internal" href="#features"
>Features</a
>
</li>
<li>
<a class="reference internal" href="#requirements"
>Requirements</a
>
</li>
<li>
<a class="reference internal" href="#installation"
>Installation</a
>
</li>
<li>
<a class="reference internal" href="#booking-model"
>Booking Model</a
>
</li>
<li>
<a class="reference internal" href="#usage">Usage</a>
</li>
<li>
<a class="reference internal" href="#contributing"
>Contributing</a
>
</li>
<li>
<a class="reference internal" href="#license"
>License</a
>
</li>
<li>
<a class="reference internal" href="#issues">Issues</a>
</li>
<li>
<a class="reference internal" href="#credits"
>Credits</a
>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>
</div>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=46bd48cc"></script>
</body>
</html>