Deployed 5cf90d3 with MkDocs version: 1.6.0

changelog/index.html

@@ -295,13 +295,22 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#tba-tba" class="md-nav__link">
+  <a href="#unreleased" class="md-nav__link">
     <span class="md-ellipsis">
-      [tba] - tba
+      [Unreleased]
     </span>
   </a>
 
-    <nav class="md-nav" aria-label="[tba] - tba">
+</li>
+
+        <li class="md-nav__item">
+  <a href="#1135-2024-08-13" class="md-nav__link">
+    <span class="md-ellipsis">
+      [1.13.5] - 2024-08-13
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="[1.13.5] - 2024-08-13">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -311,6 +320,15 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#changed" class="md-nav__link">
+    <span class="md-ellipsis">
+      Changed
+    </span>
+  </a>
+
 </li>
 
       </ul>
@@ -338,7 +356,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#changed" class="md-nav__link">
+  <a href="#changed_1" class="md-nav__link">
     <span class="md-ellipsis">
       Changed
     </span>
@@ -371,7 +389,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#changed_1" class="md-nav__link">
+  <a href="#changed_2" class="md-nav__link">
     <span class="md-ellipsis">
       Changed
     </span>
@@ -428,7 +446,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#changed_2" class="md-nav__link">
+  <a href="#changed_3" class="md-nav__link">
     <span class="md-ellipsis">
       Changed
     </span>
@@ -470,7 +488,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#changed_3" class="md-nav__link">
+  <a href="#changed_4" class="md-nav__link">
     <span class="md-ellipsis">
       Changed
     </span>
@@ -536,13 +554,22 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#tba-tba" class="md-nav__link">
+  <a href="#unreleased" class="md-nav__link">
+    <span class="md-ellipsis">
+      [Unreleased]
+    </span>
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#1135-2024-08-13" class="md-nav__link">
     <span class="md-ellipsis">
-      [tba] - tba
+      [1.13.5] - 2024-08-13
     </span>
   </a>
 
-    <nav class="md-nav" aria-label="[tba] - tba">
+    <nav class="md-nav" aria-label="[1.13.5] - 2024-08-13">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -552,6 +579,15 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#changed" class="md-nav__link">
+    <span class="md-ellipsis">
+      Changed
+    </span>
+  </a>
+
 </li>
 
       </ul>
@@ -579,7 +615,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#changed" class="md-nav__link">
+  <a href="#changed_1" class="md-nav__link">
     <span class="md-ellipsis">
       Changed
     </span>
@@ -612,7 +648,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#changed_1" class="md-nav__link">
+  <a href="#changed_2" class="md-nav__link">
     <span class="md-ellipsis">
       Changed
     </span>
@@ -669,7 +705,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#changed_2" class="md-nav__link">
+  <a href="#changed_3" class="md-nav__link">
     <span class="md-ellipsis">
       Changed
     </span>
@@ -711,7 +747,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#changed_3" class="md-nav__link">
+  <a href="#changed_4" class="md-nav__link">
     <span class="md-ellipsis">
       Changed
     </span>
@@ -765,15 +801,23 @@ <h1 id="changelog">Changelog</h1>
 <li><code>Y</code> should be the current bfabric release</li>
 <li><code>Z</code> is increased for feature releases, that should not break the API</li>
 </ul>
-<h2 id="tba-tba">[tba] - tba</h2>
+<h2 id="unreleased">[Unreleased]</h2>
+<h2 id="1135-2024-08-13">[1.13.5] - 2024-08-13</h2>
 <h3 id="added">Added</h3>
 <ul>
 <li>The <code>Bfabric</code> instance is now pickleable.</li>
 <li>Entities mapping:</li>
+<li>Add <code>Entity.id</code> and <code>Entity.web_url</code> properties.</li>
+<li>Add <code>Entity.__getitem__</code> and <code>Entity.get</code> to access fields from the data dictionary directly.</li>
+<li>Add <code>Entity.find_by</code> to find entities by a query.</li>
 <li>More types and relationships</li>
 <li>Relationships defer imports to descriptor call, i.e. circular relationships are possible now.</li>
-<li>Add <code>Entity.id</code> and <code>Entity.web_url</code> properties.</li>
 <li><code>HasOne</code> and <code>HasMany</code> allow defining <code>optional=True</code> to indicate fields which can be missing under some circumstances.</li>
+<li>Add <code>nodelist</code> column and application name to <code>bfabric_list_not_available_proteomics_workunits.py</code> output.</li>
+</ul>
+<h3 id="changed">Changed</h3>
+<ul>
+<li><code>Entity.find_all</code> supports more than 100 IDs now by using the experimental MultiQuery API.</li>
 </ul>
 <h2 id="1134-2024-08-05">[1.13.4] - 2024-08-05</h2>
 <h3 id="added_1">Added</h3>
