Merge pull request #1084 from gchq/docs/programatically-using-bailo

Add programmatically using Bailo docs / Fix upload sphinx to Github pages

.github/workflows/web.yml

@@ -21,33 +21,9 @@ permissions:
   id-token: write
 
 jobs:
-  build-sphinx:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Setup Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: '3.11'
-
-      - name: Install pandoc
-        run: sudo apt install pandoc
-
-      - name: Build Sphinx docs
-        run: |
-          python -m pip install --upgrade pip
-          pwd
-          cd lib/python-beta/docs
-          python -m pip install -r requirements.txt
-          make dirhtml
-
   # Build job
   build:
     runs-on: ubuntu-latest
-    needs: build-sphinx
     defaults:
       run:
         working-directory: lib/landing
@@ -89,7 +65,6 @@ jobs:
         run: npm i
       - name: Run generator
         run: npm run generate
-
       - name: Build and export
         run: npm run export
         env:

backend/python-docs/_build/dirhtml/.buildinfo

@@ -1,4 +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: db1993bf4fe87f6a0d251d9236d6e7ea
+config: dbafcd98063260b5743f60ed267116f6
 tags: d77d1c0d9ca2f4c8421862c7c5a0d620

backend/python-docs/_build/dirhtml/_modules/bailo/core/agent/index.html

@@ -8,6 +8,7 @@
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=19f00094" />
 
 
+    <link rel="shortcut icon" href="../../../../_static/favicon.png"/>
   <!--[if lt IE 9]>
     <script src="../../../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
@@ -33,6 +34,7 @@
 
           <a href="../../../../" class="icon icon-home">
             Bailo Python Client Docs
+              <img src="../../../../_static/vertical-white.png" class="logo" alt="Logo"/>
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search/" method="get">

backend/python-docs/_build/dirhtml/_modules/bailo/core/client/index.html

@@ -8,6 +8,7 @@
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=19f00094" />
 
 
+    <link rel="shortcut icon" href="../../../../_static/favicon.png"/>
   <!--[if lt IE 9]>
     <script src="../../../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
@@ -33,6 +34,7 @@
 
           <a href="../../../../" class="icon icon-home">
             Bailo Python Client Docs
+              <img src="../../../../_static/vertical-white.png" class="logo" alt="Logo"/>
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search/" method="get">
@@ -422,24 +424,48 @@ <h1>Source code for bailo.core.client</h1><div class="highlight"><pre>
         <span class="bp">self</span><span class="p">,</span>
         <span class="n">model_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
         <span class="n">file_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
-        <span class="n">buffer</span><span class="p">:</span> <span class="n">BytesIO</span><span class="p">,</span>
     <span class="p">):</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;Download a specific file.</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Download a specific file by it&#39;s id.</span>
 
 <span class="sd">        :param model_id: Unique model ID</span>
 <span class="sd">        :param file_id: Unique file ID</span>
-<span class="sd">        :param buffer: BytesIO object for bailo to write to</span>
 <span class="sd">        :return: The unique file ID</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">agent</span><span class="p">,</span> <span class="n">TokenAgent</span><span class="p">):</span>
-            <span class="n">req</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">agent</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
+            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">agent</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
                 <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">url</span><span class="si">}</span><span class="s2">/v2/token/model/</span><span class="si">{</span><span class="n">model_id</span><span class="si">}</span><span class="s2">/file/</span><span class="si">{</span><span class="n">file_id</span><span class="si">}</span><span class="s2">/download&quot;</span><span class="p">,</span> <span class="n">stream</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10_000</span>
             <span class="p">)</span>
         <span class="k">else</span><span class="p">:</span>
