Skip to content

Tiny bit of grammar fixes and plenty of spacing fixes #258

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

Merged
merged 9 commits into from
Mar 23, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 6 additions & 2 deletions Readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,13 @@ Hitchhiker's Guide to Python

-----------

**Work in progress. If you'd like to help, please do. There's a lot of work to be done.**
**Work in progress. If you'd like to help, please do. There's a lot of work to
be done.**

This guide is currently under heavy development. This opinionated guide exists to provide both novice and expert Python developers a best-practice handbook to the installation, configuration, and usage of Python on a daily basis.
This guide is currently under heavy development. This opinionated guide
exists to provide both novice and expert Python developers a best-practice
handbook to the installation, configuration, and usage of Python on a daily
basis.


Topics include:
Expand Down
43 changes: 19 additions & 24 deletions docs/dev/env.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,21 +64,17 @@ to do that which also shows status and warning messages in the statusbar would b
Python-mode
^^^^^^^^^^^

Python-mode_ is complex solution in VIM for work with python code.
Python-mode_ is a complex solution in VIM for working with python code.
It has:

- Async python code checking (pylint, pyflakes, pep8, mccabe) in any combination;
- Code refactoring and autocompletion with Rope;
- Fastest python folding;
- Nice and powered python syntax;
- Virtual env support;
- Search by python documentation and run python code;
- More other things like auto pep8 error fixes;
- Very customizable and documented as well;
- Have all required libraries in self;

And more stuff.
- Async python code checking (pylint, pyflakes, pep8, mccabe) in any combination
- Code refactoring and autocompletion with Rope
- Fast python folding
- Virtualenv support
- Search by python documentation and run python code
- Auto pep8 error fixes

And more.

.. _indent: http://www.vim.org/scripts/script.php?script_id=974
.. _syntax: http://www.vim.org/scripts/script.php?script_id=790
Expand All @@ -101,8 +97,8 @@ already an Emacs user is `Python Programming in Emacs`_ at EmacsWiki.
1. Emacs itself comes with a python mode.
2. Python ships with an alternate version:
`python-mode.el <https://launchpad.net/python-mode>`_
3. Fabián Ezequiel Gallina's provides nice functionality and
behavior out of the box: `python.el <https://github.com/fgallina/python.el>`_
3. Fabián Ezequiel Gallina's `python.el <https://github.com/fgallina/python.el>`_
provides nice functionality and behavior out of the box

.. _Python Programming in Emacs: http://emacswiki.org/emacs/PythonProgrammingInEmacs

Expand Down Expand Up @@ -145,16 +141,15 @@ The most popular Eclipse plugin for Python development is Aptana's
Komodo IDE
----------
`Komodo IDE <http://www.activestate.com/komodo-ide>`_ is developed by
ActiveState and is a commercial IDE for Windows, Mac
and Linux.
ActiveState and is a commercial IDE for Windows, Mac and Linux.


Spyder
------

`Spyder <http://code.google.com/p/spyderlib/>`_ an IDE specifically geared
`Spyder <http://code.google.com/p/spyderlib/>`_ is an IDE specifically geared
toward working with scientific python libraries (namely `Scipy <http://www.scipy.org/>`_).
Includes integration with pyflakes_, `pylint <http://www.logilab.org/857>`_,
It includes integration with pyflakes_, `pylint <http://www.logilab.org/857>`_,
and `rope <http://rope.sourceforge.net/>`_.

Spyder is open-source (free), offers code completion, syntax highlighting,
Expand All @@ -164,15 +159,15 @@ class and function browser, and object inspection.
WingIDE
-------

`WingIDE <http://wingware.com/>`_ a python specific IDE. Runs for Linux,
`WingIDE <http://wingware.com/>`_ is a python specific IDE. It runs on Linux,
Windows, and Mac (as an X11 application, which frustrates some Mac users).


NINJA-IDE
---------