@@ -783,7 +827,7 @@ <h3 id="added_1">Added</h3>
 <li><code>bfabric_slurm_queue_status.py</code> to quickly check slurm queue status.</li>
 <li><code>Bfabric.save</code> provides <code>method</code> which can be set to <code>checkandinsert</code> for specific use cases.</li>
 </ul>
-<h3 id="changed">Changed</h3>
+<h3 id="changed_1">Changed</h3>
 <ul>
 <li>Most messages are now logged to debug level.</li>
 <li>The old verbose version information is now always logged, to INFO level, since it could entail useful information for error reporting.</li>
@@ -794,7 +838,7 @@ <h3 id="added_2">Added</h3>
 <li>Flask</li>
 <li>New endpoint <code>GET /config/remote_base_url</code> for testing</li>
 </ul>
-<h3 id="changed_1">Changed</h3>
+<h3 id="changed_2">Changed</h3>
 <ul>
 <li>Flask</li>
 <li>Simplify logging by using loguru only.</li>
@@ -815,7 +859,7 @@ <h3 id="added_3">Added</h3>
 <li>Make host and port configurable in <code>bfabric_flask.py</code> (currently only dev mode).</li>
 </ul>
 <h2 id="1131-2024-07-02">[1.13.1] - 2024-07-02</h2>
-<h3 id="changed_2">Changed</h3>
+<h3 id="changed_3">Changed</h3>
 <ul>
 <li>bfabric_save_csv2dataset will raise an error if problematic characters are found in any of the cells</li>
 <li>Correctly define <code>bfabric_setWorkunitStatus_available.py</code>, and <code>processing</code> and <code>failed</code> variants.</li>
@@ -831,7 +875,7 @@ <h3 id="removed">Removed</h3>
 </ul>
 <h2 id="1130-2024-05-24">[1.13.0] - 2024-05-24</h2>
 <p>This is a major release refactoring bfabricPy's API.</p>
-<h3 id="changed_3">Changed</h3>
+<h3 id="changed_4">Changed</h3>
 <ul>
 <li>The <code>Bfabric</code> class operations now return <code>ResultContainer</code> objects.</li>
 <li>These provide a list-like interface to access individual items or iterate over them.</li>

contribute/index.html

@@ -418,7 +418,7 @@
 
 
 <h1 id="contribute">Contribute</h1>
-<p>This page describes some information relevant for contruibuting to bfabricPy.</p>
+<p>This page describes some information relevant for contributing to bfabricPy.</p>
 <h2 id="development-install">Development install</h2>
 <p>You should install the <code>dev</code> group as it contains some extra packages for running the tests.</p>
 <pre><code class="language-bash">pip install -e &quot;.[dev]&quot;

entities/index.html

@@ -441,7 +441,9 @@ <h3 id="entity">Entity</h3>
 <p>Entities are initialized with the full result structure obtained from a <code>read</code> operation on its particular endpoint.
 A <code>return_id_only</code> result is generally not supposed to be used to initialize an entity instance and behavior is undefined as of now.
 In cases where it makes sense to operate on the ids, it's better to directly call the <code>Bfabric</code> client methods.</p>
-<p>Entities can be retrieved with the methods <code>Entity.find</code> and <code>Entity.find_all</code>, whenever loading multiple entities of the same type the latter should be preferred since it reduces the number of API calls and returns a dictionary mapping entity ID to instance.</p>
+<p>Entities can be retrieved with the methods <code>Entity.find</code>, <code>Entity.find_all</code> and <code>Entity.find_by</code>.
+When loading multiple entities of the same type, <code>Entity.find_all</code> and <code>Entity.find_by</code> should be preferred.
+These two methods return a dictionary mapping entity ID to instance and this often helps avoid redundant API calls when expanding relationships over multiple entities.</p>
 <h3 id="relationships">Relationships</h3>
 <p>Custom descriptors are available which are used to represent relationships and enable lazy-loading of data.
 Currently the following descriptors are available:</p>

index.html

@@ -395,7 +395,7 @@ <h2 id="installation">Installation</h2>
 <p>If you want to add it to a <code>pyproject.toml</code> the syntax for specifying a git dependency is as follows:</p>
 <pre><code class="language-toml">[project]
 dependencies = [
-    &quot;bfabricPy @ git+https://github.com/fgcz/bfabricPy.git@stable&quot;
+    &quot;bfabric @ git+https://github.com/fgcz/bfabricPy.git@stable&quot;
 ]
 </code></pre>
 <h2 id="configuration">Configuration</h2>