This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-staging
in repository https://gitbox.apache.org/repos/asf/burr.git
The following commit(s) were added to refs/heads/asf-staging by this push:
new c805de91 Deploy documentation from
7893805fd73307eddd722061d03f74c43aacf5d4
c805de91 is described below
commit c805de91c5a42a60ad5d4047029249a739b44c9a
Author: GitHub Actions <[email protected]>
AuthorDate: Sun Nov 30 16:20:56 2025 +0000
Deploy documentation from 7893805fd73307eddd722061d03f74c43aacf5d4
---
content/_sources/contributing/setup.rst.txt | 16 ++++++++++++++++
content/_sources/getting_started/install.rst.txt | 1 -
content/contributing/setup/index.html | 11 +++++++++++
content/genindex/index.html | 12 +++++++++++-
content/objects.inv | Bin 4472 -> 4477 bytes
content/reference/application/index.html | 2 +-
content/reference/state/index.html | 11 +++++++++++
content/searchindex.js | 2 +-
8 files changed, 51 insertions(+), 4 deletions(-)
diff --git a/content/_sources/contributing/setup.rst.txt
b/content/_sources/contributing/setup.rst.txt
index f9e29781..efe856d3 100644
--- a/content/_sources/contributing/setup.rst.txt
+++ b/content/_sources/contributing/setup.rst.txt
@@ -47,6 +47,22 @@ Next you'll want to ``cd`` into the directory and install
cd burr
pip install -e ".[developer]"
+You can also use dependency group:
+
+.. code-block:: bash
+
+ pip install -e . --group dev
+
+or, if you use ``uv``:
+
+.. code-block:: bash
+
+ uv sync
+
+The latter command will automatically create and install virtual env if one
does not exist and will
+automatically install the project in editable mode with all developer
dependencies defined in dev
+dependency group.
+
This will install all potential dependencies. Burr will work with ``python
>=3.9``.
------------------
diff --git a/content/_sources/getting_started/install.rst.txt
b/content/_sources/getting_started/install.rst.txt
index db7d2e1e..1afa3fbd 100644
--- a/content/_sources/getting_started/install.rst.txt
+++ b/content/_sources/getting_started/install.rst.txt
@@ -66,7 +66,6 @@ This installs the dependencies to run the burr CLI, i.e.
`burr --help`.
This installs all the dependencies for developing locally.
-
.. code-block:: bash
pip install "burr[documentation]"
diff --git a/content/contributing/setup/index.html
b/content/contributing/setup/index.html
index 938e6e35..4b341a6b 100644
--- a/content/contributing/setup/index.html
+++ b/content/contributing/setup/index.html
@@ -389,6 +389,17 @@ Replace with your package manager of choice if you
prefer.</p>
pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w">
</span><span class="s2">".[developer]"</span>
</pre></div>
</div>
+<p>You can also use dependency group:</p>
+<div class="highlight-bash notranslate"><div
class="highlight"><pre><span></span>pip<span class="w"> </span>install<span
class="w"> </span>-e<span class="w"> </span>.<span class="w">
</span>--group<span class="w"> </span>dev
+</pre></div>
+</div>
+<p>or, if you use <code class="docutils literal notranslate"><span
class="pre">uv</span></code>:</p>
+<div class="highlight-bash notranslate"><div
class="highlight"><pre><span></span>uv<span class="w"> </span>sync
+</pre></div>
+</div>
+<p>The latter command will automatically create and install virtual env if one
does not exist and will
+automatically install the project in editable mode with all developer
dependencies defined in dev
+dependency group.</p>
<p>This will install all potential dependencies. Burr will work with <code
class="docutils literal notranslate"><span class="pre">python</span> <span
class="pre">>=3.9</span></code>.</p>
</section>
<section id="linting-pre-commit">
diff --git a/content/genindex/index.html b/content/genindex/index.html
index 0a9f50c0..b93119fe 100644
--- a/content/genindex/index.html
+++ b/content/genindex/index.html
@@ -361,7 +361,7 @@
<section class="genindex-section">
<h1 id="index">Index</h1>
- <div class="genindex-jumpbox"><a href="#_"><strong>_</strong></a> | <a
href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a
href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a
href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a
href="#G"><strong>G</strong></a> | <a href="#H"><strong>H</strong></a> | <a
href="#I"><strong>I</strong></a> | <a href="#L"><strong>L</strong></a> | <a
href="#M"><strong>M</strong></a> | <a h [...]
+ <div class="genindex-jumpbox"><a href="#_"><strong>_</strong></a> | <a
href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a
href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a
href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a
href="#G"><strong>G</strong></a> | <a href="#H"><strong>H</strong></a> | <a
href="#I"><strong>I</strong></a> | <a href="#K"><strong>K</strong></a> | <a
href="#L"><strong>L</strong></a> | <a h [...]
</section>
<section id="_" class="genindex-section">
<h2>_</h2>
@@ -856,6 +856,16 @@
</tr></table>
</section>
+<section id="K" class="genindex-section">
+ <h2>K</h2>
+ <table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="../reference/state/#burr.core.state.State.keys">keys()
(burr.core.state.State method)</a>
+</li>
+ </ul></td>
+ </tr></table>
+</section>
+
<section id="L" class="genindex-section">
<h2>L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
diff --git a/content/objects.inv b/content/objects.inv
index 43665f7c..c2aaf559 100644
Binary files a/content/objects.inv and b/content/objects.inv differ
diff --git a/content/reference/application/index.html
b/content/reference/application/index.html
index 94f1b332..f9dfdb90 100644
--- a/content/reference/application/index.html
+++ b/content/reference/application/index.html
@@ -946,7 +946,7 @@ allowed to have a return value.</p>
<dd><em class="sig-param"><span class="n"><span
class="pre">inputs</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span
class="pre">str</span><span class="p"><span class="pre">,</span></span><span
class="w"> </span><span class="pre">Any</span><span class="p"><span
class="pre">]</span></span><span class="w"> </span><span class="p"><span
class="pre">|</span>< [...]
</dl>
-<span class="sig-paren">)</span> <span class="sig-return"><span
class="sig-return-icon">→</span> <span class="sig-return-typehint"><span
class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><a
class="reference internal" href="../actions/#burr.core.action.Action"
title="burr.core.action.Action"><span class="pre">Action</span></a><span
class="p"><span class="pre">,</span></span><span class="w"> </span><span
class="pre">dict</span><span class="w"> </span><span cla [...]
+<span class="sig-paren">)</span> <span class="sig-return"><span
class="sig-return-icon">→</span> <span class="sig-return-typehint"><span
class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><a
class="reference internal" href="../actions/#burr.core.action.Action"
title="burr.core.action.Action"><span class="pre">Action</span></a><span
class="p"><span class="pre">,</span></span><span class="w"> </span><span
class="pre">dict</span><span class="w"> </span><span cla [...]
<dd><p>Runs your application through until completion, using async. Does
not give access to the state along the way β if you want that, use
iterate().</p>
<p>Note that tags must be specified by the form β@tag:<tag_name>β to
differentiate them from actions.</p>
diff --git a/content/reference/state/index.html
b/content/reference/state/index.html
index 75d10044..84ba1023 100644
--- a/content/reference/state/index.html
+++ b/content/reference/state/index.html
@@ -477,6 +477,16 @@ must correspond to an integer, or an error will be
raised.</p>
</dl>
</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="burr.core.state.State.keys">
+<span class="sig-name descname"><span class="pre">keys</span></span><span
class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink"
href="#burr.core.state.State.keys" title="Link to this definition">ΒΆ</a></dt>
+<dd><p>Returns a list of the state keys only (without values for cleaner
display).</p>
+<dl class="simple">
+<dt>Returns:</dt><dd><p>list: A list of state keys</p>
+</dd>
+</dl>
+</dd></dl>
+
<dl class="py method">
<dt class="sig sig-object py" id="burr.core.state.State.merge">
<span class="sig-name descname"><span class="pre">merge</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">other</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal" href="#burr.core.state.State"
title="burr.core.state.State"><span
class="pre">State</span></a></span></em><span class="sig-paren">)</span> <span
class="sig-return"><span class="sig-return-icon">&#x [...]
@@ -670,6 +680,7 @@ tracking / persistence.</p>
<li><a class="reference internal" href="#burr.core.state.State.extend"><code
class="docutils literal notranslate"><span
class="pre">State.extend()</span></code></a></li>
<li><a class="reference internal" href="#burr.core.state.State.get_all"><code
class="docutils literal notranslate"><span
class="pre">State.get_all()</span></code></a></li>
<li><a class="reference internal"
href="#burr.core.state.State.increment"><code class="docutils literal
notranslate"><span class="pre">State.increment()</span></code></a></li>
+<li><a class="reference internal" href="#burr.core.state.State.keys"><code
class="docutils literal notranslate"><span
class="pre">State.keys()</span></code></a></li>
<li><a class="reference internal" href="#burr.core.state.State.merge"><code
class="docutils literal notranslate"><span
class="pre">State.merge()</span></code></a></li>
<li><a class="reference internal"
href="#burr.core.state.State.serialize"><code class="docutils literal
notranslate"><span class="pre">State.serialize()</span></code></a></li>
<li><a class="reference internal" href="#burr.core.state.State.subset"><code
class="docutils literal notranslate"><span
class="pre">State.subset()</span></code></a></li>
diff --git a/content/searchindex.js b/content/searchindex.js
index dec278e8..e77484ae 100644
--- a/content/searchindex.js
+++ b/content/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles":{"1. Agent application is modeled as State +
Actions \u2013>
Graph":[[28,"agent-application-is-modeled-as-state-actions-graph"]],"1. Make
your methods async":[[6,"make-your-methods-async"]],"2. Build application
\u2013> built in checkpointing &
tracking":[[28,"build-application-built-in-checkpointing-tracking"]],"2.
Implement the is_async method":[[6,"implement-the-is-async-method"]],"3. Comes
with a UI":[[28,"comes-with-a-ui"]],"3. Use async persisters with [...]
\ No newline at end of file
+Search.setIndex({"alltitles":{"1. Agent application is modeled as State +
Actions \u2013>
Graph":[[28,"agent-application-is-modeled-as-state-actions-graph"]],"1. Make
your methods async":[[6,"make-your-methods-async"]],"2. Build application
\u2013> built in checkpointing &
tracking":[[28,"build-application-built-in-checkpointing-tracking"]],"2.
Implement the is_async method":[[6,"implement-the-is-async-method"]],"3. Comes
with a UI":[[28,"comes-with-a-ui"]],"3. Use async persisters with [...]
\ No newline at end of file
