Source code for exasol.bucketfs._buckets
from __future__ import annotations
@@ -754,9 +812,6 @@ Source code for exasol.bucketfs._buckets
Hide table of contents sidebar
+Skip to content
+
@@ -129,7 +185,8 @@
@@ -159,7 +216,7 @@
-
-
- π€ User Guide
-
+
- π€ User Guide
- Basicβs
- Advanced
- Github Artifacts @@ -167,11 +224,11 @@
- π§° API Reference
- π Developer Guide -
- π Design Documents
-
+
- π Design Documents -
- π Changes
-
+
- π Changes
- Unreleased
- BucketFs Python 0.10.0, released 2024-05-15
- BucketFs Python 0.9.0, released 2024-02-16 @@ -208,7 +265,8 @@
- π€ User Guide
-
+
- π€ User Guide
- Basicβs
- Advanced
- Github Artifacts @@ -167,11 +224,11 @@
- π§° API Reference
- π Developer Guide -
- π Design Documents
-
+
- π Design Documents -
- π Changes
-
+
- π Changes
- Unreleased
- BucketFs Python 0.10.0, released 2024-05-15
- BucketFs Python 0.9.0, released 2024-02-16 @@ -208,7 +265,8 @@
- π€ User Guide
-
+
- π€ User Guide
- Basicβs
- Advanced
- Github Artifacts @@ -167,11 +224,11 @@
- π§° API Reference
- π Developer Guide -
- π Design Documents
-
+
- π Design Documents -
- π Changes
-
+
- π Changes
- Unreleased
- BucketFs Python 0.10.0, released 2024-05-15
- BucketFs Python 0.9.0, released 2024-02-16 @@ -208,7 +265,8 @@
- π€ User Guide
-
+
- π€ User Guide
- Basicβs
- Advanced
- Github Artifacts @@ -167,11 +224,11 @@
- π§° API Reference
- π Developer Guide -
- π Design Documents
-
+
- π Design Documents -
- π Changes
-
+
- π Changes
- Unreleased
- BucketFs Python 0.10.0, released 2024-05-15
- BucketFs Python 0.9.0, released 2024-02-16 @@ -208,7 +265,8 @@
- exasol.bucketfs._buckets
- exasol.bucketfs._convert @@ -257,9 +315,6 @@
@@ -218,7 +276,7 @@-+ All modules for which code is available
All modules for which code is available
- π Changes
- π€ User Guide
@@ -218,7 +276,7 @@-+ Source code for exasol.bucketfs._service
- - - diff --git a/_modules/index.html b/_modules/index.html index 06bbd617..fb89425e 100644 --- a/_modules/index.html +++ b/_modules/index.html @@ -1,13 +1,13 @@ - + - +from __future__ import annotations @@ -347,9 +405,6 @@
Source code for exasol.bucketfs._service
Overview: module code - Bucketfs - + @@ -68,7 +68,7 @@Light mode @@ -112,6 +166,8 @@Hide table of contents sidebar+Skip to content +@@ -129,7 +185,8 @@@@ -159,7 +216,7 @@- - - diff --git a/_sources/changes/unreleased.md.txt b/_sources/changes/unreleased.md.txt index 1e3761d4..297bcc84 100644 --- a/_sources/changes/unreleased.md.txt +++ b/_sources/changes/unreleased.md.txt @@ -1 +1,5 @@ -# Unreleased \ No newline at end of file +# Unreleased + +## Internal +- Updated lockfile +- Update workflows to align with used exasol-toolbox version (0.12.0) diff --git a/_sources/developer_guide/developer_guide.rst.txt b/_sources/developer_guide/developer_guide.rst.txt index c41d7839..a3bbc1e4 100644 --- a/_sources/developer_guide/developer_guide.rst.txt +++ b/_sources/developer_guide/developer_guide.rst.txt @@ -28,36 +28,47 @@ Setup pre-commit hook(s) Creating a Release ******************* -Prerequisites -------------- +Prepare the Release +------------------- -* Change log needs to be up to date -* Latest change log version needs to match project and package version -* Release tag needs to match package, changelog and project version +To prepare for a release, a pull request with the following parameters needs to be created: - For Example: - * Tag: 0.4.0 - * Changelog: changes_0.4.0.md - * \`poetry version -s\`: 0.4.0 +- Updated version numbers +- Updated the changelog +- Updated workflow templates (not automated yet) + +This can be achieved by running the following command: + +.. code-block:: shell + + nox -s prepare-release ---
-
. . + +Replace ` `, ` `, and ` ` with the appropriate version numbers. +Once the PR is successfully merged, the release can be triggered (see next section). Triggering the Release ---------------------- -In order to trigger a release a new tag must be pushed to Github. -For further details see: `.github/workflows/ci-cd.yml`. +.. warning:: -#. Create a local tag with the appropriate version number + Before creating a tag for a release, make sure you have pulled in the latest changes + from **master/main** (:code:`git pull`). + +To trigger a release, a new tag must be pushed to GitHub. For further details, see `.github/workflows/ci-cd.yml`. + +1. Create a local tag with the appropriate version number: .. code-block:: shell git tag x.y.z -#. Push the tag to Github +2. Push the tag to GitHub: .. code-block:: shell git push origin x.y.z + What to do if the release failed? --------------------------------- @@ -90,3 +101,4 @@ One of the release steps failed (Partial Release) **Scenario**: Publishing of the release on Github was successfully but during the PyPi release, the upload step got interrupted. **Solution**: Manually push the package to PyPi + diff --git a/_static/_sphinx_javascript_frameworks_compat.js b/_static/_sphinx_javascript_frameworks_compat.js deleted file mode 100644 index 8549469d..00000000 --- a/_static/_sphinx_javascript_frameworks_compat.js +++ /dev/null @@ -1,134 +0,0 @@ -/* - * _sphinx_javascript_frameworks_compat.js - * ~~~~~~~~~~ - * - * Compatability shim for jQuery and underscores.js. - * - * WILL BE REMOVED IN Sphinx 6.0 - * xref RemovedInSphinx60Warning - * - */ - -/** - * select a different prefix for underscore - */ -$u = _.noConflict(); - - -/** - * small helper function to urldecode strings - * - * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL - */ -jQuery.urldecode = function(x) { - if (!x) { - return x - } - return decodeURIComponent(x.replace(/\+/g, ' ')); -}; - -/** - * small helper function to urlencode strings - */ -jQuery.urlencode = encodeURIComponent; - -/** - * This function returns the parsed url parameters of the - * current request. Multiple values per key are supported, - * it will always return arrays of strings for the value parts. - */ -jQuery.getQueryParameters = function(s) { - if (typeof s === 'undefined') - s = document.location.search; - var parts = s.substr(s.indexOf('?') + 1).split('&'); - var result = {}; - for (var i = 0; i < parts.length; i++) { - var tmp = parts[i].split('=', 2); - var key = jQuery.urldecode(tmp[0]); - var value = jQuery.urldecode(tmp[1]); - if (key in result) - result[key].push(value); - else - result[key] = [value]; - } - return result; -}; - -/** - * highlight a given string on a jquery object by wrapping it in - * span elements with the given class name. - */ -jQuery.fn.highlightText = function(text, className) { - function highlight(node, addItems) { - if (node.nodeType === 3) { - var val = node.nodeValue; - var pos = val.toLowerCase().indexOf(text); - if (pos >= 0 && - !jQuery(node.parentNode).hasClass(className) && - !jQuery(node.parentNode).hasClass("nohighlight")) { - var span; - var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); - if (isInSVG) { - span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); - } else { - span = document.createElement("span"); - span.className = className; - } - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - node.parentNode.insertBefore(span, node.parentNode.insertBefore( - document.createTextNode(val.substr(pos + text.length)), - node.nextSibling)); - node.nodeValue = val.substr(0, pos); - if (isInSVG) { - var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); - var bbox = node.parentElement.getBBox(); - rect.x.baseVal.value = bbox.x; - rect.y.baseVal.value = bbox.y; - rect.width.baseVal.value = bbox.width; - rect.height.baseVal.value = bbox.height; - rect.setAttribute('class', className); - addItems.push({ - "parent": node.parentNode, - "target": rect}); - } - } - } - else if (!jQuery(node).is("button, select, textarea")) { - jQuery.each(node.childNodes, function() { - highlight(this, addItems); - }); - } - } - var addItems = []; - var result = this.each(function() { - highlight(this, addItems); - }); - for (var i = 0; i < addItems.length; ++i) { - jQuery(addItems[i].parent).before(addItems[i].target); - } - return result; -}; - -/* - * backward compatibility for jQuery.browser - * This will be supported until firefox bug is fixed. - */ -if (!jQuery.browser) { - jQuery.uaMatch = function(ua) { - ua = ua.toLowerCase(); - - var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || - /(webkit)[ \/]([\w.]+)/.exec(ua) || - /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || - /(msie) ([\w.]+)/.exec(ua) || - ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || - []; - - return { - browser: match[ 1 ] || "", - version: match[ 2 ] || "0" - }; - }; - jQuery.browser = {}; - jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; -} diff --git a/_static/basic.css b/_static/basic.css index 4e9a9f1f..7577acb1 100644 --- a/_static/basic.css +++ b/_static/basic.css @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- basic theme. * - * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -324,6 +324,7 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } + nav.contents, aside.topic, div.admonition, div.topic, blockquote { @@ -331,6 +332,7 @@ div.admonition, div.topic, blockquote { } /* -- topics ---------------------------------------------------------------- */ + nav.contents, aside.topic, div.topic { @@ -606,6 +608,7 @@ ol.simple p, ul.simple p { margin-bottom: 0; } + aside.footnote > span, div.citation > span { float: left; diff --git a/_static/doctools.js b/_static/doctools.js index 527b876c..d06a71d7 100644 --- a/_static/doctools.js +++ b/_static/doctools.js @@ -4,7 +4,7 @@ * * Base JavaScript utilities for all Sphinx HTML documentation. * - * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/_static/jquery-3.6.0.js b/_static/jquery-3.6.0.js deleted file mode 100644 index fc6c299b..00000000 --- a/_static/jquery-3.6.0.js +++ /dev/null @@ -1,10881 +0,0 @@ -/*! - * jQuery JavaScript Library v3.6.0 - * https://jquery.com/ - * - * Includes Sizzle.js - * https://sizzlejs.com/ - * - * Copyright OpenJS Foundation and other contributors - * Released under the MIT license - * https://jquery.org/license - * - * Date: 2021-03-02T17:08Z - */ -( function( global, factory ) { - - "use strict"; - - if ( typeof module === "object" && typeof module.exports === "object" ) { - - // For CommonJS and CommonJS-like environments where a proper `window` - // is present, execute the factory and get jQuery. - // For environments that do not have a `window` with a `document` - // (such as Node.js), expose a factory as module.exports. - // This accentuates the need for the creation of a real `window`. - // e.g. var jQuery = require("jquery")(window); - // See ticket #14549 for more info. - module.exports = global.document ? - factory( global, true ) : - function( w ) { - if ( !w.document ) { - throw new Error( "jQuery requires a window with a document" ); - } - return factory( w ); - }; - } else { - factory( global ); - } - -// Pass this if window is not defined yet -} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { - -// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 -// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode -// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common -// enough that all such attempts are guarded in a try block. -"use strict"; - -var arr = []; - -var getProto = Object.getPrototypeOf; - -var slice = arr.slice; - -var flat = arr.flat ? function( array ) { - return arr.flat.call( array ); -} : function( array ) { - return arr.concat.apply( [], array ); -}; - - -var push = arr.push; - -var indexOf = arr.indexOf; - -var class2type = {}; - -var toString = class2type.toString; - -var hasOwn = class2type.hasOwnProperty; - -var fnToString = hasOwn.toString; - -var ObjectFunctionString = fnToString.call( Object ); - -var support = {}; - -var isFunction = function isFunction( obj ) { - - // Support: Chrome <=57, Firefox <=52 - // In some browsers, typeof returns "function" for HTML
- π Changes
- π€ User Guide
@@ -218,7 +276,7 @@-+ Source code for exasol.bucketfs._error
- - - diff --git a/_modules/exasol/bucketfs/_service.html b/_modules/exasol/bucketfs/_service.html index 159be73c..37d12047 100644 --- a/_modules/exasol/bucketfs/_service.html +++ b/_modules/exasol/bucketfs/_service.html @@ -1,13 +1,13 @@ - + - +from __future__ import annotations @@ -261,9 +319,6 @@
Source code for exasol.bucketfs._error
exasol.bucketfs._service - Bucketfs - + @@ -68,7 +68,7 @@Light mode @@ -112,6 +166,8 @@Hide table of contents sidebar+Skip to content +@@ -129,7 +185,8 @@@@ -159,7 +216,7 @@-
-
- π Changes
- π€ User Guide
@@ -218,7 +276,7 @@-+ Source code for exasol.bucketfs._convert
- - - diff --git a/_modules/exasol/bucketfs/_error.html b/_modules/exasol/bucketfs/_error.html index df5a25f7..b4b50ada 100644 --- a/_modules/exasol/bucketfs/_error.html +++ b/_modules/exasol/bucketfs/_error.html @@ -1,13 +1,13 @@ - + - +from __future__ import annotations @@ -354,9 +412,6 @@
Source code for exasol.bucketfs._convert
exasol.bucketfs._error - Bucketfs - + @@ -68,7 +68,7 @@Light mode @@ -112,6 +166,8 @@Hide table of contents sidebar+Skip to content +@@ -129,7 +185,8 @@@@ -159,7 +216,7 @@-
-
- π Changes
- π€ User Guide