Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Start working on the practicalities section. #55

Merged
merged 9 commits into from Apr 19, 2017
Merged

Start working on the practicalities section. #55

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2cf782e
Start working on the practicalities section.
Carreau Nov 21, 2016
b5e2324
Expand informations
Carreau Nov 21, 2016
c344f31
Expand more sections
Carreau Nov 21, 2016
b30b966
Fix some comments
Carreau Nov 26, 2016
3bf0156
More infos
Carreau Nov 26, 2016
958ec43
Some refinments
Carreau Apr 14, 2017
7cf319e
'finish up practicalities'
Carreau Apr 17, 2017
b542e01
Take into account most of Thomas comments.
Carreau Apr 18, 2017
f9ed6e8
Last changes from Thomas
Carreau Apr 18, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions _includes/css/main.css
View file
Open in desktop
Expand Up @@ -25,6 +25,16 @@ html { box-sizing: border-box; }
#{{id}} .sectiondivider { color: {{ bg }}; }
{% endfor %}

{% for node in site.practicalities %}
{% capture id %}{{ node.id | remove:'/' | downcase }}{% endcapture %}
{% capture bg %}{% if site.colors[node.bg] %}{{ site.colors[node.bg] }}{% else %}{{ node.bg }}{% endif %}{% endcapture %}
{% capture fg %}{% if site.colors[node.color] %}{{ site.colors[node.color] }}{% else %}{{ node.color }}{% endif %}{% endcapture %}
nav .p-{{id}} { border-color: {{ bg }}; }
#{{id}} { background-color: {{ bg }} !important; color: {{ fg }}; }
#{{id}} a { color: {{ fg }}; }
#{{id}} .sectiondivider { color: {{ bg }}; }
{% endfor %}


/* ----- code, syntax highlighting, etc ----- */

Expand Down
15 changes: 11 additions & 4 deletions _practicalities/intro.md
View file
Open in desktop
@@ -1,16 +1,22 @@
---
bg: '#4da45e'
color: white
title: practicalities
fa-icon: pencil
id: bar
---

Add note here to explain that this does _not_ prevent _nor_ discourage library
author to release 2 version of their software one Python 3 only and the other
python 2.
We do not discourage authors to release software on Python 2. While this guide
is mostly written with the assumption that software are going to stop Python 2
support, it does perfectly apply to a package that wish to not support Python 3,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not quite sure what you're saying here. How would this apply to a package that doesn't wish to support Python 3?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the explanations are perfectly valid for someone who want to publish a requires_python<3 and it won't install on Python 3.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aha, I see.

or is stopping support for any minor version.


This page gather information and links to resources allowing to release a
library that stop supporting an older version of Python without causing too
much disruption for users who haven't upgraded to this new version.

Wether you are a user, or a developer, being aware of the issue listed here, at
Whether you are a user, or a developer, being aware of the issue listed here, at
least the main points should ease lots of the pain.

# Too long, did not read:
Expand All @@ -20,6 +26,7 @@ least the main points should ease lots of the pain.
- As maintainer use `setup(..., python_requires='>=3.4')` new option.
- do use `pip install [-e] .` and do **not** invoke `setup.py` directly.
- **Fail** early at **install time** if on Python 2.
- We are giving a talk at PyCon 2017 (likely recorded), add link here.

## The problem

Expand Down
7 changes: 4 additions & 3 deletions _sections/80-update-my-project.md
View file
Open in desktop
Expand Up @@ -15,9 +15,10 @@ encountered both by developers and users during this process.
We are thus collecting a list of things to be aware of for when transitioning that
are less obvious. For example : as a developer, how to make sure that
your package manager like pip does not upgrade your libraries to incompatible
versions on Python 2. Check [our
repository](https://github.com/python3statement/python3statement.github.io) for
more information.
versions on Python 2. See the [Practicality Page](/practicalities/) for
informations and Check [our
repository](https://github.com/python3statement/python3statement.github.io) to
contribute.



10 changes: 9 additions & 1 deletion practicalities/index.html
View file
Open in desktop
Expand Up @@ -19,9 +19,17 @@
<body>
<div id="main">

<nav><ul>
{% for node in site.sections %}
{% capture id %}{{ node.id | remove:'/' | downcase }}{% endcapture %}
<li class="p-{{id}}"><a href="../#{{id}}">{{node.title}}</a></li>
{% endfor %}
</ul></nav>


{% for page in site.practicalities %}
<div class="section">
{% capture id %}{{ page.id | remove:'/' | downcase }}{% endcapture %}
<div id="{{id}}" class="section p-{{id}}">

<div class="container {{ page.style }}">
{{ page.content }}
Expand Down