Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add Python SDK API documentation #148

Merged
merged 2 commits into from
Nov 8, 2023
Merged

docs: Add Python SDK API documentation #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e64c03
docs: Add Python SDK API documentation
pniedzielski Nov 7, 2023
7d9a494
docs: Add link to the Python SDK documentation
pniedzielski Nov 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/docs/apidocs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ permalink: /apidocs

- [Java API Documentation](java_apidocs/index.html)
- [C++ API Documentation](cpp_apidocs/index.html)
- [Python API Documentation](python_apidocs/index.html)
171 changes: 171 additions & 0 deletions docs/docs/apidocs/python_apidocs/BUILD.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Build instructions for the BlazingMQ Python SDK &mdash; blazingmq 1.2.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[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=6efca38a"></script>
<script src="_static/doctools.js?v=888ff710"></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="prev" title="Changelog" href="CHANGELOG.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">
blazingmq
</a>
<div class="version">
1.2.0
</div>
<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">
<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="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="acknowledgments.html">Acknowledgments</a></li>
<li class="toctree-l1"><a class="reference internal" href="message_properties.html">Message Properties</a></li>
<li class="toctree-l1"><a class="reference internal" href="queue_options_and_configuration.html">Queue Options and Configuration</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="CHANGELOG.html">Changelog</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Build instructions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#using-make-vs-tox">Using <code class="docutils literal notranslate"><span class="pre">make</span></code> vs. <code class="docutils literal notranslate"><span class="pre">tox</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#local-development">Local Development</a></li>
<li class="toctree-l2"><a class="reference internal" href="#working-with-make-targets">Working with Make Targets</a></li>
</ul>
</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">blazingmq</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">Build instructions for the BlazingMQ Python SDK</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/BUILD.md.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">

<section id="build-instructions-for-the-blazingmq-python-sdk">
<h1>Build instructions for the BlazingMQ Python SDK<a class="headerlink" href="#build-instructions-for-the-blazingmq-python-sdk" title="Link to this heading"></a></h1>
<p>Running the entire test-suite with all supported interpreters on all
supported architectures is difficult to do, and should already be set
up with GitHub Actions. We advise testing with a single version of
Python on a single architecture locally, and using the GitHub Actions
CI to test on all other combinations in your pull request. See
<code class="docutils literal notranslate"><span class="pre">.github/workflows/build.yaml</span></code> for more details on how we build and
test on all supported interpreters and architectures.</p>
<p>The instructions below assume <code class="docutils literal notranslate"><span class="pre">PYEXEC=python3.9</span></code> and will focus on Linux only.
This should be sufficient in most cases.</p>
<p>Before following any of the instructions, make sure to <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span></code> the project onto the host machine.</p>
<section id="using-make-vs-tox">
<h2>Using <code class="docutils literal notranslate"><span class="pre">make</span></code> vs. <code class="docutils literal notranslate"><span class="pre">tox</span></code><a class="headerlink" href="#using-make-vs-tox" title="Link to this heading"></a></h2>
<p>Once the build environment is properly initialized, the project can
be built in-tree (in the project’s working directory tree) using
<code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">build</span></code>. This is useful to iterate quickly. However, it has the
disadvantages of having to install all of the required
build/test/lint dependencies, along with the potential to
accidentally test against the wrong artifact due to the in-tree build.</p>
<p>For a more comprehensive, self-contained setup, use <code class="docutils literal notranslate"><span class="pre">tox</span></code> to build the project
and run the entire test suite targeting a specific version of the interpreter.
Run <code class="docutils literal notranslate"><span class="pre">tox</span> <span class="pre">-l</span></code> to see all available <code class="docutils literal notranslate"><span class="pre">tox</span></code> environments.</p>
</section>
<section id="local-development">
<h2>Local Development<a class="headerlink" href="#local-development" title="Link to this heading"></a></h2>
<p>The BlazingMQ C++ SDK provides a <code class="docutils literal notranslate"><span class="pre">./build-manylinux.sh</span></code> script and a
`./build-macosx-universal.sh‘ script for setting up a
development environmen.</p>
</section>
<section id="working-with-make-targets">
<h2>Working with Make Targets<a class="headerlink" href="#working-with-make-targets" title="Link to this heading"></a></h2>
<p>When in an interactive command line prompt, you can use the following
<code class="docutils literal notranslate"><span class="pre">make</span></code> targets to build and test the BlazingMQ Python SDK. Check the
GitHub Actions configuration to set up the appropriate environment
variables that may be needed prior to running these commands (such as
setting <code class="docutils literal notranslate"><span class="pre">PYEXEC</span></code>). With a BlazingMQ broker running at
‘tcp://localhost:30114‘, the following targets build and test the
Python SDK:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>make<span class="w"> </span>test-install
<span class="nv">BMQ_BROKER_URI</span><span class="o">=</span>tcp://localhost:30114<span class="w"> </span>make<span class="w"> </span>check
</pre></div>
</div>
<p>Additional <code class="docutils literal notranslate"><span class="pre">make</span></code> targets are provided, such as for test coverage.
Dependencies for these can be installed as follows:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python3.9<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements-dev.txt
</pre></div>
</div>
<p>And now you should be able to run <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">coverage</span></code>.</p>
<p>Examine the <code class="docutils literal notranslate"><span class="pre">Makefile</span></code>, the GitHub Actions configuration, and the <code class="docutils literal notranslate"><span class="pre">tox.ini</span></code>
file to understand more about these targets and how to use them.</p>
</section>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="CHANGELOG.html" class="btn btn-neutral float-left" title="Changelog" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2019-2023, Bloomberg Finance L.P..</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>
124 changes: 124 additions & 0 deletions docs/docs/apidocs/python_apidocs/CHANGELOG.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Changelog &mdash; blazingmq 1.2.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[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=6efca38a"></script>
<script src="_static/doctools.js?v=888ff710"></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="Build instructions for the BlazingMQ Python SDK" href="BUILD.html" />
<link rel="prev" title="API Reference" href="api_reference.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">
blazingmq
</a>
<div class="version">
1.2.0
</div>
<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">
<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="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="acknowledgments.html">Acknowledgments</a></li>
<li class="toctree-l1"><a class="reference internal" href="message_properties.html">Message Properties</a></li>
<li class="toctree-l1"><a class="reference internal" href="queue_options_and_configuration.html">Queue Options and Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_reference.html">API Reference</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="BUILD.html">Build instructions</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">blazingmq</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">Changelog</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/CHANGELOG.md.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">

<blockquote>
<div><p><em>NOTE</em></p>
<p>You should <em>NOT</em> add new change log entries to this file, this
file is managed by towncrier. You <em>may</em> edit previous change logs to
fix problems like typo corrections or such.</p>
</div></blockquote>
<section id="changelog">
<h1>Changelog<a class="headerlink" href="#changelog" title="Link to this heading"></a></h1>
<!-- towncrier release notes start --></section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="api_reference.html" class="btn btn-neutral float-left" title="API Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="BUILD.html" class="btn btn-neutral float-right" title="Build instructions for the BlazingMQ Python SDK" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2019-2023, Bloomberg Finance L.P..</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>
Loading
Loading