Commit db1a94f
Mary Brennan
File tree
- docs
- dev
- intro
- scenarios
- shipping
- starting/install
- writing
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -149,7 +149,7 @@ PyCharm / IntelliJ IDEA | |||
| 149 | 149 | known for IntelliJ IDEA. Both share the same code base and most of PyCharm's | |
| 150 | 150 | features can be brought to IntelliJ with the free `Python Plug-In <http://plugins.intellij.net/plugin/?id=631>`_. | |
| 151 | 151 | There are two versions of PyCharm: Professional Edition (Free 30-day trial) | |
| 152 | - and Community Edition(Apache 2.0 License) with less features. | ||
| 152 | + and Community Edition(Apache 2.0 License) with fewer features. | ||
| 153 | 153 | ||
| 154 | 154 | ||
| 155 | 155 | Eclipse | |
@@ -210,7 +210,7 @@ offering sourcecode autocompletion, syntax highlighting, support for version | |||
| 210 | 210 | control systems, python 3 support, integrated web browser, python shell, | |
| 211 | 211 | integrated debugger and a flexible plug-in system. Written in python, it is | |
| 212 | 212 | based on the Qt gui toolkit, integrating the Scintilla editor control. Eric | |
| 213 | - is an open-source software (GPLv3 licence) with more than ten years of active | ||
| 213 | + is an open-source software project (GPLv3 licence) with more than ten years of active | ||
| 214 | 214 | development. | |
| 215 | 215 | ||
| 216 | 216 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -148,8 +148,8 @@ general :pep:`8` best practices. | |||
| 148 | 148 | ||
| 149 | 149 | It has a detailed, multi-chapter case study on writing and releasing a package | |
| 150 | 150 | and eventually an application, including a chapter on using zc.buildout. Later | |
| 151 | - chapters detail best practices with writing documentation, test-driven | ||
| 152 | - development, version control, and optimization/profiling. | ||
| 151 | + chapters detail best practices such as writing documentation, test-driven | ||
| 152 | + development, version control, optimization and profiling. | ||
| 153 | 153 | ||
| 154 | 154 | `Expert Python Programming <http://www.packtpub.com/expert-python-programming/book>`_ | |
| 155 | 155 | ||
@@ -171,15 +171,15 @@ A Primer on Scientific Programming with Python | |||
| 171 | 171 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 172 | 172 | ||
| 173 | 173 | A Primer on Scientific Programming with Python, written by Hans Petter Langtangen, | |
| 174 | - mainly covers Python's usage in scientific field. In the book, examples are | ||
| 174 | + mainly covers Python's usage in the scientific field. In the book, examples are | ||
| 175 | 175 | chosen from mathematics and the natural sciences. | |
| 176 | 176 | ||
| 177 | 177 | `A Primer on Scientific Programming with Python <http://www.springer.com/mathematics/computational+science+%26+engineering/book/978-3-642-30292-3>`_ | |
| 178 | 178 | ||
| 179 | 179 | Numerical Methods in Engineering with Python | |
| 180 | 180 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 181 | 181 | ||
| 182 | - Numerical Methods in Engineering with Python, written by Jaan Kiusalaas, attempts to | ||
| 182 | + Numerical Methods in Engineering with Python, written by Jaan Kiusalaas, puts the | ||
| 183 | 183 | emphasis on numerical methods and how to implement them in Python. | |
| 184 | 184 | ||
| 185 | 185 | `Numerical Methods in Engineering with Python <http://www.cambridge.org/us/academic/subjects/engineering/engineering-mathematics-and-programming/numerical-methods-engineering-python-2nd-edition>`_ | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -35,7 +35,7 @@ new releases, jobs, etc. related to Python. | |||
| 35 | 35 | Python News | |
| 36 | 36 | ~~~~~~~~~~~~~ | |
| 37 | 37 | ||
| 38 | - News section in the official Python web site (www.python.org). It briefly | ||
| 39 | - highlights the news from Python community. | ||
| 38 | + Python News is the news section in the official Python web site (www.python.org). It briefly | ||
| 39 | + highlights the news from the Python community. | ||
| 40 | 40 | ||
| 41 | 41 | `Python News <http://www.python.org/news/>`_ | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -240,13 +240,13 @@ Chef | |||
| 240 | 240 | Puppet | |
| 241 | 241 | ------ | |
| 242 | 242 | ||
| 243 | - `Puppet <http://puppetlabs.com>`_ is an IT Automation and configuration management | ||
| 243 | + `Puppet <http://puppetlabs.com>`_ is IT Automation and configuration management | ||
| 244 | 244 | software from Puppet Labs that allows System Administrators to define the state of | |
| 245 | 245 | their IT Infrastructure, thereby providing an elegant way to manage their fleet of | |
| 246 | 246 | physical and virtual machines. | |
| 247 | 247 | ||
| 248 | 248 | Puppet is available both as an Open Source and an Enterprise variant. Modules are | |
| 249 | - small,shareable units of code written to automate or define the state of a system. | ||
| 249 | + small, shareable units of code written to automate or define the state of a system. | ||
| 250 | 250 | `Puppet Forge <https://forge.puppetlabs.com/>`_ is a repository for modules written | |
| 251 | 251 | by the community for Open Source and Enterprise Puppet. | |
| 252 | 252 | ||
@@ -261,7 +261,7 @@ how each node should be configured and sends it to the agent. The agent enforces | |||
| 261 | 261 | change as prescribed in the catalog and sends a report back to the Puppet Master. | |
| 262 | 262 | ||
| 263 | 263 | Facter is an interesting tool that ships with Puppet that pulls basic facts about | |
| 264 | - the System. These facts can be referenced as a variable while writing your | ||
| 264 | + the system. These facts can be referenced as a variable while writing your | ||
| 265 | 265 | Puppet modules. | |
| 266 | 266 | ||
| 267 | 267 | .. code-block:: console | |
@@ -328,7 +328,7 @@ everytime the sshd configuration file is changed. | |||
| 328 | 328 | hasrestart=> true, | |
| 329 | 329 | } | |
| 330 | 330 | ||
| 331 | - For more information checkout `Puppet Labs Documentation <http://docs.puppetlabs.com>`_ | ||
| 331 | + For more information, refer to the `Puppet Labs Documentation <http://docs.puppetlabs.com>`_ | ||
| 332 | 332 | ||
| 333 | 333 | Blueprint | |
| 334 | 334 | --------- | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -35,7 +35,7 @@ and deployable. | |||
| 35 | 35 | Kivy is written in Python, based on OpenGL and supports different input devices | |
| 36 | 36 | such as: Mouse, Dual Mouse, TUIO, WiiMote, WM_TOUCH, HIDtouch, Apple's products and so on. | |
| 37 | 37 | ||
| 38 | - Kivy is actively being developed by a community and free to use. It operates | ||
| 38 | + Kivy is actively being developed by a community and is free to use. It operates | ||
| 39 | 39 | on all major platforms (Linux, OSX, Windows, Android). | |
| 40 | 40 | ||
| 41 | 41 | The main resource for information is the website: http://kivy.org | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -26,7 +26,7 @@ IPython | |||
| 26 | 26 | ||
| 27 | 27 | `IPython <http://ipython.org/>`_ is an enhanced version of Python interpreter, | |
| 28 | 28 | which provides features of great interest to scientists. The `inline mode` | |
| 29 | - allow graphics and plots to be displayed in the terminal (Qt based version). | ||
| 29 | + allows graphics and plots to be displayed in the terminal (Qt based version). | ||
| 30 | 30 | Moreover, the `notebook` mode supports literate programming and reproducible | |
| 31 | 31 | science generating a web-based Python notebook. This notebook allows you to | |
| 32 | 32 | store chunks of Python code along side the results and additional comments | |
@@ -55,9 +55,9 @@ NumPy is compatible with Python versions 2.4 through to 2.7.2 and 3.1+. | |||
| 55 | 55 | Numba | |
| 56 | 56 | ----- | |
| 57 | 57 | ||
| 58 | - `Numba <http://numba.pydata.org>`_ is an Numpy aware Python compiler | ||
| 58 | + `Numba <http://numba.pydata.org>`_ is a NumPy aware Python compiler | ||
| 59 | 59 | (just-in-time (JIT) specializing compiler) which compiles annotated Python (and | |
| 60 | - Numpy) code to LLVM (Low Level Virtual Machine) through special decorators. | ||
| 60 | + NumPy) code to LLVM (Low Level Virtual Machine) through special decorators. | ||
| 61 | 61 | Briefly, Numba uses a system that compiles Python code with LLVM to code which | |
| 62 | 62 | can be natively executed at runtime. | |
| 63 | 63 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3,7 +3,7 @@ Web Applications | |||
| 3 | 3 | ================ | |
| 4 | 4 | ||
| 5 | 5 | As a powerful scripting language adapted to both fast prototyping | |
| 6 | - and bigger projects, Python is widely used in Web applications | ||
| 6 | + and bigger projects, Python is widely used in web application | ||
| 7 | 7 | development. | |
| 8 | 8 | ||
| 9 | 9 | Context | |
@@ -84,8 +84,8 @@ Werkzeug | |||
| 84 | 84 | `Werkzeug <http://werkzeug.pocoo.org/>`_ is not actually a real framework, but | |
| 85 | 85 | rather a very powerful set of tools for building web applications. It provides | |
| 86 | 86 | URL routing utilities, request and response objects and a basic development | |
| 87 | - server. It is mostly used where users need bigger flexibility for their | ||
| 88 | - application that is not commonly found in other web frameworks. | ||
| 87 | + server. It is mostly used where users need more flexibility for their | ||
| 88 | + application than is commonly found in other web frameworks. | ||
| 89 | 89 | ||
| 90 | 90 | Support can be found on its `mailing list <http://werkzeug.pocoo.org/community/#mailinglist>`_. | |
| 91 | 91 | ||
@@ -179,7 +179,7 @@ variables <https://uwsgi-docs.readthedocs.org/en/latest/Vars.html>`_. | |||
| 179 | 179 | Server Best Practices | |
| 180 | 180 | ::::::::::::::::::::: | |
| 181 | 181 | ||
| 182 | - The majority of self hosted Python applications today are hosted with a WSGI | ||
| 182 | + The majority of self-hosted Python applications today are hosted with a WSGI | ||
| 183 | 183 | server such as :ref:`Gunicorn <gunicorn-ref>`, either directly or behind a | |
| 184 | 184 | lightweight web server such as :ref:`nginx <nginx-ref>`. | |
| 185 | 185 | ||
@@ -195,7 +195,7 @@ Platform-as-a-Service | |||
| 195 | 195 | ||
| 196 | 196 | Platform-as-a-Service (PaaS) is a type of cloud computing infrastructure | |
| 197 | 197 | which abstracts and manages infrastructure, routing, and scaling of web | |
| 198 | - applications. When using PaaS, application developers can focus on writing | ||
| 198 | + applications. When using a PaaS, application developers can focus on writing | ||
| 199 | 199 | application code rather than needing to be concerned with deployment | |
| 200 | 200 | details. | |
| 201 | 201 | ||
@@ -327,8 +327,8 @@ Here some important html tags in Jinja2: | |||
| 327 | 327 | ||
| 328 | 328 | ||
| 329 | 329 | ||
| 330 | - The next listings is an example of a web site in combination with the tornado | ||
| 331 | - web server. Tornado is not very complicate to use. | ||
| 330 | + The next listings is an example of a web site in combination with the Tornado | ||
| 331 | + web server. Tornado is not very complicated to use. | ||
| 332 | 332 | ||
| 333 | 333 | .. code-block:: python | |
| 334 | 334 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -24,13 +24,13 @@ Use `pip <http://pypi.python.org/pypi/pip>`_. More details `here <http://stacko | |||
| 24 | 24 | Personal PyPI | |
| 25 | 25 | ------------- | |
| 26 | 26 | ||
| 27 | - If you want to install packages from a source different from PyPI, (say, if | ||
| 27 | + If you want to install packages from a source other than PyPI, (say, if | ||
| 28 | 28 | your packages are *proprietary*), you can do it by hosting a simple http server, | |
| 29 | 29 | running from the directory which holds those packages which need to be installed. | |
| 30 | 30 | ||
| 31 | 31 | **Showing an example is always beneficial** | |
| 32 | 32 | ||
| 33 | - Say if you are after installing a package called :file:`MyPackage.tar.gz`, and | ||
| 33 | + For example, if you want to install a package called :file:`MyPackage.tar.gz`, and | ||
| 34 | 34 | assuming this is your directory structure: | |
| 35 | 35 | ||
| 36 | 36 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -11,7 +11,7 @@ described in the next section before you start building Python applications | |||
| 11 | 11 | for real-world use. In particular, you should always install Setuptools, as it | |
| 12 | 12 | makes it much easier for you to use other third-party Python libraries. | |
| 13 | 13 | ||
| 14 | - The version of Python that ships with OS X is great for learning. Yet, it's not | ||
| 14 | + The version of Python that ships with OS X is great for learning but it's not | ||
| 15 | 15 | good for development. The version shipped with OS X may be out of date from the | |
| 16 | 16 | `official current Python release <https://www.python.org/downloads/mac-osx/>`_, | |
| 17 | 17 | which is considered the stable production version. | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -266,10 +266,10 @@ logic (called pure functions) allow the following benefits: | |||
| 266 | 266 | - Pure functions are easier to test with unit-tests: There is less | |
| 267 | 267 | need for complex context setup and data cleaning afterwards. | |
| 268 | 268 | ||
| 269 | - - Pure functions are easier to manipulate, decorate, and pass-around. | ||
| 269 | + - Pure functions are easier to manipulate, decorate, and pass around. | ||
| 270 | 270 | ||
| 271 | - In summary, pure functions, without any context or side-effects, are more | ||
| 272 | - efficient building blocks than classes and objects for some architectures. | ||
| 271 | + In summary, pure functions are more efficient building blocks than classes | ||
| 272 | + and objects for some architectures because they have no context or side-effects. | ||
| 273 | 273 | ||
| 274 | 274 | Obviously, object-orientation is useful and even necessary in many cases, for | |
| 275 | 275 | example when developing graphical desktop applications or games, where the | |
@@ -314,7 +314,7 @@ of the function logic. | |||
| 314 | 314 | Dynamic typing | |
| 315 | 315 | -------------- | |
| 316 | 316 | ||
| 317 | - Python is said to be dynamically typed, which means that variables | ||
| 317 | + Python is dynamically typed, which means that variables | ||
| 318 | 318 | do not have a fixed type. In fact, in Python, variables are very | |
| 319 | 319 | different from what they are in many other languages, specifically | |
| 320 | 320 | statically-typed languages. Variables are not a segment of the computer's | |
0 commit comments