-            <span class="n">req</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">agent</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">url</span><span class="si">}</span><span class="s2">/v2/model/</span><span class="si">{</span><span class="n">model_id</span><span class="si">}</span><span class="s2">/file/</span><span class="si">{</span><span class="n">file_id</span><span class="si">}</span><span class="s2">/download&quot;</span><span class="p">,</span> <span class="n">stream</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10_000</span><span class="p">)</span>
+            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">agent</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
+                <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">url</span><span class="si">}</span><span class="s2">/v2/model/</span><span class="si">{</span><span class="n">model_id</span><span class="si">}</span><span class="s2">/file/</span><span class="si">{</span><span class="n">file_id</span><span class="si">}</span><span class="s2">/download&quot;</span><span class="p">,</span> <span class="n">stream</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10_000</span>
+            <span class="p">)</span></div>
+
+
+<div class="viewcode-block" id="Client.get_download_by_filename">
+<a class="viewcode-back" href="../../../../bailo.core/#bailo.core.client.Client.get_download_by_filename">[docs]</a>
+    <span class="k">def</span> <span class="nf">get_download_by_filename</span><span class="p">(</span>
+        <span class="bp">self</span><span class="p">,</span>
+        <span class="n">model_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+        <span class="n">semver</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+        <span class="n">filename</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+    <span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Download a specific file.</span>
 
-        <span class="n">shutil</span><span class="o">.</span><span class="n">copyfileobj</span><span class="p">(</span><span class="n">req</span><span class="o">.</span><span class="n">raw</span><span class="p">,</span> <span class="n">buffer</span><span class="p">)</span>
-        <span class="k">return</span> <span class="n">file_id</span></div>
+<span class="sd">        :param model_id: Unique model ID</span>
+<span class="sd">        :param semver: Semver of the release</span>
+<span class="sd">        :param filename: The filename trying to download from</span>
+<span class="sd">        :return: The filename</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">agent</span><span class="p">,</span> <span class="n">TokenAgent</span><span class="p">):</span>
+            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">agent</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
+                <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">url</span><span class="si">}</span><span class="s2">/v2/token/model/</span><span class="si">{</span><span class="n">model_id</span><span class="si">}</span><span class="s2">/release/</span><span class="si">{</span><span class="n">semver</span><span class="si">}</span><span class="s2">/file/</span><span class="si">{</span><span class="n">filename</span><span class="si">}</span><span class="s2">/download&quot;</span><span class="p">,</span>
+                <span class="n">stream</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
+                <span class="n">timeout</span><span class="o">=</span><span class="mi">10_000</span><span class="p">,</span>
+            <span class="p">)</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">agent</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
+                <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">url</span><span class="si">}</span><span class="s2">/v2/model/</span><span class="si">{</span><span class="n">model_id</span><span class="si">}</span><span class="s2">/release/</span><span class="si">{</span><span class="n">semver</span><span class="si">}</span><span class="s2">/file/</span><span class="si">{</span><span class="n">filename</span><span class="si">}</span><span class="s2">/download&quot;</span><span class="p">,</span> <span class="n">stream</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10_000</span>
+            <span class="p">)</span></div>
 
 
 <div class="viewcode-block" id="Client.simple_upload">

backend/python-docs/_build/dirhtml/_modules/bailo/core/enums/index.html

@@ -8,6 +8,7 @@
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=19f00094" />
 
 
+    <link rel="shortcut icon" href="../../../../_static/favicon.png"/>
   <!--[if lt IE 9]>
     <script src="../../../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
@@ -33,6 +34,7 @@
 
           <a href="../../../../" class="icon icon-home">
             Bailo Python Client Docs
+              <img src="../../../../_static/vertical-white.png" class="logo" alt="Logo"/>
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search/" method="get">

backend/python-docs/_build/dirhtml/_modules/bailo/core/exceptions/index.html

@@ -8,6 +8,7 @@
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=19f00094" />
 
 
+    <link rel="shortcut icon" href="../../../../_static/favicon.png"/>
   <!--[if lt IE 9]>
     <script src="../../../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
@@ -33,6 +34,7 @@
 
           <a href="../../../../" class="icon icon-home">
             Bailo Python Client Docs
+              <img src="../../../../_static/vertical-white.png" class="logo" alt="Logo"/>
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search/" method="get">

backend/python-docs/_build/dirhtml/_modules/bailo/helper/access_request/index.html