`NINJA-IDE <http://www.ninja-ide.org/>`_ (from the recursive acronym: "Ninja-IDE
Is Not Just Another IDE", is a cross-platform IDE, specially designed to build
Is Not Just Another IDE") is a cross-platform IDE, specially designed to build
Python applications, and runs on Linux/X11, Mac OS X and Windows desktop operating
systems. Installers for these platforms can be downloaded from the website.

Expand Down Expand Up @@ -211,7 +206,7 @@ library which you can use to install other packages. The name of the
virtual environment (in this case, it was ``venv``) can be anything;
omitting the name will place the files in the current directory instead.

In order the start using the virtual environment, run::
To start using the virtual environment, run::

$ source venv/bin/activate

Expand Down Expand Up @@ -288,12 +283,12 @@ IDLE

`IDLE <http://docs.python.org/library/idle.html>`_ is an integrated
development environment that is part of Python standard library. It is
completely written in Python and uses Tkinter GUI toolkit. Though IDLE
is not suited for full-blown development using Python , it is quite
completely written in Python and uses the Tkinter GUI toolkit. Though IDLE
is not suited for full-blown development using Python, it is quite
helpful to try out small Python snippets and experiment with different
features in Python.

It provides following features:
It provides the following features:

* Python Shell Window (interpreter)
* Multi window text editor that colorizes Python code
Expand Down
176 changes: 88 additions & 88 deletions docs/intro/duction.rst
Original file line number Diff line number Diff line change
@@ -1,88 +1,88 @@
Introduction
============
From the `official Python website <http://python.org/about/>`_:
Python is a general-purpose, high-level programming language similar
to Tcl, Perl, Ruby, Scheme, or Java. Some of its main key features
include:
* very clear, readable syntax
Python's philosophy focuses on readability, from code blocks
delineated with significant whitespace to intuitive keywords in
place of inscrutable punctuation
* extensive standard libraries and third party modules for virtually
any task
Python is sometimes described with the words "batteries included"
for its extensive
`standard library <http://docs.python.org/library/>`_, which can
includes modules for regular expressions, file IO, fraction handling,
object serialization, and much more.
Additionally, the
`Python Package Index <http://pypi.python.org/pypi/>`_ is available
for users to submit their packages for widespread use, similar to
Perl's `CPAN <http://www.cpan.org>`_. There is a thriving community
of very powerful Python frameworks and tools like
the `Django <http://www.djangoproject.com>`_ web framework and the
`NumPy <http://numpy.scipy.org>`_ set of math routines.
* integration with other systems
Python can integrate with `Java libraries <http://www.jython.org>`_,
enabling it to be used with the rich Java environment that corporate
programmers are used to. It can also be
`extended by C or C++ modules <http://docs.python.org/extending/>`_
when speed is of the essence.
* ubiquity on computers
Python is available on Windows, \*nix, and Mac. It runs wherever the
Java virtual machine runs, and the reference implementation CPython
can help bring Python to wherever there is a working C compiler.
* friendly community
Python has a vibrant and large :ref:`community <the-community>`
which maintains wikis, conferences, countless repositories,
mailing lists, IRC channels, and so much more. Heck, the Python
community is even helping to write this guide!
.. _about-ref:
About This Guide
----------------
Purpose
~~~~~~~
The Hitchhiker's Guide to Python exists to provide both novice and expert
Python developers a best-practice handbook to the installation, configuration,
and usage of Python on a daily basis.
By the Community
~~~~~~~~~~~~~~~~
This guide is architected and maintained by `Kenneth Reitz
<https://github.com/kennethreitz>`_ in an open fashion. This is a
community-driven effort that serves one purpose: to serve the community.
For the Community
~~~~~~~~~~~~~~~~~
All contributions to the Guide are welcome, from Pythonistas of all levels.
If you think there's a gap in what the Guide covers, fork the Guide on
GitHub and submit a pull request. Contributions are welcome from everyone,
whether they're an old hand or a first-time Pythonista, and the authors to
the Guide will gladly help if you have any questions about the
appropriateness, completeness, or accuracy of a contribution.
To get started working on The Hitchhiker's Guide, see
the: doc:`/notes/contribute` page.
Introduction
============

From the `official Python website <http://python.org/about/>`_:

Python is a general-purpose, high-level programming language similar
to Tcl, Perl, Ruby, Scheme, or Java. Some of its main key features
include:

* very clear, readable syntax

Python's philosophy focuses on readability, from code blocks
delineated with significant whitespace to intuitive keywords in
place of inscrutable punctuation

* extensive standard libraries and third party modules for virtually
any task

Python is sometimes described with the words "batteries included"
for its extensive
`standard library <http://docs.python.org/library/>`_, which includes
modules for regular expressions, file IO, fraction handling,
object serialization, and much more.

Additionally, the
`Python Package Index <http://pypi.python.org/pypi/>`_ is available
for users to submit their packages for widespread use, similar to
Perl's `CPAN <http://www.cpan.org>`_. There is a thriving community
of very powerful Python frameworks and tools like
the `Django <http://www.djangoproject.com>`_ web framework and the
`NumPy <http://numpy.scipy.org>`_ set of math routines.

* integration with other systems

Python can integrate with `Java libraries <http://www.jython.org>`_,
enabling it to be used with the rich Java environment that corporate
programmers are used to. It can also be
`extended by C or C++ modules <http://docs.python.org/extending/>`_
when speed is of the essence.

* ubiquity on computers

Python is available on Windows, \*nix, and Mac. It runs wherever the
Java virtual machine runs, and the reference implementation CPython
can help bring Python to wherever there is a working C compiler.

* friendly community

Python has a vibrant and large :ref:`community <the-community>`
which maintains wikis, conferences, countless repositories,
mailing lists, IRC channels, and so much more. Heck, the Python
community is even helping to write this guide!


.. _about-ref:

About This Guide
----------------

Purpose
~~~~~~~

The Hitchhiker's Guide to Python exists to provide both novice and expert
Python developers a best-practice handbook to the installation, configuration,
and usage of Python on a daily basis.


By the Community
~~~~~~~~~~~~~~~~

This guide is architected and maintained by `Kenneth Reitz
<https://github.com/kennethreitz>`_ in an open fashion. This is a
community-driven effort that serves one purpose: to serve the community.

For the Community
~~~~~~~~~~~~~~~~~

All contributions to the Guide are welcome, from Pythonistas of all levels.
If you think there's a gap in what the Guide covers, fork the Guide on
GitHub and submit a pull request. Contributions are welcome from everyone,
whether they're an old hand or a first-time Pythonista, and the authors to
the Guide will gladly help if you have any questions about the
appropriateness, completeness, or accuracy of a contribution.

To get started working on The Hitchhiker's Guide, see
the: doc:`/notes/contribute` page.


2 changes: 1 addition & 1 deletion docs/notes/styleguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
The Guide Style Guide
=====================

As with all documentation, having a consistent formating helps make the
As with all documentation, having a consistent format helps make the
document more understandable. In order to make The Guide easier to digest,
all contributions should fit within the rules of this style guide where
appropriate.
Expand Down
12 changes: 6 additions & 6 deletions docs/shipping/freezing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@ Comparison
Solutions and platforms/features supported:

=========== ======= ===== ==== ======== ======= ============= ============== ==== =====================
Solution Windows Linux OS X Python 3 Licence One-file mode Zipfile import Eggs pkg_resources support
Solution Windows Linux OS X Python 3 License One-file mode Zipfile import Eggs pkg_resources support
=========== ======= ===== ==== ======== ======= ============= ============== ==== =====================
bbFreeze yes yes yes no MIT no yes yes yes
py2exe yes no no no MIT yes yes no no
pyInstaller yes yes yes no GPL yes no yes no
cx_Freeze yes yes yes yes PSF no yes yes no
bbFreeze yes yes yes no MIT no yes yes yes
py2exe yes no no no MIT yes yes no no
pyInstaller yes yes yes no GPL yes no yes no
cx_Freeze yes yes yes yes PSF no yes yes no
=========== ======= ===== ==== ======== ======= ============= ============== ==== =====================

.. todo:: Add other solutions: py2app

.. note::
Freezing Python code on Linux into a Windows executable was only once
supported in PyInstaller, `but later dropped
supported in PyInstaller `and later dropped.
<http://stackoverflow.com/questions/2950971/cross-compiling-a-python-script-on-linux-into-a-windows-executable#comment11890276_2951046>`_.

.. note::
Expand Down
2 changes: 1 addition & 1 deletion docs/starting/install/win.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Installing Python on Windows
============================

First, download the `latest version <http://python.org/ftp/python/2.7.3/python-2.7.3.msi>`_
of Python 2 from the official Website. If you want to be sure you are installing a fully
of Python 2.7 from the official Website. If you want to be sure you are installing a fully
up-to-date version then use the "Windows Installer" link from the home page of the
`Python.org web site <http://python.org>`_ .

Expand Down
2 changes: 1 addition & 1 deletion docs/starting/which-python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Which Python to use?
Today
-----

If you're choosing a Python interpreter to use, I *highly* recommend you Use
If you're choosing a Python interpreter to use, I *highly* recommend you use
Python 2.7.x, unless you have a strong reason not to.


Expand Down
Loading