-
Notifications
You must be signed in to change notification settings - Fork 55
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.
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
Changes from 5 commits
196113c
9ce47a3
f343f42
298c943
74b0cb0
3be58c2
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -38,6 +38,12 @@ via pip, conda or a zip. | |
|
||
To get the latest development version: | ||
* Fork the `pandas repository <https://github.com/pandas-dev/pandas>`_ on GitHub by click on the top-right `Fork` button | ||
|
||
.. note:: | ||
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 following commends. | ||
|
||
* In the terminal of your computer, in the directory where you want the copy of pandas source code, run: | ||
|
||
| ``git clone https://github.com/<your-github-username>/pandas`` | ||
|
@@ -57,7 +63,12 @@ repository: | |
3.a Python environment with Anaconda | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
* Download and install `Anaconda <https://www.anaconda.com/download/>`_ | ||
* Download and install `Anaconda <https://www.anaconda.com/download/>` | ||
|
||
.. note:: | ||
For Window users, go to the start menu, find Anaconda Prompt inside the Anaconda floder | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. typo in folder |
||
and run the above commends in Anaconda Prompt | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. typo in commands |
||
|
||
* Activate conda by one of the next (or equivalent, if you know what you're doing): | ||
* If you chose to prepend Anaconda to your PATH during install adding it to your ``~/.bashrc``, just restart your terminal. | ||
* Otherwise, run ``export PATH="<path-to-anaconda>/bin:$PATH"`` in your terminal. Keep in mind that it will be active exclusively in the terminal you run this command. | ||
|
@@ -68,6 +79,7 @@ repository: | |
* Install pandas development dependencies: | ||
``conda install -c defaults -c conda-forge --file=<pandas-dir>/ci/requirements-optional-conda.txt`` | ||
|
||
|
||
3.b Python environment with virtualenv and pip | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
|
@@ -79,12 +91,23 @@ 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. | ||
|
||
.. note:: | ||
For Window Users, you'll need to install the compiler toolset: | ||
|
||
for Python 3.6 - Install Visual Studio 2017, select the Python development workload | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Capital "F" |
||
and the Native development tools option <https://www.visualstudio.com/> | ||
|
||
for Python 2.7 - Microsoft Visual C++ Compiler for Python 2.7 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Capital "F" |
||
<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) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
|
@@ -93,6 +116,9 @@ to work on. Once you know which, you need to create a git branch for your | |
changes. This will be useful when you have finished your changes, and you want | ||
to submit a pull request, so they are included in pandas. | ||
|
||
.. note:: | ||
for Window users run above comments with Git Bash at the colned pandas floder | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Capital "F" comments instead of commands typo in cloned |
||
|
||
You can create a git branch running: | ||
| ``git checkout -b <new_branch_name>`` | ||
|
||
|
@@ -107,4 +133,4 @@ To check in which branch are you: | |
| ``git branch`` | ||
|
||
To change to another branch: | ||
| ``git checkout <branch_name>`` | ||
| ``git checkout <branch_name>`` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it'd be clearer for users to have **Windows users:** in bold at the beginning of each note block. Being in bold and always in the same way, users will clearly perceive this is for windows users only.