forked from Botts-Innovative-Research/OSHConnect-Python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.html
More file actions
168 lines (148 loc) · 8.33 KB
/
api.html
File metadata and controls
168 lines (148 loc) · 8.33 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>API Reference — OSHConnect-Python 0.2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=10f1778b"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="OSH Connect Tutorial" href="tutorial.html" />
<link rel="prev" title="Welcome to OSHConnect-Python’s documentation!" href="index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
OSHConnect-Python
</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" aria-label="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="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#oshconnect">OSHConnect</a></li>
<li class="toctree-l2"><a class="reference internal" href="#oshconnect-utilities-and-helpers">OSHConnect Utilities and Helpers</a></li>
<li class="toctree-l2"><a class="reference internal" href="#osh-connect-data-models">OSH Connect Data Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="#datasources-and-messaging">DataSources and Messaging</a></li>
<li class="toctree-l2"><a class="reference internal" href="#time-management">Time Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="#styling">Styling</a></li>
<li class="toctree-l2"><a class="reference internal" href="#datastore">Datastore</a></li>
<li class="toctree-l2"><a class="reference internal" href="#core-data-models">Core Data Models</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#helpers">Helpers</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">OSH Connect Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html#resource-insertion">Resource Insertion</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">OSHConnect-Python</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">API Reference</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/api.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul><div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Sequential page navigation">
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to OSHConnect-Python’s documentation!" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="tutorial.html" class="btn btn-neutral float-right" title="OSH Connect Tutorial" accesskey="n">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="api-reference">
<h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this heading"></a></h1>
<section id="oshconnect">
<h2>OSHConnect<a class="headerlink" href="#oshconnect" title="Link to this heading"></a></h2>
</section>
<section id="oshconnect-utilities-and-helpers">
<h2>OSHConnect Utilities and Helpers<a class="headerlink" href="#oshconnect-utilities-and-helpers" title="Link to this heading"></a></h2>
</section>
<section id="osh-connect-data-models">
<h2>OSH Connect Data Models<a class="headerlink" href="#osh-connect-data-models" title="Link to this heading"></a></h2>
<p>These are the second highest level pieces in the hierarchy of the library and the utilities needed to help almost
everything else in the app function.</p>
</section>
<section id="datasources-and-messaging">
<h2>DataSources and Messaging<a class="headerlink" href="#datasources-and-messaging" title="Link to this heading"></a></h2>
<p>Due to their extreme importance in the library, the data sources are listed separately along with the classes that help
manage them and their data.</p>
</section>
<section id="time-management">
<h2>Time Management<a class="headerlink" href="#time-management" title="Link to this heading"></a></h2>
<p>Currently <strong>WIP</strong> but this module will contain the classes and functions that help manage the current time and other
playback features of groups of datasources/datafeeds</p>
</section>
<section id="styling">
<h2>Styling<a class="headerlink" href="#styling" title="Link to this heading"></a></h2>
<p><strong>WIP</strong> This module contains the classes and functions that help manage the styling and visualization recommendations that
the library provides.</p>
</section>
<section id="datastore">
<h2>Datastore<a class="headerlink" href="#datastore" title="Link to this heading"></a></h2>
<p><strong>WIP</strong> This module is for managing the state of the app. The configurations files are intended to be interchgangale
among all language versions of the OSHConnect ecosystem.</p>
</section>
<section id="core-data-models">
<h2>Core Data Models<a class="headerlink" href="#core-data-models" title="Link to this heading"></a></h2>
<p>Theses data models are not often intended to be used directly by the user, but are used by the library to help manage
validation of data that flows to and from the API.</p>
<section id="helpers">
<h3>Helpers<a class="headerlink" href="#helpers" title="Link to this heading"></a></h3>
</section>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to OSHConnect-Python’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="tutorial.html" class="btn btn-neutral float-right" title="OSH Connect Tutorial" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2024, Botts Innovative Research, Inc..</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>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>