mirror of
https://github.com/kennethreitz/python-guide.git
synced 2026-06-05 23:00:18 +00:00
Added new Reading section.
If readability is so important to python, why don't python guides have a list of recommended awesome code to read? Why don't they explain that code? The idea behind this reading section is to provide such a guide. The idea here is to start with something small and useful, with a vision for the future, and iterate quickly.
This commit is contained in:
David Echols
+119
-118
@@ -1,118 +1,119 @@
|
||||
Getting Started
|
||||
---------------
|
||||
|
||||
This part of the guide focuses on setting up your Python environment.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
starting/which-python
|
||||
|
||||
- Properly Install Python
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
starting/install/osx
|
||||
starting/install/win
|
||||
starting/install/linux
|
||||
|
||||
|
||||
|
||||
Writing Great Code
|
||||
------------------
|
||||
|
||||
This part of the guide focuses on best practices for writing Python code.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
writing/structure
|
||||
writing/style
|
||||
writing/documentation
|
||||
writing/tests
|
||||
writing/gotchas
|
||||
writing/license
|
||||
|
||||
|
||||
|
||||
Scenario Guide
|
||||
--------------
|
||||
|
||||
This part of the guide focuses on tool and module advice based on
|
||||
different scenarios.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
scenarios/client
|
||||
scenarios/web
|
||||
scenarios/cli
|
||||
scenarios/gui
|
||||
scenarios/db
|
||||
scenarios/network
|
||||
scenarios/admin
|
||||
scenarios/ci
|
||||
scenarios/speed
|
||||
scenarios/scientific
|
||||
scenarios/imaging
|
||||
scenarios/xml
|
||||
|
||||
|
||||
Shipping Great Code
|
||||
-------------------
|
||||
|
||||
This part of the guide focuses on deploying your Python code.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
shipping/packaging
|
||||
shipping/freezing
|
||||
|
||||
|
||||
Development Environment
|
||||
-----------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
dev/env
|
||||
dev/virtualenvs
|
||||
|
||||
|
||||
|
||||
|
||||
Additional Notes
|
||||
----------------
|
||||
|
||||
This part of the guide, which is mostly prose, begins with some
|
||||
background information about Python, then focuses on next steps.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
intro/duction
|
||||
intro/community
|
||||
intro/learning
|
||||
intro/documentation
|
||||
intro/news
|
||||
|
||||
|
||||
|
||||
|
||||
--------------------------------------
|
||||
|
||||
Contribution notes and legal information are here (for those interested).
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
notes/contribute
|
||||
notes/license
|
||||
notes/styleguide
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Getting Started
|
||||
---------------
|
||||
|
||||
This part of the guide focuses on setting up your Python environment.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
starting/which-python
|
||||
|
||||
- Properly Install Python
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
starting/install/osx
|
||||
starting/install/win
|
||||
starting/install/linux
|
||||
|
||||
|
||||
|
||||
Writing Great Code
|
||||
------------------
|
||||
|
||||
This part of the guide focuses on best practices for writing Python code.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
writing/structure
|
||||
writing/style
|
||||
writing/reading
|
||||
writing/documentation
|
||||
writing/tests
|
||||
writing/gotchas
|
||||
writing/license
|
||||
|
||||
|
||||
|
||||
Scenario Guide
|
||||
--------------
|
||||
|
||||
This part of the guide focuses on tool and module advice based on
|
||||
different scenarios.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
scenarios/client
|
||||
scenarios/web
|
||||
scenarios/cli
|
||||
scenarios/gui
|
||||
scenarios/db
|
||||
scenarios/network
|
||||
scenarios/admin
|
||||
scenarios/ci
|
||||
scenarios/speed
|
||||
scenarios/scientific
|
||||
scenarios/imaging
|
||||
scenarios/xml
|
||||
|
||||
|
||||
Shipping Great Code
|
||||
-------------------
|
||||
|
||||
This part of the guide focuses on deploying your Python code.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
shipping/packaging
|
||||
shipping/freezing
|
||||
|
||||
|
||||
Development Environment
|
||||
-----------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
dev/env
|
||||
dev/virtualenvs
|
||||
|
||||
|
||||
|
||||
|
||||
Additional Notes
|
||||
----------------
|
||||
|
||||
This part of the guide, which is mostly prose, begins with some
|
||||
background information about Python, then focuses on next steps.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
intro/duction
|
||||
intro/community
|
||||
intro/learning
|
||||
intro/documentation
|
||||
intro/news
|
||||
|
||||
|
||||
|
||||
|
||||
--------------------------------------
|
||||
|
||||
Contribution notes and legal information are here (for those interested).
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
notes/contribute
|
||||
notes/license
|
||||
notes/styleguide
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user