Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
4fb3bf7
Wrote a bit about docstrings
Michael-F-Bryan Jun 12, 2016
fb388b8
changed the pep 257 line from a see also to a normal line
Michael-F-Bryan Jun 12, 2016
3c0b027
Removed the rst/sphinx-style docstring example
Michael-F-Bryan Jun 13, 2016
10defd7
Added a bit so the transition from short to long docstrings flows better
Michael-F-Bryan Jun 13, 2016
081c475
Update cli.rst
nhumrich Jun 21, 2016
1bcc6d5
Cleaning up *.py[co] and __pycache__ tip
robsonpeixoto Aug 1, 2016
71257be
fixing markup on memoization link hint
Aug 30, 2016
f0867fe
include instructions to preview changes in CONTRIB
Aug 31, 2016
15396a5
Update which-python.rst
Sep 1, 2016
cfb46b5
Update contents.rst.inc
rubenroy Sep 13, 2016
1caa6c7
CLT are not needed if full Xcode is installed
tdsmith Sep 22, 2016
359e4b9
Don't specifically need gcc
tdsmith Sep 22, 2016
1d51689
Update guidance on C toolchains
tdsmith Sep 22, 2016
2423a9d
Offer guidance on Python 3
tdsmith Sep 22, 2016
5ad4319
Fixed example docstring
sidneypham Oct 7, 2016
25dc76e
Remove numba todo; already taken care of under scenarios/scientific.rst
kishorbhat Oct 7, 2016
473f4c7
Remove Ubuntu specification
asmacdo Oct 16, 2016
111c5d6
available now!
kennethreitz Oct 20, 2016
d67923c
Update the link for latest available Python 2.7 release for Windows
codeaditya Oct 26, 2016
4a17288
Merge pull request #756 from codeaditya/codeaditya-patch-1
kennethreitz Oct 26, 2016
be8ce27
Update to recent versions of Django for virtualenv example
codeaditya Oct 26, 2016
3dd2748
Merge pull request #757 from codeaditya/version-info
kennethreitz Oct 26, 2016
fe7467b
Update link to Mercurial site
adamzap Oct 29, 2016
b4d1349
Merge pull request #758 from adamzap/update-mercurial-link
kennethreitz Oct 30, 2016
27c1567
added machine learning docs
shivenmian Oct 31, 2016
5636b56
Merge pull request #760 from shivenmian/scikit
kennethreitz Oct 31, 2016
b98cd36
Merge pull request #754 from asmacdo/general-linux-doc
kennethreitz Oct 31, 2016
07bb0d9
Merge pull request #753 from therealkbhat/cleanup
kennethreitz Oct 31, 2016
ef26c66
Merge pull request #752 from sidney-pham/master
kennethreitz Oct 31, 2016
eb16b73
Merge pull request #749 from tdsmith/osx-install
kennethreitz Oct 31, 2016
a52a758
Merge pull request #747 from rubenroy/patch-1
kennethreitz Oct 31, 2016
767f448
Merge pull request #746 from denfromufa/patch-1
kennethreitz Oct 31, 2016
14ad6c7
Merge pull request #744 from alphor/add-preview-instructions
kennethreitz Oct 31, 2016
bea106a
Merge pull request #743 from alphor/fix-alphor-typo
kennethreitz Oct 31, 2016
e8c377a
Merge pull request #717 from nhumrich/patch-1
kennethreitz Oct 31, 2016
b81aa84
Merge pull request #712 from Michael-F-Bryan/docstrings
kennethreitz Oct 31, 2016
96fda54
Merge pull request #735 from robsonpeixoto/patch-1
kennethreitz Oct 31, 2016
3a353c6
ml
kennethreitz Nov 2, 2016
4a7336f
Revert "Update contents.rst.inc"
kennethreitz Nov 2, 2016
58c362b
Merge pull request #763 from kennethreitz/revert-747-patch-1
kennethreitz Nov 2, 2016
7c8dfd0
Correct name for the game "Civilization IV"
Chocobo1 Nov 6, 2016
7784bff
Merge pull request #764 from Chocobo1/typo
kennethreitz Nov 6, 2016
ddf333b
update to lastest version (Merge branch 'master' into korean)
LoveMeWithoutAll Nov 17, 2016
5e8fb0f
update to latest version
LoveMeWithoutAll Nov 17, 2016
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
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,28 @@ see:

http://docs.python-guide.org/en/latest/notes/contribute/

How to test your changes
------------------------

