-
-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathindex.html
516 lines (369 loc) · 23.1 KB
/
index.html
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
<!doctype html>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="shortcut icon" type="image/x-icon" href="/static/favicon.ico">
<link rel="stylesheet" href="/static/gen/style.css">
<link rel="stylesheet" href="/static/pygments.css">
<meta property="og:site_name" content="Creative Commons" />
<meta property="og:title" content="Python Guidelines" />
<meta property="og:description" content="These Python Guidelines (style guide) empower the community to
focus on the intent of the code and work together with a minimum of friction." />
<meta property="og:url" content="/contributing-code/python-guidelines/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://cc-og-image.vercel.app/Python Guidelines.png?&md=1&fontFamily=roboto-condensed&fontSize=100px&images=https%3A%2F%2Fcc-vocabulary.netlify.app%2Flogos%2Fproducts%2Fopen_source.svg%23opensource" />
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:title" content="Python Guidelines">
<meta name="twitter:description" content="These Python Guidelines (style guide) empower the community to
focus on the intent of the code and work together with a minimum of friction.">
<meta name="twitter:site" content="@creativecommons">
<meta name="twitter:creator" content="@creativecommons">
<script src="https://code.jquery.com/jquery-3.3.1.min.js"
integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.6/umd/popper.min.js"
integrity="sha384-wHAiFfRlMFy6i5SRaxvfOCifBUQy1xHdJ/yoi7FRNXMRBu5WHdZYu1hA6ZOblgut" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.2.1/js/bootstrap.min.js"
integrity="sha384-B0UglyR+jN6CkvvICOB2joaf5I4l3gm9GU6Hc1og6Ls7i6U/mkkaduKaBhlAXv9k" crossorigin="anonymous"></script>
<script type="text/javascript" src="/static/gen/script.js"></script>
<script src="https://unpkg.com/@creativecommons/vocabulary@2020.7.2/js/vocabulary.js"></script>
<script>
const globalHeaderInstance = vocabulary.createGlobalHeader();
</script>
<title>Python Guidelines — Creative Commons Open Source</title>
<body>
<!-- Header -->
<header class="container">
<nav class="navbar">
<div class="navbar-brand">
<a class="has-text-black" href="/">
<svg
class="logo margin-top-small"
xmlns="http://www.w3.org/2000/svg"
preserveAspectRatio="xMidYMid meet"
viewBox="0 0 284 46">
<use href="#opensource"></use>
</svg>
</a>
<a role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
</a>
</div>
<div class="navbar-menu">
<div class="navbar-end">
<a class="navbar-item " href="/blog/entries/">
Blog
</a>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link is-arrowless is-active" tabindex="0">
Contribute<i class="icon caret-down"></i></a>
<div class="navbar-dropdown">
<a class="navbar-item" href="/contributing-code/">Contribution Guidelines</a>
<a class="navbar-item" href="/contributing-code/projects/">Project List</a>
<a class="navbar-item" href="/contributing-code/issue-finder/">Issue Finder</a>
<a class="navbar-item" href="/contributing-code/pr-guidelines/">Pull Request Guidelines</a>
<a class="navbar-item" href="/contributing-code/github-repo-guidelines/">GitHub Repo Guidelines</a>
<a class="navbar-item" href="/contributing-code/repo-labels/">Repository Labels</a>
<a class="navbar-item" href="/contributing-code/foundational-tech/">Foundational technologies</a>
<a class="navbar-item" href="/contributing-code/javascript-guidelines/">JavaScript Guidelines</a>
<a class="navbar-item" href="/contributing-code/python-guidelines/">Python Guidelines</a>
<a class="navbar-item" href="/contributing-code/translation-guide/">Translation Guide</a>
<a class="navbar-item" href="/contributing-code/usability/">Usability</a>
</div>
</div>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link is-arrowless " tabindex="0">
Community<i class="icon caret-down"></i></a>
<div class="navbar-dropdown is-active">
<a class="navbar-item" href="/community/">Join the Community</a>
<a class="navbar-item" href="/community/community-team/">Community Team</a>
<a class="navbar-item" href="/community/community-team/members/">Community Team Members</a>
<a class="navbar-item" href="/community/community-team/project-roles/">Project Roles</a>
<a class="navbar-item" href="/community/community-team/community-building-roles/">Community Building Roles</a>
<a class="navbar-item" href="/community/write-a-blog-post/">Write a Blog Post</a>
<a class="navbar-item" href="/community/code-of-conduct/">Code of Conduct</a>
<a class="navbar-item" href="/community/code-of-conduct/enforcement/">Code of Conduct Enforcement</a>
<a class="navbar-item" href="/community/supporters/">Supporters</a>
</div>
</div>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link is-arrowless " tabindex="0">
Work Programs<i class="icon caret-down"></i></a>
<div class="navbar-dropdown">
<a class="navbar-item" href="/programs/">Overview</a>
<a class="navbar-item" href="/programs/project-ideas/">Project Ideas</a>
<a class="navbar-item" href="/programs/applicant-guide/">Applicant Guide</a>
<a class="navbar-item" href="/programs/contrib-guide/">Contributor Guide</a>
<a class="navbar-item" href="/programs/lead-guide/">Project Lead Guide</a>
<a class="navbar-item" href="/programs/history/">History</a>
</div>
</div>
</div>
</div>
</nav>
</header>
<!-- Breadcrumb -->
<div class="breadcrumb-container">
<nav class="container breadcrumb caption bold" aria-label="breadcrumbs">
<ul>
<!-- Extracting the slugs of URL -->
<!-- Active link -->
<!-- Forming the URL using extracted slugs -->
<li><a class="link" href="/">
Home
</a></li>
<!-- Active link -->
<!-- Forming the URL using extracted slugs -->
<li><a class="link" href="/contributing-code/">
Contributing Code
</a></li>
<!-- Active link -->
<li class="is-active"><a aria-current="page displayed">Python Guidelines</a></li>
</ul>
</nav>
</div>
<!-- Body -->
<div class="code-guidelines">
<header class="header">
<div class="container is-paddingless">
<h1>Python Guidelines</h1>
<div class="description column is-9 is-paddingless">
<p>These Python Guidelines (style guide) empower the community to
focus on the intent of the code and work together with a minimum of friction.</p>
</div>
</div>
</header>
<div class="container code-guidelines-body">
<div class="columns">
<div class="column is-one-quarter">
<div class="row">
<aside class="menu sidebar-menu">
<ul class="menu-list">
<li>
<a class=" link" href="/contributing-code/projects/">Project List</a>
</li>
<hr class="divider">
<li>
<a class=" link" href="/contributing-code/issue-finder/">Issue Finder</a>
</li>
<hr class="divider">
<li>
<a class=" link" href="/contributing-code/">Contribution Guidelines</a>
<ul>
<li><a class=" link" href="/contributing-code/pr-guidelines/"><i class="icon circle-filled"></i>Pull Request Guidelines</a></li>
<li><a class=" link" href="/contributing-code/github-repo-guidelines/"><i class="icon circle-filled"></i>GitHub Repo Guidelines</a></li>
<li><a class=" link" href="/contributing-code/repo-labels/"><i class="icon circle-filled"></i>Repository Labels</a></li>
<li><a class=" link" href="/contributing-code/javascript-guidelines/"><i class="icon circle-filled"></i>JavaScript Guidelines</a></li>
<li><a class=" is-active link" href="/contributing-code/python-guidelines/"><i class="icon circle-filled"></i>Python Guidelines</a></li>
<li><a class=" link" href="/contributing-code/translation-guide/"><i class="icon circle-filled"></i>Translation Guide</a></li>
</ul>
</li>
<hr class="divider">
<li>
<a class=" link" href="/contributing-code/usability/">Usability</a>
</li>
</ul>
</aside>
</div>
<div class="row padding-bottom-normal sticky-top">
<h4 class="b-header">On this page</h4>
<aside class="menu table-of-contents">
<ul class="menu-list">
<li>
<a class="link" href="#need-of-guidelines">Need of Guidelines</a>
</li>
<li>
<a class="link" href="#development-environment">Development Environment</a>
<ul>
<li><a class="link" href="#overview"><i class="icon circle-filled"></i>Overview</a></li>
<li><a class="link" href="#examples"><i class="icon circle-filled"></i>Examples</a></li>
</ul>
</li>
<li>
<a class="link" href="#development-tools">Development Tools</a>
<ul>
<li><a class="link" href="#tool-order"><i class="icon circle-filled"></i>Tool Order</a></li>
<li><a class="link" href="#handling-imports-isort"><i class="icon circle-filled"></i>Handling Imports (isort)</a></li>
<li><a class="link" href="#code-formatting-black"><i class="icon circle-filled"></i>Code Formatting (black)</a></li>
<li><a class="link" href="#style-and-quality-flake8"><i class="icon circle-filled"></i>Style and Quality (flake8)</a></li>
</ul>
</li>
<li>
<a class="link" href="#additional-guidance">Additional Guidance</a>
</li>
</ul>
</aside>
</div>
</div>
<div class="column content is-three-quarters">
<h2 id="need-of-guidelines">Need of Guidelines</h2><p>These Python Guidelines provides context to the developers who are new to the
codebase and wishes to make any real-world contribution with
<code>org:creativecommons</code> and be a part of the organization and learn new things
with the organization.</p>
<h2 id="development-environment">Development Environment</h2><h3 id="overview">Overview</h3><p>Please work to minimize the number of development related technologies. This
helps minimize the overhead of contributing to multiple projects. Most of our
projects use <a href="https://github.com/pypa/pipenv">Pipenv</a>, <em>the Python Development Workflow for Humans</em>,
and/or <a href="https://docs.docker.com/compose/">docker-compose</a>, <em>a tool for defining and running
multi-container Docker applications</em>.</p>
<h3 id="examples">Examples</h3><ul>
<li>Pipenv configuration: <a href="https://github.com/search?q=org%3Acreativecommons+filename:Pipfile">GitHub Search · org:creativecommons
filename:Pipfile</a></li>
<li>Docker Compose configuration: <a href="https://github.com/search?q=org%3Acreativecommons+filename%3Adocker-compose.yml">GitHub Search · org:creativecommons
filename:docker-compose.yml</a></li>
</ul>
<h2 id="development-tools">Development Tools</h2><h3 id="tool-order">Tool Order</h3><p>The recommended order to execute the tools described below is:</p>
<ol>
<li><code>isort</code> (will make changes)</li>
<li><code>black</code> (will make changes)</li>
<li><code>flake8</code> (issues warnings)</li>
</ol>
<p>Many of the Python repositories have a <code>tools.sh</code> helper script to execute them
in order: <a href="https://github.com/search?q=org%3Acreativecommons+filename%3Atools.sh">GitHub Search · org:creativecommons filename:tools.sh</a>.</p>
<h3 id="handling-imports-isort">Handling Imports (isort)</h3><h4 id="overview">Overview</h4><p>All the imports in the Python code must be done via <a href="https://github.com/pycqa/isort">isort</a>, a <em>Python
utility/library to sort imports</em> alphabetically, and automatically separated
into sections and by type. It provides a command line utility, Python library
and <a href="https://github.com/pycqa/isort/wiki/isort-Plugins">plugins for various editors</a> to quickly sort all your
imports. It requires Python 3.6+ to run but supports formatting Python 2 code
too.</p>
<h4 id="configuration">Configuration</h4><p>There's a good <code>isort</code> config which one should follow while contributing
in the Python projects of the creativecommons. These configurations should
be a part of <code>pyproject.toml</code> labelled as <code>[tools.isort]</code></p>
<ul>
<li>isort configuration (<code>pyproject.toml</code>): <a href="https://github.com/search?q=org%3Acreativecommons+filename:pyproject.toml">GitHub Search · org:creativecommons
filename:pyproject.toml</a></li>
</ul>
<h3 id="code-formatting-black">Code Formatting (black)</h3><h4 id="overview">Overview</h4><p>All Python code must be formatted using <a href="https://github.com/psf/black">Black</a>, <em>the uncompromising
Python code formatter</em>. Each project should contain a <code>pyproject.toml</code>
configuration file that limits line length to 79 characters.</p>
<h4 id="examples">Examples</h4><ul>
<li>Black configuration (<code>pyproject.toml</code>): <a href="https://github.com/search?q=org%3Acreativecommons+filename:pyproject.toml">GitHub Search · org:creativecommons
filename:pyproject.toml</a></li>
<li>GitHub Actions workflow: <a href="https://github.com/search?q=org%3Acreativecommons+%22pipenv+run+black%22&type=code">GitHub Search · org:creativecommons "pipenv run
black"</a></li>
</ul>
<h3 id="style-and-quality-flake8">Style and Quality (flake8)</h3><h4 id="overview">Overview</h4><p>All Python code must be checked using <a href="https://github.com/pycqa/flake8">flake8</a>, <em>a python tool that
glues together pycodestyle, pyflakes, mccabe, and third-party plugins to check
the style and quality of some python code.</em></p>
<h4 id="conflicts-with-black">Conflicts with Black</h4><p>Where flake8 conflicts with Black, the flake8 check should be skipped. For
example, there are instances where black formats code that generates flake8
warning for <a href="https://www.flake8rules.com/rules/E203.html">Whitespace before ':' (E203)</a>.</p>
<h4 id="examples">Examples</h4><ul>
<li>flake8 configuration (<code>.flake8</code>): <a href="https://github.com/search?q=org%3Acreativecommons+filename:.flake8">GitHub Search · org:creativecommons
filename:.flake8</a></li>
<li>flake8 skip E203 warning: <a href="https://github.com/search?q=org%3Acreativecommons+%22noqa%3A+E203%22&type=code">GitHub Search · org:creativecommons "noqa:
E203"</a></li>
<li>GitHub Actions workflow: <a href="https://github.com/search?q=org%3Acreativecommons+%22pipenv+run+flake8%22&type=code">GitHub Search · org:creativecommons "pipenv run
flake8"</a></li>
</ul>
<h2 id="additional-guidance">Additional Guidance</h2><p>Thankfully, Black removes a lot of style work and worry. Where there is room
for developer discretion, the following guides are excellent resources:</p>
<ul>
<li><a href="https://google.github.io/styleguide/pyguide.html">Google Python Style Guide</a></li>
<li><a href="https://docs.python-guide.org/writing/style/">Code Style — The Hitchhiker's Guide to Python</a></li>
</ul>
</div>
</div>
</div>
</div>
<!-- Footer -->
<footer class="main-footer">
<div class="container">
<div class="columns">
<div class="column is-one-third-tablet-only is-one-quarter-desktop">
<a href="https://creativecommons.org" class="main-logo margin-bottom-bigger">
<span class="has-text-white">
<svg
xmlns="http://www.w3.org/2000/svg"
preserveAspectRatio="xMidYMid meet"
viewBox="0 0 304 73">
<use href="#logomark"></use>
</svg>
</span>
</a>
<div>
<address class="margin-bottom-normal">Creative Commons<br />PO Box 1866, Mountain View CA 94042</address>
<a href="mailto:info@creativecommons.org" class="mail">info@creativecommons.org</a><br />
<a href="tel://+1-415-429-6753" class="phone">+1-415-429-6753</a>
</div>
<div class="margin-vertical-large">
<a href="https://www.instagram.com/creativecommons" class="social has-text-white" target="_blank"
rel="noopener">
<i class="icon margin-right-small is-size-4">instagram</i>
</a>
<a href="https://www.twitter.com/creativecommons" class="social has-text-white" target="_blank"
rel="noopener">
<i class="icon margin-right-small is-size-4">twitter</i>
</a>
<a href="https://www.facebook.com/creativecommons" class="social has-text-white" target="_blank"
rel="noopener">
<i class="icon margin-right-small is-size-4">facebook</i>
</a>
<a href="https://www.linkedin.com/company/creative-commons/" class="social has-text-white" target="_blank"
rel="noopener">
<i class="icon margin-right-small is-size-4">linkedin</i>
</a>
</div>
</div>
<div class="column is-two-third-tablet-only is-three-quarters-desktop">
<div class="columns">
<div class="column is-full">
<nav class="footer-navigation">
<ul class="menu">
<li>
<a href="/blog/entries/" class="menu-item">Blog</a>
</li>
<li>
<a href="/community/community-team/" class="menu-item">Community Team</a>
</li>
<li>
<a href="/contributing-code/projects/" class="menu-item">Project List</a>
</li>
<li>
<a href="/archives/" class="menu-item">Archives</a>
</li>
</ul>
</nav>
</div>
</div>
<div class="columns">
<div class="column is-two-thirds">
<div class="subscription">
<h5 class="b-header">Subscribe to our newsletter</h5>
<form class="newsletter">
<input type="email" id="emailInput" class="input" placeholder="Your email" required>
<input type="submit" value="subscribe" class="button small">
</form>
</div>
<div class="attribution margin-top-bigger">
<p class="caption">
Except where otherwise
<a href="https://creativecommons.org/policies#license" target="_blank" rel="noopener">noted</a>,
content on this site is licensed under a
<a href="https://creativecommons.org/licenses/by/4.0/" target="_blank" rel="noopener">Creative Commons
Attribution 4.0 International license</a>.
<a href="https://creativecommons.org/website-icons" target="_blank" rel="noopener">Icons</a>
by
<a href="https://fontawesome.com/" target="_blank" rel="noopener">Font Awesome</a>.
</p>
<div class="margin-top-smaller">
<i class="icon margin-right-small is-size-4">cclogo</i>
<i class="icon margin-right-small is-size-4">ccby</i>
</div>
</div>
</div>
<div class="column is-one-third">
<aside class="donate-section">
<h5>Our work relies on you!</h5>
<p>Help us keep the internet free and open.</p>
<a class="button small donate" href="https://creativecommons.org/donate?c_src=website&c_src2=GlobalFooter">
<i class="icon cc-letterheart-filled margin-right-small is-size-5 padding-top-smaller"></i>
Donate now
</a>
</aside>
</div>
</div>
</div>
</div>
</div>
</footer>
</body>