Skip to content

Commit

Permalink
Deploying to gh-pages from @ 717504b 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
Github Action committed Feb 16, 2024
1 parent 81a11ec commit 4ec2336
Show file tree
Hide file tree
Showing 9 changed files with 23 additions and 21 deletions.
Binary file modified .doctrees/changes/unreleased.doctree
View file
Binary file not shown.
Binary file modified .doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified .doctrees/user_guide/advanced.doctree
View file
Binary file not shown.
Binary file modified .doctrees/user_guide/basics.doctree
View file
Binary file not shown.
1 change: 1 addition & 0 deletions _sources/changes/unreleased.md.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

## Documentation
- Added overview of bucketfs system
- Fixed typos in examples

## Dependencies
- [#60](https://github.com/exasol/bucketfs-python/issues/60): Updated typeguard to 4.0.0
Expand Down
1 change: 1 addition & 0 deletions changes/unreleased.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,7 @@ <h2>Feature<a class="headerlink" href="#feature" title="Permalink to this headin
<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this heading">#</a></h2>
<ul class="simple">
<li><p>Added overview of bucketfs system</p></li>
<li><p>Fixed typos in examples</p></li>
</ul>
</section>
<section id="dependencies">
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js
View file

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions user_guide/advanced.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,8 @@ <h3>List files in a Bucket<a class="headerlink" href="#list-files-in-a-bucket" t
<span class="p">)</span>

<span class="n">URL</span> <span class="o">=</span> <span class="s2">&quot;http://localhost:6666&quot;</span>
<span class="n">CREDENTAILS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>
<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTAILS</span><span class="p">)</span>
<span class="n">CREDENTIALS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>
<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTIALS</span><span class="p">)</span>

<span class="n">default_bucket</span> <span class="o">=</span> <span class="n">MappedBucket</span><span class="p">(</span><span class="n">bucketfs</span><span class="p">[</span><span class="s2">&quot;default&quot;</span><span class="p">])</span>
<span class="n">files</span> <span class="o">=</span> <span class="p">[</span><span class="n">file</span> <span class="k">for</span> <span class="n">file</span> <span class="ow">in</span> <span class="n">default_bucket</span><span class="p">]</span>
Expand All @@ -251,9 +251,9 @@ <h3>Upload files to a Bucket<a class="headerlink" href="#upload-files-to-a-bucke
<span class="p">)</span>

<span class="n">URL</span> <span class="o">=</span> <span class="s2">&quot;http://localhost:6666&quot;</span>
<span class="n">CREDENTAILS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>
<span class="n">CREDENTIALS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>

<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTAILS</span><span class="p">)</span>
<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTIALS</span><span class="p">)</span>
<span class="n">bucket</span> <span class="o">=</span> <span class="n">MappedBucket</span><span class="p">(</span><span class="n">bucketfs</span><span class="p">[</span><span class="s2">&quot;default&quot;</span><span class="p">])</span>

<span class="c1"># Upload bytes</span>
Expand Down Expand Up @@ -284,9 +284,9 @@ <h3>Download files from a Bucket<a class="headerlink" href="#download-files-from
<span class="p">)</span>

<span class="n">URL</span> <span class="o">=</span> <span class="s2">&quot;http://localhost:6666&quot;</span>
<span class="n">CREDENTAILS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>
<span class="n">CREDENTIALS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>

<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTAILS</span><span class="p">)</span>
<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTIALS</span><span class="p">)</span>
<span class="n">bucket</span> <span class="o">=</span> <span class="n">MappedBucket</span><span class="p">(</span><span class="n">bucketfs</span><span class="p">[</span><span class="s2">&quot;default&quot;</span><span class="p">])</span>

<span class="c1"># Download as raw bytes</span>
Expand All @@ -309,9 +309,9 @@ <h3>Delete files from Bucket<a class="headerlink" href="#delete-files-from-bucke
<span class="p">)</span>

<span class="n">URL</span> <span class="o">=</span> <span class="s2">&quot;http://localhost:6666&quot;</span>
<span class="n">CREDENTAILS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>
<span class="n">CREDENTIALS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>

<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTAILS</span><span class="p">)</span>
<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTIALS</span><span class="p">)</span>
<span class="n">bucket</span> <span class="o">=</span> <span class="n">MappedBucket</span><span class="p">(</span><span class="n">bucketfs</span><span class="p">[</span><span class="s2">&quot;default&quot;</span><span class="p">])</span>

<span class="c1"># Delete file from bucket</span>
Expand Down
24 changes: 12 additions & 12 deletions user_guide/basics.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -226,9 +226,9 @@ <h3>List buckets<a class="headerlink" href="#list-buckets" title="Permalink to t
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">exasol.bucketfs</span> <span class="kn">import</span> <span class="n">Service</span>

