Skip to content

Commit 2cf782e

Browse files
CarreauCarreau
committed
Start working on the practicalities section.
1 parent c75d5f0 commit 2cf782e

4 files changed

Lines changed: 78 additions & 1 deletion

File tree

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
_site/
2-
.DS_Store
2+
.DS_Store
3+
*.swo

‎_config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,5 @@ colors:
3535

3636
collections:
3737
- sections
38+
- practicalities
3839

‎_practicalities/intro.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
---
3+
# As a user
4+
5+
If you are already a Python 3 user, you should not encounter a lot of
6+
disruption. Please check that the libraries you use follow best practises not
7+
to break for other users.
8+
9+
Make sure you have Pip >= 9.0
10+
11+
If you are using a custom local package index, for example if you are working
12+
at a company, make sure it implement correctly pep-512 and let pip knows about
13+
the `python_requires` field.
14+
15+
16+
17+
18+
# Preparing your library
19+
20+
Things to speak about:
21+
22+
- Be on recent enough setuptools
23+
- Add a warning at _runtime_ early on master (before switching to Python 3
24+
only)
25+
- Add an error early at import at runtime with a clear error message, leave the
26+
early import compatible Python 2 for user to not be welcomed with SyntaxError
27+
28+
29+
30+
# Mitigations
31+
32+
- Leave `setup.py` python 2 compatible and fail early. If you detect Python 2
33+
raise a clear error message and ask user to make sure they have pip >9.0 (or
34+
migrate to Python 3). You can (try to) conditionally import pip and check for
35+
its version but this might not be the same pip.
36+
37+
- If you control dependant packages, Make sure to include conditional
38+
dependencies depending on the version of Python.
39+
40+
41+
42+

‎practicalities/index.html‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
---
3+
<!DOCTYPE html>
4+
<html dir="ltr" lang="en">
5+
<head>
6+
<meta charset="UTF-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1">
8+
<title>{{ site.title }}</title>
9+
<meta name="keywords" content="{{ site.keywords }}">
10+
<meta name="description" content="{{ site.description }}">
11+
<link rel="stylesheet" href="../combo.css">
12+
<link href='https://fonts.googleapis.com/css?family=Raleway:400,300,700' rel='stylesheet' type='text/css'>
13+
<link rel="stylesheet" href="https://netdna.bootstrapcdn.com/font-awesome/4.4.0/css/font-awesome.min.css">
14+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/vis/4.16.1/vis.min.css">
15+
<script src="https://cdnjs.cloudflare.com/ajax/libs/vis/4.16.1/vis.min.js"></script>
16+
{% if site.favicon %}<link rel="shortcut icon" href="{{ site.favicon }}" type="image/x-icon">{% endif %}
17+
{% if site.touch_icon %}<link rel="apple-touch-icon" href="{{ site.touch_icon }}">{% endif %}
18+
</head>
19+
<body>
20+
<div id="main">
21+
22+
23+
{% for page in site.practicalities %}
24+
<div class="section">
25+
26+
<div class="container {{ page.style }}">
27+
{{ page.content }}
28+
</div>
29+
</div>
30+
{% endfor %}
31+
</div>
32+
</body>
33+

0 commit comments

Comments
 (0)