Skip to content

Commit

Permalink
Merge pull request #10 from planetarypy/guideline_update
Browse files Browse the repository at this point in the history
Updated Review guidelines for Python 3.9
  • Loading branch information
rbeyer authored Dec 19, 2023
2 parents 5fa4634 + 27e7805 commit 2b64180
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 9 deletions.
9 changes: 5 additions & 4 deletions data/registry.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@
"functional but unmaintained": "orange",
"nonfunctional": "red"
},
"pythonver": "3.6"
"pythonver": "3.9",
"pythonmaxver": "3.11"
},
"packages": [
{
Expand All @@ -44,7 +45,7 @@
"documentation": "Good",
"testing": "Good",
"devstatus": "Good",
"pythonver": "3.6",
"pythonver": "3.8",
"last-updated": "2021-06-02"
}
},
Expand All @@ -62,7 +63,7 @@
"documentation": "Good",
"testing": "Good",
"devstatus": "Good",
"pythonver": "3.6",
"pythonver": "3.9",
"last-updated": "2021-01-27"
}
},
Expand All @@ -80,7 +81,7 @@
"documentation": "Good",
"testing": "Good",
"devstatus": "Good",
"pythonver": "3.6",
"pythonver": "3.9",
"last-updated": "2021-01-22"
}
}
Expand Down
7 changes: 6 additions & 1 deletion pages/packages/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,14 @@ These are the PlanetaryPy Affiliated Packages:
<%def name="getver(ver)">
<%
import math
verinfo = tuple(map(int, ver.split(".")))
pyver = tuple(map(int, post.data("criteria")["pythonver"].split(".")))
pymaxver = tuple(map(int, post.data("criteria")["pythonmaxver"].split(".")))
try:
if float(ver) >= float(post.data("criteria")["pythonver"]):
if verinfo == pyver:
status = f"{ver}-brightgreen"
elif pyver < verinfo <= pymaxver:
status = f"{ver}-orange"
else:
status = f"{ver}-red"
except ValueError as err:
Expand Down
11 changes: 8 additions & 3 deletions pages/packages/review-guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -264,18 +264,23 @@ recently-opened issues have some kind of reply from maintainers.</td>
<h2 id="pythonver">Python version compatibility (<code>pythonver</code>)</h2>

<p>
The PlanetaryPy Project requires that packages be compatible with
The PlanetaryPy Project encourages that packages be compatible with
Python version ${post.data("criteria")["pythonver"]}. Being
compatible with later versions of Python is great, too, but must
be compatible with at least ${post.data("criteria")["pythonver"]}.
be compatible with at least ${post.data("criteria")["pythonver"]} to get a green
rating, but compatibility with Python versions greater than ${post.data("criteria")["pythonver"]} and
less than or equal to ${post.data("criteria")["pythonmaxver"]} will yield an orange rating.
</p>

<table class="table">
<tr>
<td class="w-25 align-center"><img src="https://img.shields.io/badge/Incompatible-red.svg" alt="Incompatible"></td>
<td>Not compatible with Python ${post.data("criteria")["pythonver"]}.</td>
<td>Not compatible with Python versions between ${post.data("criteria")["pythonver"]} and ${post.data("criteria")["pythonmaxver"]}.</td>
</tr>
<tr>
<td class="w-25 align-center"><img src="https://img.shields.io/badge/%3E${post.data("criteria")["pythonver"]}%20%7C%20%3C%3D${post.data("criteria")["pythonmaxver"]}-orange.svg" alt="<${post.data("criteria")["pythonver"]} or >= ${post.data("criteria")["pythonmaxver"]}"></td>
<td>Compatible with Python versions greater than ${post.data("criteria")["pythonver"]} and less than or equal to ${post.data("criteria")["pythonmaxver"]}.</td>
</tr>
<tr>
<td class="w-25 align-center"><img src="https://img.shields.io/badge/${post.data("criteria")["pythonver"]}-brightgreen.svg" alt="${post.data("criteria")["pythonver"]}"></td>
<td>Compatible with Python ${post.data("criteria")["pythonver"]}.</td>
Expand Down
4 changes: 3 additions & 1 deletion pages/packages/review-process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ Template email with review instructions

<p>Thanks!<br />
{coordinator name}</p>
</div>


Template review markdown
Expand All @@ -234,7 +235,7 @@ only the text that applies should remain, altered to your liking.
from urllib.parse import quote
tcase = status.title()
encoded = quote(tcase)
%><img src="https://img.shields.io/badge/${encoded}-${color}.alt" alt=${tcase}"></%def>
%><img src="https://img.shields.io/badge/${encoded}-${color}.svg" alt=${tcase}"></%def>

<pre class="text-monospace">
This package has been reviewed for inclusion in the PlanetaryPy
Expand Down Expand Up @@ -299,6 +300,7 @@ included some comments when the score is not green.
<tr><td><b>Python version compatibility</b></td><td>
<a href="https://planetarypy.github.com/packages/review-guidelines#pythonver">
${getshield("Incompatible", "red")}
<img src="https://img.shields.io/badge/%3E${post.data("criteria")["pythonver"]}%20%7C%20%3C%3D${post.data("criteria")["pythonmaxver"]}-orange.svg" alt="<${post.data("criteria")["pythonver"]} or >= ${post.data("criteria")["pythonmaxver"]}">
${getshield(post.data("criteria")["pythonver"], "brightgreen")}
</a></td></tr>

Expand Down

0 comments on commit 2b64180

Please sign in to comment.