@@ -8,6 +8,7 @@
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=19f00094" />
 
 
+    <link rel="shortcut icon" href="../../../../_static/favicon.png"/>
   <!--[if lt IE 9]>
     <script src="../../../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
@@ -33,6 +34,7 @@
 
           <a href="../../../../" class="icon icon-home">
             Bailo Python Client Docs
+              <img src="../../../../_static/vertical-white.png" class="logo" alt="Logo"/>
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search/" method="get">

backend/python-docs/_build/dirhtml/_modules/bailo/helper/model/index.html

@@ -8,6 +8,7 @@
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=19f00094" />
 
 
+    <link rel="shortcut icon" href="../../../../_static/favicon.png"/>
   <!--[if lt IE 9]>
     <script src="../../../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
@@ -33,6 +34,7 @@
 
           <a href="../../../../" class="icon icon-home">
             Bailo Python Client Docs
+              <img src="../../../../_static/vertical-white.png" class="logo" alt="Logo"/>
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search/" method="get">

backend/python-docs/_build/dirhtml/_modules/bailo/helper/release/index.html

@@ -8,6 +8,7 @@
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=19f00094" />
 
 
+    <link rel="shortcut icon" href="../../../../_static/favicon.png"/>
   <!--[if lt IE 9]>
     <script src="../../../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
@@ -33,6 +34,7 @@
 
           <a href="../../../../" class="icon icon-home">
             Bailo Python Client Docs
+              <img src="../../../../_static/vertical-white.png" class="logo" alt="Logo"/>
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search/" method="get">
@@ -229,19 +231,18 @@ <h1>Source code for bailo.helper.release</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="Release.download">
 <a class="viewcode-back" href="../../../../bailo.helper/#bailo.helper.release.Release.download">[docs]</a>
-    <span class="k">def</span> <span class="nf">download</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">buffer</span><span class="p">:</span> <span class="n">BytesIO</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
+    <span class="k">def</span> <span class="nf">download</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Give returns a Reading object given the file id.</span>
 
-<span class="sd">        :param file_name: The name of the file to retrieve</span>
-<span class="sd">        :param buffer: A BytesIO object</span>
+<span class="sd">        :param filename: The name of the file to retrieve</span>
 <span class="sd">        :return: A JSON response object</span>
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">get_download_file</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">model_id</span><span class="p">,</span> <span class="n">file_id</span><span class="p">,</span> <span class="n">buffer</span><span class="p">)</span></div>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">get_download_by_filename</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">model_id</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">version</span><span class="p">),</span> <span class="n">filename</span><span class="p">)</span></div>
 
 
 <div class="viewcode-block" id="Release.upload">
 <a class="viewcode-back" href="../../../../bailo.helper/#bailo.helper.release.Release.upload">[docs]</a>
-    <span class="k">def</span> <span class="nf">upload</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">file</span><span class="p">:</span> <span class="n">BytesIO</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
+    <span class="k">def</span> <span class="nf">upload</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">file</span><span class="p">:</span> <span class="n">BytesIO</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Upload files in a given directory to the release.</span>
 
 <span class="sd">        :param name: The name of the file to upload to bailo</span>

backend/python-docs/_build/dirhtml/_modules/bailo/helper/schema/index.html

@@ -8,6 +8,7 @@
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=19f00094" />
 
 
+    <link rel="shortcut icon" href="../../../../_static/favicon.png"/>
   <!--[if lt IE 9]>
     <script src="../../../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
@@ -33,6 +34,7 @@
 
           <a href="../../../../" class="icon icon-home">
             Bailo Python Client Docs
+              <img src="../../../../_static/vertical-white.png" class="logo" alt="Logo"/>
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search/" method="get">

backend/python-docs/_build/dirhtml/_modules/index.html

@@ -8,6 +8,7 @@
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
 
 
+    <link rel="shortcut icon" href="../_static/favicon.png"/>
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
@@ -33,6 +34,7 @@
 
           <a href="../" class="icon icon-home">
             Bailo Python Client Docs
+              <img src="../_static/vertical-white.png" class="logo" alt="Logo"/>
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search/" method="get">