|
1 | | -Reading Great Code |
2 | | -================== |
3 | | - |
4 | | -One of the core tenants behind the design of Python is creating |
5 | | -readable code. The motivation behind this design is simple: The number |
6 | | -one thing that Python programmers do is read code. |
7 | | - |
8 | | -One of the secrets of becoming a great Python programmer is to read, |
9 | | -understand, and comprehend excellent code. |
10 | | - |
11 | | -Excellent code typically follows the guidelines outlined in :ref:`code_style`, |
12 | | -and does its best to express a clear and concise intent to the reader. |
13 | | - |
14 | | -Included below is a list of recommended Python projects for reading. Each of |
15 | | -these projects are paragons of excellent Python code. |
16 | | - |
17 | | -- `Howdoi <https://github.com/gleitz/howdoi>`_ |
18 | | - Howdoi is a code search tool, written in Python. |
19 | | - |
20 | | -- `Flask <https://github.com/mitsuhiko/flask>`_ |
21 | | - Flask is a microframework for Python based on Werkzeug and Jinja2. |
22 | | - It's intended for getting started very quickly and was developed with |
23 | | - best intentions in mind. |
24 | | - |
25 | | -- `Werkzeug <https://github.com/mitsuhiko/werkzeug>`_ |
26 | | - Werkzeug started as simple collection of various utilities for WSGI |
27 | | - applications and has become one of the most advanced WSGI utility modules. |
28 | | - It includes a powerful debugger, full-featured request and response objects, |
29 | | - HTTP utilities to handle entity tags, cache control headers, HTTP dates, |
30 | | - cookie handling, file uploads, a powerful URL routing system and a bunch |
31 | | - of community-contributed addon modules. |
32 | | - |
33 | | -- `Requests <https://github.com/kennethreitz/requests>`_ |
34 | | - Requests is an Apache2 Licensed HTTP library, written in Python, |
35 | | - for human beings. |
36 | | - |
37 | | -- `Tablib <https://github.com/kennethreitz/tablib>`_ |
38 | | - Tablib is a format-agnostic tabular dataset library, written in Python. |
39 | | - |
40 | | -.. todo:: Embed and explain YouTube video showing python code reading: http://www.youtube.com/watch?v=Jc8M9-LoEuo This may require installing a Sphinx plugin. https://bitbucket.org/birkenfeld/sphinx-contrib/src/a09f29fc16970f34350ca36ac7f229e00b1b1674/youtube?at=default |
41 | | - |
42 | | -.. todo:: Include code examples of exemplary code from each of the projects listed. Explain why it is excellent code. Use complex examples. |
43 | | - |
| 1 | +Reading Great Code |
| 2 | +================== |
| 3 | + |
| 4 | +One of the core tenants behind the design of Python is creating |
| 5 | +readable code. The motivation behind this design is simple: The number |
| 6 | +one thing that Python programmers do is read code. |
| 7 | + |
| 8 | +One of the secrets of becoming a great Python programmer is to read, |
| 9 | +understand, and comprehend excellent code. |
| 10 | + |
| 11 | +Excellent code typically follows the guidelines outlined in :ref:`code_style`, |
| 12 | +and does its best to express a clear and concise intent to the reader. |
| 13 | + |
| 14 | +Included below is a list of recommended Python projects for reading. Each of |
| 15 | +these projects are paragons of excellent Python code. |
| 16 | + |
| 17 | +- `Howdoi <https://github.com/gleitz/howdoi>`_ |
| 18 | + Howdoi is a code search tool, written in Python. |
| 19 | + |
| 20 | +- `Flask <https://github.com/mitsuhiko/flask>`_ |
| 21 | + Flask is a microframework for Python based on Werkzeug and Jinja2. |
| 22 | + It's intended for getting started very quickly and was developed with |
| 23 | + best intentions in mind. |
| 24 | + |
| 25 | +- `Werkzeug <https://github.com/mitsuhiko/werkzeug>`_ |
| 26 | + Werkzeug started as simple collection of various utilities for WSGI |
| 27 | + applications and has become one of the most advanced WSGI utility modules. |
| 28 | + It includes a powerful debugger, full-featured request and response objects, |
| 29 | + HTTP utilities to handle entity tags, cache control headers, HTTP dates, |
| 30 | + cookie handling, file uploads, a powerful URL routing system and a bunch |
| 31 | + of community-contributed addon modules. |
| 32 | + |
| 33 | +- `Requests <https://github.com/kennethreitz/requests>`_ |
| 34 | + Requests is an Apache2 Licensed HTTP library, written in Python, |
| 35 | + for human beings. |
| 36 | + |
| 37 | +- `Tablib <https://github.com/kennethreitz/tablib>`_ |
| 38 | + Tablib is a format-agnostic tabular dataset library, written in Python. |
| 39 | + |
| 40 | +.. todo:: Embed and explain YouTube video showing python code reading: http://www.youtube.com/watch?v=Jc8M9-LoEuo This may require installing a Sphinx plugin. https://bitbucket.org/birkenfeld/sphinx-contrib/src/a09f29fc16970f34350ca36ac7f229e00b1b1674/youtube?at=default |
| 41 | + |
| 42 | +.. todo:: Include code examples of exemplary code from each of the projects listed. Explain why it is excellent code. Use complex examples. |
| 43 | + |
44 | 44 | .. todo:: Explain techniques to rapidly identify data structures, algorithms and determine what the code is doing. |
0 commit comments