deploy: e1b575e

Nasdaq · Sep 5, 2024 · bd97409 · bd97409
commit bd97409
Show file tree

Hide file tree

Showing 48 changed files with 7,876 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 6bf4ba22a979f3ac24eaa0aaaba8f590
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/LICENSE.html b/LICENSE.html
@@ -0,0 +1,121 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="./">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>MIT License &#8212; Nasdaq Protocols Python Library 0.0.1 documentation</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
+    <link rel="stylesheet" type="text/css" href="_static/agogo.css?v=8513425a" />
+    <script src="_static/documentation_options.js?v=d45e8c67"></script>
+    <script src="_static/doctools.js?v=9a2dae69"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="prev" title="Developer’s Guide" href="developer_guide.html" /> 
+  </head><body>
+    <div class="header-wrapper" role="banner">
+      <div class="header">
+        <div class="headertitle"><a
+          href="index.html">Nasdaq Protocols Python Library 0.0.1 documentation</a></div>
+        <div class="rel" role="navigation" aria-label="Related">
+          <a href="developer_guide.html" title="Developer’s Guide"
+             accesskey="P">previous</a> |
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |
+          <a href="genindex.html" title="General Index"
+             accesskey="I">index</a>
+        </div>
+       </div>
+    </div>
+
+    <div class="content-wrapper">
+      <div class="content">
+        <div class="document">
+
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+
+  <section id="mit-license">
+<h1>MIT License<a class="headerlink" href="#mit-license" title="Link to this heading">¶</a></h1>
+<p>Copyright (c) 2024 Nasdaq</p>
+<p>Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:</p>
+<p>The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.</p>
+<p>THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.</p>
+</section>
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+        </div>
+        <div class="sidebar">
+
+          <h3>Table of Contents</h3>
+          <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="api_reference.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="developer_guide.html">Developer’s Guide</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">MIT License</a></li>
+</ul>
+
+          <search role="search">
+            <h3 style="margin-top: 1.5em;">Search</h3>
+            <form class="search" action="search.html" method="get">
+                <input type="text" name="q" />
+                <input type="submit" value="Go" />
+            </form>
+          </search>
+
+        </div>
+        <div class="clearer"></div>
+      </div>
+    </div>
+
+    <div class="footer-wrapper">
+      <div class="footer">
+        <div class="left">
+          <div role="navigation" aria-label="Related">
+            <a href="developer_guide.html" title="Developer’s Guide"
+              >previous</a> |
+            <a href="py-modindex.html" title="Python Module Index"
+              >modules</a> |
+            <a href="genindex.html" title="General Index"
+              >index</a>
+          </div>
+          <div role="note" aria-label="source link">
+              <br/>
+              <a href="_sources/LICENSE.rst.txt"
+                rel="nofollow">Show Source</a>
+          </div>
+        </div>
+
+        <div class="right">
+
+    <div class="footer" role="contentinfo">
+    &#169; Copyright Copyright (c) 2024 Nasdaq.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.0.2.
+    </div>
+        </div>
+        <div class="clearer"></div>
+      </div>
+    </div>
+
+  </body>
+</html>
diff --git a/_sources/LICENSE.rst.txt b/_sources/LICENSE.rst.txt
@@ -0,0 +1,22 @@
+MIT License
+===========
+
+Copyright (c) 2024 Nasdaq
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/_sources/api_reference.rst.txt b/_sources/api_reference.rst.txt
@@ -0,0 +1,11 @@
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   api_reference_soup
+   api_reference_itch
+   api_reference_ouch
+   api_reference_common
diff --git a/_sources/api_reference_common.rst.txt b/_sources/api_reference_common.rst.txt
@@ -0,0 +1,12 @@
+Common api reference
+====================
+
+.. automodule:: nasdaq_protocols.common.message_queue
+
+.. automodule:: nasdaq_protocols.common.session
+
+.. automodule:: nasdaq_protocols.common.types
+
+.. automodule:: nasdaq_protocols.common.utils
+
+.. automodule:: nasdaq_protocols.common.message.types
diff --git a/_sources/api_reference_itch.rst.txt b/_sources/api_reference_itch.rst.txt
@@ -0,0 +1,22 @@
+.. _api-reference-itch:
+ITCH API Reference
+==================
+
+Itch
+----
+.. automodule:: nasdaq_protocols.itch
+
+
+Itch Session
+^^^^^^^^^^^^
+.. autoclass:: nasdaq_protocols.itch.session.ItchSessionId
+    :show-inheritance: True
+
+.. autoclass:: nasdaq_protocols.itch.session.ClientSession
+    :show-inheritance: True
+    :undoc-members: ['send_heartbeat']
+
+
+Itch Messages
+^^^^^^^^^^^^^
+.. automodule:: nasdaq_protocols.itch.core
diff --git a/_sources/api_reference_ouch.rst.txt b/_sources/api_reference_ouch.rst.txt
@@ -0,0 +1,22 @@
+.. _api-reference-ouch:
+OUCH API Reference
+==================
+
+Ouch
+----
+.. automodule:: nasdaq_protocols.ouch
+
+
+Ouch Session
+^^^^^^^^^^^^
+.. autoclass:: nasdaq_protocols.ouch.session.OuchSessionId
+    :show-inheritance: True
+
+.. autoclass:: nasdaq_protocols.ouch.session.ClientSession
+    :show-inheritance: True
+    :undoc-members: ['send_heartbeat']
+
+
+Ouch Messages
+^^^^^^^^^^^^^
+.. automodule:: nasdaq_protocols.ouch.core
diff --git a/_sources/api_reference_soup.rst.txt b/_sources/api_reference_soup.rst.txt
@@ -0,0 +1,25 @@
+.. _api-reference-soup:
+SOUP API Reference
+==================
+
+Soup
+----
+.. automodule:: nasdaq_protocols.soup
+
+
+Soup Session
+^^^^^^^^^^^^
+.. autoclass:: nasdaq_protocols.soup.session.SoupSessionId
+    :show-inheritance: True
+
+.. autoclass:: nasdaq_protocols.soup.session.SoupClientSession
+    :show-inheritance: True
+    :undoc-members: ['send_heartbeat']
+
+.. autoclass:: nasdaq_protocols.soup.session.SoupServerSession
+    :show-inheritance: True
+
+
+Soup Messages
+^^^^^^^^^^^^^
+.. automodule:: nasdaq_protocols.soup.core
diff --git a/_sources/developer_guide.rst.txt b/_sources/developer_guide.rst.txt
@@ -0,0 +1,39 @@
+Developer's Guide
+=================
+
+This guide is intended for developers who want to contribute to the
+development of the `nasdaq-protocols` library.
+
+
+Guidelines
+----------
+Before merging to main, please ensure that the following guidelines are met:
+
+- All existing tests are passing.
+- New tests are added when needed.
+- Pylint reports no errors, 10/10
+- Code is documented and docstrings are added when needed.
+- Documentation is included in the rst files.
+
+
+Building
+________
+.. code-block:: console
+
+    $ tox r
+
+`tox r` will execute all of the following.
+
+- `tox -e lint` - Runs linter and validates the code
+- `tox -e test` - Runs the pytest test cases
+- `tox -e build` - Builds the package sdist and wheel
+- `tox -e doc` - Builds the documentation
+
+
+FAQ
+___
+- **Why is pycharm debugger not stopping at breakpoints?**
+  Disable the coverage statement from pytest.ini. Refer https://stackoverflow.com/a/56235965/4248850
+
+- **Why is the coverage not reported in pycharm?**
+  Disable the coverage statement from pytest.ini
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -0,0 +1,39 @@
+.. nasdaq-protocols documentation master file, created by
+   sphinx-quickstart on Thu Jan  4 23:40:15 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to nasdaq-protocols's documentation!
+============================================
+
+.. automodule:: nasdaq_protocols
+
+nasdaq-protocols contains client side implementations of the various
+publicly available protocols used by Nasdaq ecosystem.
+
+This package contains only the core implementations of the protocols like message
+serialization, deserialization, message validation and session handling. It does not
+contain any actual messages that are exchanged between the client and the server.
+
+The actual messages are application specific and hence has to be defined by the
+user of this library. The user has to define the messages as per the protocol specification
+by extending the base message class defined in the package.
+
+Refer to the :ref:`user-guide`. for more information on how to define the messages and use this package.
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   user_guide
+   api_reference
+   developer_guide
+   LICENSE
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/_sources/install.rst.txt b/_sources/install.rst.txt
@@ -0,0 +1,10 @@
+.. _install-guide:
+
+Installation
+============
+
+To use nasdaq-protocols, install it using pip:
+
+.. code-block:: console
+
+   $ pip install nasdaq-protocols
diff --git a/_sources/user_guide.rst.txt b/_sources/user_guide.rst.txt
@@ -0,0 +1,14 @@
+.. _user-guide:
+
+User Guide
+==========
+
+.. toctree::
+   :maxdepth: 1
+   :caption: User Guides:
+
+   install
+   user_guide_soup
+   user_guide_ouch
+   user_guide_itch
+   user_guide_create_new_project