Skip to content

Commit 5ea3afd

Browse files
SandrinePdatapythonista
SandrineP
authored and
datapythonista
committed
Adding setup instructions for pandas sprints (python-sprints#8)
1 parent 71deb89 commit 5ea3afd

File tree

9 files changed

+300
-24
lines changed

9 files changed

+300
-24
lines changed

‎pandas/guide/_sources/pandas_setup.rst.txt

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
Instructions for Pandas Sprints
2+
*******************************
3+
4+
The project
5+
===========
6+
`pandas <https://pandas.pydata.org/>`_ is an open source, BSD-licensed library providing high-performance, easy-to-use data structures and data analysis tools for the Python programming language.
7+
8+
pandas is a `NumFOCUS <https://www.numfocus.org/sponsored-projects/>`_ sponsored project. This will help ensure the success of development of pandas as a world-class open-source project, and makes it possible to `donate <https://pandas.pydata.org/donate.html>`_ to the project.
9+
10+
11+
Set up for the sprint
12+
=====================
13+
14+
Make sure you **bring your own laptop** to the sprint.
15+
16+
You need the next softwares installed:
17+
18+
* Git
19+
* An editor (vim, emacs, PyCharm,...)
20+
21+
To **set up the environment**, you have detailed instructions in the `pandas contributing guide <https://pandas.pydata.org/pandas-docs/stable/contributing.html>`_.
22+
23+
Create an account on Github github.com
24+
25+
Get the pandas source code:
26+
27+
* Fork the `pandas project <https://github.com/pandas-dev/pandas>`_ on GitHub (click on the top-right fork button)
28+
* In the terminal, run:
29+
``git clone https://github.com/<your-github-username>/pandas``
30+
31+
A summary of it would be:
32+
33+
* Download and install `Anaconda <https://www.anaconda.com/download/#linux>`_
34+
* Activate conda by one of the next (or equivalent, if you know what you're doing):
35+
| Restart your terminal
36+
| ``. ~/.bashrc``
37+
| ``export PATH="<path-to-anaconda>/bin:$PATH"``
38+
* Create a conda environment:
39+
``conda create -n pandas_dev -f <path-to-pandas>/ci/environment-dev.yaml``
40+
* Activate the new conda environment:
41+
``source activate pandas_dev``
42+
* Install pandas development dependencies:
43+
``conda install -c defaults -c conda-forge --file=<path-to-pandas>/ci/requirements-optional-conda.txt``
44+
* Compile C code in pandas:
45+
| ``python setup.py build_ext --inplace``
46+
| Run the tests:
47+
| ``cd <path-to-pandas>``
48+
| ``pytest pandas``

‎pandas/guide/_static/basic.css

-7
Original file line numberDiff line numberDiff line change
@@ -398,13 +398,6 @@ table.field-list td, table.field-list th {
398398
margin: 0;
399399
}
400400

401-
.field-name {
402-
-moz-hyphens: manual;
403-
-ms-hyphens: manual;
404-
-webkit-hyphens: manual;
405-
hyphens: manual;
406-
}
407-
408401
/* -- other body styles ----------------------------------------------------- */
409402

410403
ol.arabic {

‎pandas/guide/contents.html

+13-10
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
1-
21
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
32
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
43

4+
55
<html xmlns="http://www.w3.org/1999/xhtml">
66
<head>
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8+
89
<title>How to write a good pandas docstring &#8212; Python documentation</title>
10+
911
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
1012
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13+
1114
<script type="text/javascript">
1215
var DOCUMENTATION_OPTIONS = {
1316
URL_ROOT: './',
@@ -30,7 +33,7 @@
3033
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
3134

3235
</head>
33-
<body>
36+
<body role="document">
3437

3538

3639
<div class="document">
@@ -218,9 +221,9 @@ <h3>Section 2: Extended summary<a class="headerlink" href="#section-2-extended-s
218221
<div class="section" id="section-3-parameters">
219222
<h3>Section 3: Parameters<a class="headerlink" href="#section-3-parameters" title="Permalink to this headline"></a></h3>
220223
<p>The details of the parameters will be added in this section. This section has
221-
the title “Parameters”, followed by a line with a hyphen under each letter of
222-
the word “Parameters”. A blank line is left before the section title, but not
223-
after, and not between the line with the word “Parameters” and the one with
224+
the title &#8220;Parameters&#8221;, followed by a line with a hyphen under each letter of
225+
the word &#8220;Parameters&#8221;. A blank line is left before the section title, but not
226+
after, and not between the line with the word &#8220;Parameters&#8221; and the one with
224227
the hyphens.</p>
225228
<p>After the title, each parameter in the signature must be documented, including
226229
<cite>*args</cite> and <cite>**kwargs</cite>, but not <cite>self</cite>.</p>
@@ -296,7 +299,7 @@ <h4>Parameter types<a class="headerlink" href="#parameter-types" title="Permalin
296299
and separated by commas (followed by a space):</p>
297300
<ul class="simple">
298301
<li>{0, 10, 25}</li>
299-
<li>{‘simple’, ‘advanced’}</li>
302+
<li>{&#8216;simple&#8217;, &#8216;advanced&#8217;}</li>
300303
</ul>
301304
<p>If the type is defined in a Python module, the module must be specified:</p>
302305
<ul class="simple">
@@ -315,7 +318,7 @@ <h4>Parameter types<a class="headerlink" href="#parameter-types" title="Permalin
315318
<li>pandas.DataFrame</li>
316319
</ul>
317320
<p>If more than one type is accepted, separate them by commas, except the
318-
last two types, that need to be separated by the word ‘or’:</p>
321+
last two types, that need to be separated by the word &#8216;or&#8217;:</p>
319322
<ul class="simple">
320323
<li>int or float</li>
321324
<li>float, decimal.Decimal or None</li>
@@ -327,8 +330,8 @@ <h4>Parameter types<a class="headerlink" href="#parameter-types" title="Permalin
327330
<h3>Section 4: Returns or Yields<a class="headerlink" href="#section-4-returns-or-yields" title="Permalink to this headline"></a></h3>
328331
<p>If the method returns a value, it will be documented in this section. Also
329332
if the method yields its output.</p>
330-
<p>The title of the section will be defined in the same way as the “Parameters”.
331-
With the names “Returns” or “Yields” followed by a line with as many hyphens
333+
<p>The title of the section will be defined in the same way as the &#8220;Parameters&#8221;.
334+
With the names &#8220;Returns&#8221; or &#8220;Yields&#8221; followed by a line with as many hyphens
332335
as the letters in the preceding word.</p>
333336
<p>The documentation of the return is also similar to the parameters. But in this
334337
case, no name will be provided, unless the method returns or yields more than
@@ -431,7 +434,7 @@ <h3>Quick search</h3>
431434
&copy;.
432435

433436
|
434-
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
437+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.6</a>
435438
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
436439

437440
|

‎pandas/guide/genindex.html

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11

2-
32
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
43
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
54

5+
66
<html xmlns="http://www.w3.org/1999/xhtml">
77
<head>
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9+
910
<title>Index &#8212; Python documentation</title>
11+
1012
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
1113
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
14+
1215
<script type="text/javascript">
1316
var DOCUMENTATION_OPTIONS = {
1417
URL_ROOT: './',
@@ -31,7 +34,7 @@
3134
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
3235

3336
</head>
34-
<body>
37+
<body role="document">
3538

3639

3740
<div class="document">
@@ -82,7 +85,7 @@ <h3>Quick search</h3>
8285
&copy;.
8386

8487
|
85-
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
88+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.6</a>
8689
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
8790

8891
</div>

‎pandas/guide/objects.inv

29 Bytes
Binary file not shown.

‎pandas/guide/pandas_setup.html

+178
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3+
4+
5+
<html xmlns="http://www.w3.org/1999/xhtml">
6+
<head>
7+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8+
9+
<title>Instructions for Pandas Sprints &#8212; Python documentation</title>
10+
11+
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
12+
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13+
14+
<script type="text/javascript">
15+
var DOCUMENTATION_OPTIONS = {
16+
URL_ROOT: './',
17+
VERSION: '',
18+
COLLAPSE_INDEX: false,
19+
FILE_SUFFIX: '.html',
20+
HAS_SOURCE: true,
21+
SOURCELINK_SUFFIX: '.txt'
22+
};
23+
</script>
24+
<script type="text/javascript" src="_static/jquery.js"></script>
25+
<script type="text/javascript" src="_static/underscore.js"></script>
26+
<script type="text/javascript" src="_static/doctools.js"></script>
27+
<link rel="index" title="Index" href="genindex.html" />
28+
<link rel="search" title="Search" href="search.html" />
29+
30+
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
31+
32+
33+
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
34+
35+
</head>
36+
<body role="document">
37+
38+
39+
<div class="document">
40+
<div class="documentwrapper">
41+
<div class="bodywrapper">
42+
<div class="body" role="main">
43+
44+
<div class="section" id="instructions-for-pandas-sprints">
45+
<h1>Instructions for Pandas Sprints<a class="headerlink" href="#instructions-for-pandas-sprints" title="Permalink to this headline"></a></h1>
46+
<div class="section" id="the-project">
47+
<h2>The project<a class="headerlink" href="#the-project" title="Permalink to this headline"></a></h2>
48+
<p><a class="reference external" href="https://pandas.pydata.org/">pandas</a> is an open source, BSD-licensed library providing high-performance, easy-to-use data structures and data analysis tools for the Python programming language.</p>
49+
<p>pandas is a <a class="reference external" href="https://www.numfocus.org/sponsored-projects/">NumFOCUS</a> sponsored project. This will help ensure the success of development of pandas as a world-class open-source project, and makes it possible to <a class="reference external" href="https://pandas.pydata.org/donate.html">donate</a> to the project.</p>
50+
</div>
51+
<div class="section" id="set-up-for-the-sprint">
52+
<h2>Set up for the sprint<a class="headerlink" href="#set-up-for-the-sprint" title="Permalink to this headline"></a></h2>
53+
<p>Make sure you <strong>bring your own laptop</strong> to the sprint.</p>
54+
<p>You need the next softwares installed:</p>
55+
<ul class="simple">
56+
<li>Git</li>
57+
<li>An editor (vim, emacs, PyCharm,...)</li>
58+
</ul>
59+
<p>To <strong>set up the environment</strong>, you have detailed instructions in the <a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/contributing.html">pandas contributing guide</a>.</p>
60+
<p>Create an account on Github github.com</p>
61+
<p>Get the pandas source code:</p>
62+
<ul class="simple">
63+
<li>Fork the <a class="reference external" href="https://github.com/pandas-dev/pandas">pandas project</a> on GitHub (click on the top-right fork button)</li>
64+
<li><dl class="first docutils">
65+
<dt>In the terminal, run:</dt>
66+
<dd><code class="docutils literal"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">https://github.com/&lt;your-github-username&gt;/pandas</span></code></dd>
67+
</dl>
68+
</li>
69+
</ul>
70+
<p>A summary of it would be:</p>
71+
<ul>
72+
<li><p class="first">Download and install <a class="reference external" href="https://www.anaconda.com/download/#linux">Anaconda</a></p>
73+
</li>
74+
<li><dl class="first docutils">
75+
<dt>Activate conda by one of the next (or equivalent, if you know what you&#8217;re doing):</dt>
76+
<dd><div class="first last line-block">
77+
<div class="line">Restart your terminal</div>
78+
<div class="line"><code class="docutils literal"><span class="pre">.</span> <span class="pre">~/.bashrc</span></code></div>
79+
<div class="line"><code class="docutils literal"><span class="pre">export</span> <span class="pre">PATH=&quot;&lt;path-to-anaconda&gt;/bin:$PATH&quot;</span></code></div>
80+
</div>
81+
</dd>
82+
</dl>
83+
</li>
84+
<li><dl class="first docutils">
85+
<dt>Create a conda environment:</dt>
86+
<dd><p class="first last"><code class="docutils literal"><span class="pre">conda</span> <span class="pre">create</span> <span class="pre">-n</span> <span class="pre">pandas_dev</span> <span class="pre">-f</span> <span class="pre">&lt;path-to-pandas&gt;/ci/environment-dev.yaml</span></code></p>
87+
</dd>
88+
</dl>
89+
</li>
90+
<li><dl class="first docutils">
91+
<dt>Activate the new conda environment:</dt>
92+
<dd><p class="first last"><code class="docutils literal"><span class="pre">source</span> <span class="pre">activate</span> <span class="pre">pandas_dev</span></code></p>
93+
</dd>
94+
</dl>
95+
</li>
96+
<li><dl class="first docutils">
97+
<dt>Install pandas development dependencies:</dt>
98+
<dd><p class="first last"><code class="docutils literal"><span class="pre">conda</span> <span class="pre">install</span> <span class="pre">-c</span> <span class="pre">defaults</span> <span class="pre">-c</span> <span class="pre">conda-forge</span> <span class="pre">--file=&lt;path-to-pandas&gt;/ci/requirements-optional-conda.txt</span></code></p>
99+
</dd>
100+
</dl>
101+
</li>
102+
<li><dl class="first docutils">
103+
<dt>Compile C code in pandas:</dt>
104+
<dd><div class="first last line-block">
105+
<div class="line"><code class="docutils literal"><span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">build_ext</span> <span class="pre">--inplace</span></code></div>
106+
<div class="line">Run the tests:</div>
107+
<div class="line"><code class="docutils literal"><span class="pre">cd</span> <span class="pre">&lt;path-to-pandas&gt;</span></code></div>
108+
<div class="line"><code class="docutils literal"><span class="pre">pytest</span> <span class="pre">pandas</span></code></div>
109+
</div>
110+
</dd>
111+
</dl>
112+
</li>
113+
</ul>
114+
</div>
115+
</div>
116+
117+
118+
</div>
119+
</div>
120+
</div>
121+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
122+
<div class="sphinxsidebarwrapper">
123+
<p class="logo"><a href="contents.html">
124+
<img class="logo" src="_static/logo.png" alt="Logo"/>
125+
</a></p>
126+
<h3><a href="contents.html">Table Of Contents</a></h3>
127+
<ul>
128+
<li><a class="reference internal" href="#">Instructions for Pandas Sprints</a><ul>
129+
<li><a class="reference internal" href="#the-project">The project</a></li>
130+
<li><a class="reference internal" href="#set-up-for-the-sprint">Set up for the sprint</a></li>
131+
</ul>
132+
</li>
133+
</ul>
134+
<div class="relations">
135+
<h3>Related Topics</h3>
136+
<ul>
137+
<li><a href="contents.html">Documentation overview</a><ul>
138+
</ul></li>
139+
</ul>
140+
</div>
141+
<div role="note" aria-label="source link">
142+
<h3>This Page</h3>
143+
<ul class="this-page-menu">
144+
<li><a href="_sources/pandas_setup.rst.txt"
145+
rel="nofollow">Show Source</a></li>
146+
</ul>
147+
</div>
148+
<div id="searchbox" style="display: none" role="search">
149+
<h3>Quick search</h3>
150+
<form class="search" action="search.html" method="get">
151+
<div><input type="text" name="q" /></div>
152+
<div><input type="submit" value="Go" /></div>
153+
<input type="hidden" name="check_keywords" value="yes" />
154+
<input type="hidden" name="area" value="default" />
155+
</form>
156+
</div>
157+
<script type="text/javascript">$('#searchbox').show(0);</script>
158+
</div>
159+
</div>
160+
<div class="clearer"></div>
161+
</div>
162+
<div class="footer">
163+
&copy;.
164+
165+
|
166+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.6</a>
167+
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
168+
169+
|
170+
<a href="_sources/pandas_setup.rst.txt"
171+
rel="nofollow">Page source</a>
172+
</div>
173+
174+
175+
176+
177+
</body>
178+
</html>

‎pandas/guide/search.html

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
1-
21
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
32
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
43

4+
55
<html xmlns="http://www.w3.org/1999/xhtml">
66
<head>
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8+
89
<title>Search &#8212; Python documentation</title>
10+
911
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
1012
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13+
1114
<script type="text/javascript">
1215
var DOCUMENTATION_OPTIONS = {
1316
URL_ROOT: './',
@@ -38,7 +41,7 @@
3841

3942

4043
</head>
41-
<body>
44+
<body role="document">
4245

4346

4447
<div class="document">
@@ -92,7 +95,7 @@ <h3>Related Topics</h3>
9295
&copy;.
9396

9497
|
95-
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
98+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.6</a>
9699
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
97100

98101
</div>

0 commit comments

Comments
 (0)