forked from realpython/python-guide
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcontents.rst.inc
144 lines (95 loc) · 2.62 KB
/
contents.rst.inc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
Getting Started with Python
---------------------------
New to Python? Let's properly setup up your Python environment:
.. toctree::
:maxdepth: 2
starting/which-python
- Properly Install Python on your system:
.. toctree::
:maxdepth: 1
starting/installation
starting/install3/osx
starting/install3/win
starting/install3/linux
starting/install/osx
starting/install/win
starting/install/linux
- Using Virtualenvs with Pipenv:
.. toctree::
:maxdepth: 2
dev/virtualenvs
Python Development Environments
-------------------------------
This part of the guide focus on the Python development environment,
and the best-practice tools that are available for writing Python code.
.. toctree::
:maxdepth: 2
dev/env
dev/virtualenvs
dev/pip-virtualenv
Writing Great Python Code
-------------------------
This part of the guide focuses on the best-practices for writing Python code.
.. toctree::
:maxdepth: 2
writing/structure
writing/style
writing/reading
writing/documentation
writing/tests
writing/logging
writing/gotchas
writing/license
Scenario Guide for Python Applications
--------------------------------------
This part of the guide focuses on tool and module advice based on
different scenarios.
.. toctree::
:maxdepth: 2
scenarios/client
scenarios/web
scenarios/scrape
scenarios/cli
scenarios/gui
scenarios/db
scenarios/network
scenarios/admin
scenarios/ci
scenarios/speed
scenarios/scientific
scenarios/imaging
scenarios/serialization
scenarios/xml
scenarios/json
scenarios/crypto
scenarios/ml
scenarios/clibs
Shipping Great Python Code
--------------------------
This part of the guide focuses on deploying your Python code.
.. toctree::
:maxdepth: 2
shipping/packaging
shipping/freezing
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
.. note::
Notes defined within all diatonic and chromatic musical scales have been
intentionally excluded from this list of additional notes. Additionally,
this note.
--------------------------------------
Contribution notes and legal information (for those interested).
.. toctree::
:maxdepth: 2
notes/contribute
notes/license
notes/styleguide