<span class="n">URL</span> <span class="o">=</span> <span class="s2">&quot;http://localhost:6666&quot;</span>
<span class="n">CREDENTAILS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>
<span class="n">CREDENTIALS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>

<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTAILS</span><span class="p">)</span>
<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTIALS</span><span class="p">)</span>
<span class="n">buckets</span> <span class="o">=</span> <span class="p">[</span><span class="n">bucket</span> <span class="k">for</span> <span class="n">bucket</span> <span class="ow">in</span> <span class="n">bucketfs</span><span class="p">]</span>

</pre></div>
Expand All @@ -239,9 +239,9 @@ <h3>Get a Bucket reference<a class="headerlink" href="#get-a-bucket-reference" t
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">exasol.bucketfs</span> <span class="kn">import</span> <span class="n">Service</span>

<span class="n">URL</span> <span class="o">=</span> <span class="s2">&quot;http://localhost:6666&quot;</span>
<span class="n">CREDENTAILS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>
<span class="n">CREDENTIALS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>

<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTAILS</span><span class="p">)</span>
<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTIALS</span><span class="p">)</span>
<span class="n">default_bucket</span> <span class="o">=</span> <span class="n">bucketfs</span><span class="p">[</span><span class="s2">&quot;default&quot;</span><span class="p">]</span>
</pre></div>
</div>
Expand All @@ -257,8 +257,8 @@ <h3>List files in a Bucket<a class="headerlink" href="#list-files-in-a-bucket" t
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">exasol.bucketfs</span> <span class="kn">import</span> <span class="n">Service</span>

<span class="n">URL</span> <span class="o">=</span> <span class="s2">&quot;http://localhost:6666&quot;</span>
<span class="n">CREDENTAILS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>
<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTAILS</span><span class="p">)</span>
<span class="n">CREDENTIALS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>
<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTIALS</span><span class="p">)</span>

<span class="n">default_bucket</span> <span class="o">=</span> <span class="n">bucketfs</span><span class="p">[</span><span class="s2">&quot;default&quot;</span><span class="p">]</span>
<span class="n">files</span> <span class="o">=</span> <span class="p">[</span><span class="n">file</span> <span class="k">for</span> <span class="n">file</span> <span class="ow">in</span> <span class="n">default_bucket</span><span class="p">]</span>
Expand All @@ -273,9 +273,9 @@ <h3>Upload files to a Bucket<a class="headerlink" href="#upload-files-to-a-bucke
<span class="kn">from</span> <span class="nn">exasol.bucketfs</span> <span class="kn">import</span> <span class="n">Service</span>

<span class="n">URL</span> <span class="o">=</span> <span class="s2">&quot;http://localhost:6666&quot;</span>
<span class="n">CREDENTAILS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>
<span class="n">CREDENTIALS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>

<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTAILS</span><span class="p">)</span>
<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTIALS</span><span class="p">)</span>
<span class="n">bucket</span> <span class="o">=</span> <span class="n">bucketfs</span><span class="p">[</span><span class="s2">&quot;default&quot;</span><span class="p">]</span>

<span class="c1"># Upload bytes</span>
Expand Down Expand Up @@ -325,9 +325,9 @@ <h4>Available Converters<a class="headerlink" href="#available-converters" title
<span class="p">)</span>

<span class="n">URL</span> <span class="o">=</span> <span class="s2">&quot;http://localhost:6666&quot;</span>
<span class="n">CREDENTAILS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>
<span class="n">CREDENTIALS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>

<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTAILS</span><span class="p">)</span>
<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTIALS</span><span class="p">)</span>
<span class="n">bucket</span> <span class="o">=</span> <span class="n">bucketfs</span><span class="p">[</span><span class="s2">&quot;default&quot;</span><span class="p">]</span>

<span class="c1"># Download as raw bytes</span>
Expand All @@ -352,9 +352,9 @@ <h3>Delete files from Bucket<a class="headerlink" href="#delete-files-from-bucke
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">exasol.bucketfs</span> <span class="kn">import</span> <span class="n">Service</span>

<span class="n">URL</span> <span class="o">=</span> <span class="s2">&quot;http://localhost:6666&quot;</span>
<span class="n">CREDENTAILS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>
<span class="n">CREDENTIALS</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;username&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="s2">&quot;write&quot;</span><span class="p">}}</span>

<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTAILS</span><span class="p">)</span>
<span class="n">bucketfs</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">CREDENTIALS</span><span class="p">)</span>
<span class="n">bucket</span> <span class="o">=</span> <span class="n">bucketfs</span><span class="p">[</span><span class="s2">&quot;default&quot;</span><span class="p">]</span>

<span class="c1"># Delete file from bucket</span>
Expand Down

0 comments on commit 4ec2336

Please sign in to comment.