Skip to content

Documentation for Window users [#40] #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 6, 2018
Merged

Documentation for Window users [#40] #47

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
196113c
Clone form github
Cheukting Feb 8, 2018
9ce47a3
Cloned from Github
Cheukting Feb 8, 2018
f343f42
Merge remote-tracking branch 'upstreem/master'
Mar 3, 2018
298c943
Added comments for Window users
Cheukting Mar 4, 2018
74b0cb0
change instruction for Window users
Mar 5, 2018
3be58c2
Fixed typo
Mar 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions pandas/guide/source/pandas_setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ repository:

| ``git remote add upstream https://github.com/pandas-dev/pandas``

(For Window Users: download git for Windows <https://gitforwindows.org/> and run Git Bash in the directory where you want the copy of pandas source code with the same commends as above.)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it'll be easier for user to find it (or to skip it) if instead of the comment in brackets we use in all the comments for Windows the sphinx .. note:: directive. This will create a (yellow I think) box. If at the beginning of it we have "Windows users" in bold, Linux and Mac users will skip it easily.

Then, I think in Sphins links usually are between back quotes ended with an underscore. Ignore this comment if it renders the way you want.


3. Set up a Python environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -68,6 +70,8 @@ repository:
* Install pandas development dependencies:
``conda install -c defaults -c conda-forge --file=<pandas-dir>/ci/requirements-optional-conda.txt``

(For Window users: run the above commends in Anaconda Prompt)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally I prefer to be more specific and not assume much prior knowledge from users, and I'd let them know where to find the Anaconda Prompt.

Also, if you find an easy way to rewrite this paragraph so this doesn't come at the end, that would be great. To avoid users following the above instructions in Windows, to realize when they reach this point that they were doing it the "wrong" way.


3.b Python environment with virtualenv and pip
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand All @@ -79,12 +83,31 @@ TODO
Besides the Python `.py` files, pandas source code includes C/Cython files
which need to be compiled in order to run the development version of pandas.

For Window Users: you'll need to install the compiler toolset. Depending on which version of Python you care about, you will need to choose a different download.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As users are using Anaconda, I think we can assume they'll be using the latest version of Python, and simplify this. If you want, with a note at the end with the link to Python 2.7.


+----------------+------------------------------------------------------------+
| Python | You will need |
| Version | |
+================+============================================================+
| 3.5 and later | Install Visual Studio 2017, select the Python development |
| | workload and the Native development tools option |
| | <https://www.visualstudio.com/> |
+----------------+------------------------------------------------------------+
| 3.3 and 3.4 | Windows SDK for Windows 7 and .NET 4.0 |
| | <https://www.microsoft.com/download/details.aspx?id=8279> |
+----------------+------------------------------------------------------------+
| 2.6 to 3.2 | Microsoft Visual C++ Compiler for Python 2.7 |
| | <https://www.microsoft.com/download/details.aspx?id=44266> |
+----------------+------------------------------------------------------------+

To compile these files simply run:
| ``cd <pandas-dir>``
| ``python setup.py build_ext --inplace``

The process will take several minutes.

(For Window users: run the above commends in Anaconda Prompt)
Copy link
Member

@datapythonista datapythonista Mar 4, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as before, I'd try to tell them users to use Anaconda Prompt before the commands, not after.

Typo in commands

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you forgot this one for converting to a note?


5. Create a branch and start coding
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -108,3 +131,5 @@ To check in which branch are you:

To change to another branch:
| ``git checkout <branch_name>``
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same, and if we say this here, we should probably say it at the beginning, when cloning...


(for Window users run above comments with Git Bash)