You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by gi...@apache.org on 2023/01/15 06:56:49 UTC
[arrow-datafusion-python] 01/01: Publish built docs triggered by cb8afac290cefb48e94b7d220bd03087e19cd93a
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/arrow-datafusion-python.git
commit 5e1ce5b9745372f6ffa2229a2cb92f1a011d1864
Author: github-actions[bot] <gi...@users.noreply.github.com>
AuthorDate: Sun Jan 15 06:56:43 2023 +0000
Publish built docs triggered by cb8afac290cefb48e94b7d220bd03087e19cd93a
---
index.html | 30 +++++++++++++++---------------
1 file changed, 15 insertions(+), 15 deletions(-)
diff --git a/index.html b/index.html
index 3191d88..905d422 100644
--- a/index.html
+++ b/index.html
@@ -314,7 +314,7 @@
</pre></div>
</div>
<p>We can also execute a query against data stored in CSV</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">echo</span> <span class="s2">"a,b\n1,4\n2,5\n3,6"</span> > example.csv
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">echo</span><span class="w"> </span><span class="s2">"a,b\n1,4\n2,5\n3,6"</span><span class="w"> </span>><span class="w"> </span>example.csv
</pre></div>
</div>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">datafusion</span>
@@ -399,7 +399,7 @@
<span class="k">class</span> <span class="nc">MyAccumulator</span><span class="p">(</span><span class="n">Accumulator</span><span class="p">):</span>
- <span class="sd">"""</span>
+<span class="w"> </span><span class="sd">"""</span>
<span class="sd"> Interface of a user-defined accumulation.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
@@ -445,7 +445,7 @@
</section>
<section id="how-to-install-from-pip">
<h2>How to install (from pip)<a class="headerlink" href="#how-to-install-from-pip" title="Permalink to this heading">¶</a></h2>
-<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>pip install datafusion
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>datafusion
</pre></div>
</div>
<p>You can verify the installation by running:</p>
@@ -460,26 +460,26 @@
<p>This assumes that you have rust and cargo installed. We use the workflow recommended by <a class="reference external" href="https://github.com/PyO3/pyo3">pyo3</a> and <a class="reference external" href="https://github.com/PyO3/maturin">maturin</a>.</p>
<p>Bootstrap:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># fetch this repo</span>
-git clone git@github.com:apache/arrow-datafusion-python.git
+git<span class="w"> </span>clone<span class="w"> </span>git@github.com:apache/arrow-datafusion-python.git
<span class="c1"># prepare development environment (used to build wheel / install in development)</span>
-python3 -m venv venv
+python3<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span>venv
<span class="c1"># activate the venv</span>
-<span class="nb">source</span> venv/bin/activate
+<span class="nb">source</span><span class="w"> </span>venv/bin/activate
<span class="c1"># update pip itself if necessary</span>
-python -m pip install -U pip
+python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-U<span class="w"> </span>pip
<span class="c1"># install dependencies (for Python 3.8+)</span>
-python -m pip install -r requirements-310.txt
+python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements-310.txt
</pre></div>
</div>
<p>The tests rely on test data in git submodules.</p>
-<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>git submodule init
-git submodule update
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>submodule<span class="w"> </span>init
+git<span class="w"> </span>submodule<span class="w"> </span>update
</pre></div>
</div>
<p>Whenever rust code changes (your changes or via <cite>git pull</cite>):</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># make sure you activate the venv using "source venv/bin/activate" first</span>
-maturin develop
-python -m pytest
+maturin<span class="w"> </span>develop
+python<span class="w"> </span>-m<span class="w"> </span>pytest
</pre></div>
</div>
</section>
@@ -487,12 +487,12 @@ python -m pytest
<h2>How to update dependencies<a class="headerlink" href="#how-to-update-dependencies" title="Permalink to this heading">¶</a></h2>
<p>To change test dependencies, change the <cite>requirements.in</cite> and run</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># install pip-tools (this can be done only once), also consider running in venv</span>
-python -m pip install pip-tools
-python -m piptools compile --generate-hashes -o requirements-310.txt
+python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>pip-tools
+python<span class="w"> </span>-m<span class="w"> </span>piptools<span class="w"> </span>compile<span class="w"> </span>--generate-hashes<span class="w"> </span>-o<span class="w"> </span>requirements-310.txt
</pre></div>
</div>
<p>To update dependencies, run with <cite>-U</cite></p>
-<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python -m piptools compile -U --generate-hashes -o requirements-310.txt
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>piptools<span class="w"> </span>compile<span class="w"> </span>-U<span class="w"> </span>--generate-hashes<span class="w"> </span>-o<span class="w"> </span>requirements-310.txt
</pre></div>
</div>
<p>More details about pip-tools <a class="reference external" href="https://github.com/jazzband/pip-tools">here</a></p>