The html version of this guide is built with [sphinx](http://www.sphinx-doc.org/en/stable/). You may test your revisions locally by having sphinx installed. You can do this easily with pip (as described in the link).

``` bash
pip install --user sphinx
```

Then navigate to the directory of the makefile and ```make build``` or ```make html```. Sphinx will then generate the html in a folder called _build/html

After navigating to this folder, you can then use python's built in webserver to view your changes locally:

``` bash
python3 -m http.server
```

By default, http.server listens on every ip address bound on your host on port 8000. To bind to a specific one, say, localhost on port 8005:

``` bash
python3 -m http.server 8005 --bind 127.0.0.1
```

Style Guide
-----------
Expand Down
2 changes: 1 addition & 1 deletion docs/_templates/sidebarintro.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ <h3>Stay Informed</h3>

<h3>O'Reilly Book</h3>

<p>This guide is now available for pre-order in tangible book form!</p>
<p>This guide is now available in tangible book form!</p>

<a href="https://www.amazon.com/Hitchhikers-Guide-Python-Practices-Development/dp/1491933178/ref=as_li_ss_il?ie=UTF8&linkCode=li2&tag=bookforkind-20&linkId=804806ebdacaf3b56567347f3afbdbca" target="_blank"><img border="0" src="https://ws-na.amazon-adsystem.com/widgets/q?_encoding=UTF8&ASIN=1491933178&Format=_SL160_&ID=AsinImage&MarketPlace=US&ServiceVersion=20070822&WS=1&tag=bookforkind-20" ></a><img src="//ir-na.amazon-adsystem.com/e/ir?t=bookforkind-20&l=li2&o=1&a=1491933178" width="1" height="1" border="0" alt="" style="border:none !important; margin:0px !important;" />

Expand Down
2 changes: 1 addition & 1 deletion docs/_templates/sidebarlogo.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ <h3>Get Updates</h3>

<h3>O'Reilly Book</h3>

<p>This guide is now available for pre-order in tangible book form!</p>
<p>This guide is now available in tangible book form!</p>

<a href="https://www.amazon.com/Hitchhikers-Guide-Python-Practices-Development/dp/1491933178/ref=as_li_ss_il?ie=UTF8&linkCode=li2&tag=bookforkind-20&linkId=804806ebdacaf3b56567347f3afbdbca" target="_blank"><img border="0" src="https://ws-na.amazon-adsystem.com/widgets/q?_encoding=UTF8&ASIN=1491933178&Format=_SL160_&ID=AsinImage&MarketPlace=US&ServiceVersion=20070822&WS=1&tag=bookforkind-20" ></a><img src="//ir-na.amazon-adsystem.com/e/ir?t=bookforkind-20&l=li2&o=1&a=1491933178" width="1" height="1" border="0" alt="" style="border:none !important; margin:0px !important;" />

Expand Down
1 change: 1 addition & 0 deletions docs/contents.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ different scenarios.
scenarios/xml
scenarios/json
scenarios/crypto
scenarios/ml
scenarios/clibs


Expand Down
4 changes: 2 additions & 2 deletions docs/dev/virtualenvs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ projects in separate places, by creating virtual Python environments for them.
It solves the "Project X depends on version 1.x but, Project Y needs 4.x"
dilemma, and keeps your global site-packages directory clean and manageable.

For example, you can work on a project which requires Django 1.3 while also
maintaining a project which requires Django 1.0.
For example, you can work on a project which requires Django 1.10 while also
maintaining a project which requires Django 1.8.

virtualenv
----------
Expand Down
Binary file modified docs/locale/ko/LC_MESSAGES/dev/virtualenvs.mo
Binary file not shown.
43 changes: 7 additions & 36 deletions docs/locale/ko/LC_MESSAGES/dev/virtualenvs.po
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ msgid ""
msgstr ""
"Project-Id-Version: pythonguide 0.0.1\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-10-11 08:03+0000\n"
"POT-Creation-Date: 2016-11-17 01:45+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
Expand All @@ -27,8 +27,8 @@ msgstr ""

#: ../../dev/virtualenvs.rst:11
msgid ""
"For example, you can work on a project which requires Django 1.3 while "
"also maintaining a project which requires Django 1.0."
"For example, you can work on a project which requires Django 1.10 while "
"also maintaining a project which requires Django 1.8."
msgstr ""

#: ../../dev/virtualenvs.rst:15
Expand Down Expand Up @@ -308,41 +308,12 @@ msgid "And on Linux:"
msgstr ""

#~ msgid ""
#~ "This will create a :file:`requirements.txt`"
#~ " file, which contains a simple list"
#~ " of all the packages in the "
#~ "current environment, and their respective "
#~ "versions. Later it will be easier "
#~ "for a different developer (or you, "
#~ "if you need to re-create the "
#~ "environment) to install the same "
#~ "packages using the same versions:"
#~ msgstr ""

#~ msgid ""
#~ "`virtualenvwrapper "
#~ "<http://virtualenvwrapper.readthedocs.org/en/latest/index.html>`_ "
#~ "provides a set of commands which "
#~ "makes working with virtual environments "
#~ "much more pleasant. It also places "
#~ "all your virtual environments in one "
#~ "place."
#~ msgstr ""

#~ msgid ""
#~ "(`Full virtualenvwrapper install instructions "
#~ "<http://virtualenvwrapper.readthedocs.org/en/latest/install.html>`_.)"
#~ msgstr ""

#~ msgid ""
#~ "For Windows, you can use the "
#~ "`virtualenvwrapper-powershell "
#~ "<https://bitbucket.org/guillermooo/virtualenvwrapper-"
#~ "powershell>`_ clone."
#~ msgstr ""

#~ msgid ""
#~ "`Full list of virtualenvwrapper commands "
#~ "<http://virtualenvwrapper.readthedocs.org/en/latest/command_ref.html>`_."
#~ "For example, you can work on a "
#~ "project which requires Django 1.3 while"
#~ " also maintaining a project which "
#~ "requires Django 1.0."
#~ msgstr ""

Binary file modified docs/locale/ko/LC_MESSAGES/scenarios/cli.mo
Binary file not shown.
35 changes: 22 additions & 13 deletions docs/locale/ko/LC_MESSAGES/scenarios/cli.po
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ msgid ""
msgstr ""
"Project-Id-Version: pythonguide 0.0.1\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-10-11 08:03+0000\n"
"POT-Creation-Date: 2016-11-17 01:45+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
Expand Down Expand Up @@ -53,7 +53,7 @@ msgstr ""

#: ../../scenarios/cli.rst:19
msgid ""
"`mercurial <http://mercurial.selenic.com/>`_ - A distributed version "
"`mercurial <https://www.mercurial-scm.org/>`_ - A distributed version "
"control system primarily written in Python"
msgstr ""

Expand Down Expand Up @@ -123,17 +123,26 @@ msgid ""
"parsing and then invokes a sub-command to do the work."
msgstr ""

#: ../../scenarios/cli.rst:67
msgid "Cement"
msgstr ""

#: ../../scenarios/cli.rst:69
msgid ""
"`Cement <http://builtoncement.com/>`_ is an advanced CLI Application "
"Framework. Its goal is to introduce a standard, and feature-full platform"
" for both simple and complex command line applications as well as support"
" rapid development needs without sacrificing quality. Cement is flexible,"
" and it's use cases span from the simplicity of a micro-framework to the "
"complexity of a meg-framework."
msgstr ""

#~ msgid ""
#~ msgstr ""

#~ msgid ""
#~ "`Cliff <https://cliff.readthedocs.org/en/latest>`_ is "
#~ "a framework for building command-line"
#~ " programs. It uses setuptools entry "
#~ "points to provide subcommands, output "
#~ "formatters, and other extensions. The "
#~ "framework is meant to be used to"
#~ " create multi-level commands such as"
#~ " subversion and git, where the main"
#~ " program handles some basic argument "
#~ "parsing and then invokes a sub-"
#~ "command to do the work."
#~ "`mercurial <http://mercurial.selenic.com/>`_ - A "
#~ "distributed version control system primarily"
#~ " written in Python"
#~ msgstr ""

Binary file added docs/locale/ko/LC_MESSAGES/scenarios/ml.mo
Binary file not shown.
191 changes: 191 additions & 0 deletions docs/locale/ko/LC_MESSAGES/scenarios/ml.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2016. A <a
# href="http://kennethreitz.com/pages/open-projects.html">Kenneth Reitz</a>
# Project. <a href="http://creativecommons.org/licenses/by-nc-sa/3.0/">CC
# BY-NC-SA 3.0</a>
# This file is distributed under the same license as the pythonguide
# package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2016.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: pythonguide 0.0.1\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-11-17 01:45+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.3.4\n"

#: ../../scenarios/ml.rst:3
msgid "Machine Learning"
msgstr ""

#: ../../scenarios/ml.rst:5
msgid ""
"Python has a vast number of libraries for data analysis, statistics and "
"Machine Learning itself, making it a language of choice for many data "
"scientists."
msgstr ""

#: ../../scenarios/ml.rst:7
msgid ""
"Some widely used packages for Machine Learning and other Data Science "
"applications are enlisted below."
msgstr ""

#: ../../scenarios/ml.rst:10
msgid "Scipy Stack"
msgstr ""

#: ../../scenarios/ml.rst:12
msgid ""
"The Scipy stack consists of a bunch of core helper packages used in data "
"science, for statistical analysis and visualising data. Because of its "
"huge number of functionalities and ease of use, the Stack is considered a"
" must-have for most data science applications."
msgstr ""

#: ../../scenarios/ml.rst:14
msgid ""
"The Stack consists of the following packages (link to documentation "
"given):"
msgstr ""

#: ../../scenarios/ml.rst:16
msgid "`NumPy <http://www.numpy.org/>`_"
msgstr ""

#: ../../scenarios/ml.rst:17
msgid "`SciPy library <https://www.scipy.org/>`_"
msgstr ""

#: ../../scenarios/ml.rst:18
msgid "`Matplotlib <http://matplotlib.org/>`_"
msgstr ""

#: ../../scenarios/ml.rst:19
msgid "`IPython <https://ipython.org/>`_"
msgstr ""

#: ../../scenarios/ml.rst:20
msgid "`pandas <http://pandas.pydata.org/>`_"
msgstr ""

#: ../../scenarios/ml.rst:21
msgid "`Sympy <http://www.sympy.org/en/index.html>`_"
msgstr ""

#: ../../scenarios/ml.rst:22
msgid "`nose <http://nose.readthedocs.io/en/latest/>`_"
msgstr ""

#: ../../scenarios/ml.rst:24
msgid ""
"The stack also comes with Python bundled in, but has been excluded from "
"the above list."
msgstr ""

#: ../../scenarios/ml.rst:27 ../../scenarios/ml.rst:41
msgid "Installation"
msgstr ""

#: ../../scenarios/ml.rst:29
msgid ""
"For installing the full stack, or individual packages, you can refer to "
"the instructions given `here <https://www.scipy.org/install.html>`_."
msgstr ""

#: ../../scenarios/ml.rst:31
msgid ""
"**NB:** `Anaconda <https://www.continuum.io/anaconda-overview>`_ is "
"highly preferred and recommended for installing and maintaining data "
"science packages seamlessly."
msgstr ""

#: ../../scenarios/ml.rst:34
msgid "scikit-learn"
msgstr ""

#: ../../scenarios/ml.rst:36
msgid ""
"Scikit is a free and open-source machine learning library for Python. It "
"offers off-the-shelf functions to implement many algorithms like linear "
"regression, classifiers, SVMs, k-means, Neural Networks etc. It also has "
"a few sample datasets which can be directly used for training and "
"testing."
msgstr ""

#: ../../scenarios/ml.rst:38
msgid ""
"Because of its speed, robustness and easiness to use, it's one of the "
"most widely-used libraries for many Machine Learning applications."
msgstr ""

#: ../../scenarios/ml.rst:43
msgid "Through PyPI:"
msgstr ""

#: ../../scenarios/ml.rst:49
msgid "Through conda:"
msgstr ""

#: ../../scenarios/ml.rst:55
msgid ""
"scikit-learn also comes in shipped with Anaconda (mentioned above). For "
"more installation instructions, refer to `this link <http://scikit-"
"learn.org/stable/install.html>`_."
msgstr ""

#: ../../scenarios/ml.rst:58
msgid "Example"
msgstr ""

#: ../../scenarios/ml.rst:60
msgid ""
"For this example, we train a simple classifier on the `Iris dataset "
"<http://en.wikipedia.org/wiki/Iris_flower_data_set>`_, which comes "
"bundled in with scikit-learn."
msgstr ""

#: ../../scenarios/ml.rst:62
msgid ""
"The dataset takes four features of flowers: sepal length, sepal width, "
"petal length and petal width, and classifies them into three flower "
"species (labels): setosa, versicolor or virginica. The labels have been "
"represented as numbers in the dataset: 0 (setosa), 1 (versicolor) and 2 "
"(virginica)."
msgstr ""

#: ../../scenarios/ml.rst:64
msgid ""
"We shuffle the Iris dataset, and divide it into separate training and "
"testing sets: keeping the last 10 data points for testing and rest for "
"training. We then train the classifier on the training set, and predict "
"on the testing set."
msgstr ""

#: ../../scenarios/ml.rst:107
msgid ""
"Since we're splitting randomly and the classifier trains on every "
"iteration, the accuracy may vary. Running the above code gives:"
msgstr ""

#: ../../scenarios/ml.rst:115
msgid ""
"The first line contains the labels (i.e flower species) of the testing "
"data as predicted by our classifier, and the second line contains the "
"actual flower species as given in the dataset. We thus get an accuracy of"
" 100% this time."
msgstr ""

#: ../../scenarios/ml.rst:117
msgid ""
"More on scikit-learn can be read in the `documentation <http://scikit-"
"learn.org/stable/user_guide.html>`_."
msgstr ""

Binary file modified docs/locale/ko/LC_MESSAGES/scenarios/speed.mo
Binary file not shown.
Loading