Skip to content

Commit 9a54efb

Browse files
lwasserlwasser
committed
Enh: Add infrastructure to support a new packaging page
1 parent 142cf6f commit 9a54efb

File tree

11 files changed

+265
-3
lines changed

11 files changed

+265
-3
lines changed

‎_config.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,10 @@ whitelist:
245245
- jekyll-redirect-from
246246

247247
collections:
248+
packaging:
249+
people: true
250+
tutorials:
251+
people: true
248252
packages:
249253
output: true
250254
permalink: /:collection/:path/

‎_data/navigation.yml

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,25 @@ main:
99
- title: "Community partners"
1010
icon:
1111
url: "/partners.html"
12+
- title: "Accepted packages"
13+
icon:
14+
url: "/python-packages/"
1215
- title: "Peer review guide"
1316
url: "https://www.pyopensci.org/software-peer-review/"
1417
icon: "fas fa-external-link-alt"
1518
- title: "Python package guide"
1619
url: "https://www.pyopensci.org/python-package-guide/"
1720
icon: "fas fa-external-link-alt"
18-
- title: "Our packages"
21+
- title: "Python Packaging"
1922
icon: "fas fa-fw fa-envelope-square"
20-
url: "/python-packages/index.html"
23+
url:
24+
sub-nav:
25+
- title: "Packaging help"
26+
icon:
27+
url: "python-packaging-help.html"
28+
- title: "Our packages"
29+
icon:
30+
url: "/python-packages/"
2131
- title: "Blog"
2232
url: "/blog/index.html"
2333
- title: "Community"

‎_includes/tutorial_grid.html

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
2+
<div class="element-item cards">
3+
<article class="archive__item" itemscope="" itemtype="https://schema.org/CreativeWork">
4+
{% if atutorial.image %}
5+
<div class="person_img">
6+
<img src="{{ atutorial.image }}" alt="Alt here">
7+
</div>
8+
{% endif %}
9+
<h4 class="person_name" itemprop="headline">
10+
<a href="{{ atutorial.link }}" rel="permalink"> {{ atutorial.title }}
11+
</a>
12+
</h4>
13+
14+
{% if atutorial.excerpt %}
15+
<p class="page__meta">
16+
<span>
17+
{{ atutorial.excerpt }}
18+
</span>
19+
</p>
20+
{% endif %}
21+
22+
{% if atutorial.learning_objectives %}
23+
<ul>
24+
{% for objective in atutorial.learning_objectives %}
25+
<li>
26+
{{ objective }}
27+
</li>
28+
{% endfor %}
29+
</ul>
30+
{% endif %}
31+
32+
{% if atutorial.subpages %}
33+
<ul>
34+
{% for page in atutorial.subpages %}
35+
<li>
36+
<a href="{{ page.url }}">{{ page.name }}</a>
37+
</li>
38+
{% endfor %}
39+
</ul>
40+
41+
{% endif %}
42+
43+
</article>
44+
</div>

‎_packaging/documentation.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: "Documentation"
3+
excerpt: "
4+
More."
5+
learning_objectives:
6+
subpages:
7+
- name: Package structure
8+
url: https://www.pyopensci.org/python-package-guide/package-structure-code/intro.html
9+
- name: Build tools package
10+
url: https://www.pyopensci.org/python-package-guide/package-structure-code/intro.html
11+
url:
12+
---

‎_packaging/packaging.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: "Python package structure"
3+
excerpt: "
4+
This section provides guidance on your Python package’s structure, code formats and style. It also reviews the various packaging tools that you can use to support building and publishing your package."
5+
learning_objectives:
6+
subpages:
7+
- name: Package structure
8+
url: https://www.pyopensci.org/python-package-guide/package-structure-code/intro.html
9+
- name: Build tools package
10+
url: https://www.pyopensci.org/python-package-guide/package-structure-code/intro.html
11+
url:
12+
---

‎_packaging/tests.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: "Python package tests"
3+
excerpt: "
4+
More."
5+
learning_objectives:
6+
subpages:
7+
- name: Write tests
8+
url: https://www.pyopensci.org/python-package-guide/package-structure-code/intro.html
9+
- name: Types
10+
url: https://www.pyopensci.org/python-package-guide/package-structure-code/intro.html
11+
url:
12+
---

‎_pages/home.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
layout: splash
33
title: "Welcome to pyOpenSci"
4+
excerpt: "We support the scientific Python tools drive open science through peer review, training and community building."
45
author_profile: false
56
published: true
67
site-map: true

‎_pages/packaging-resources.md

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
---
2+
layout: splash
3+
classes: flowing
4+
permalink: /python-packaging-help.html
5+
title: "Python packaging help and resources"
6+
excerpt: "We make the scientific Python package ecosystem easier to navigate through peer review and packaging resources."
7+
header:
8+
overlay_image: images/header.jpg
9+
overlay_filter: 0.8
10+
intro:
11+
- excerpt: "More here on community packaging."
12+
scientists:
13+
- image_path: images/pyopensci-people-at-computer.jpg
14+
alt: "A pencil sketch of a round table with people sitting around it from different backgrounds working on laptops and also writing together."
15+
excerpt: "Our catalog of vetted open source tools makes it easier for scientists to find the trusted tools that they need to develop their open science workflows."
16+
title: "Help scientists find the open science tools that they need"
17+
url: https://www.pyopensci.org/python-packages.html
18+
btn_label: View our growing list of accepted scientific Python packages
19+
btn_class: btn--primary
20+
packaging-easier:
21+
- image_path: images/people-building-blocks.jpg
22+
alt: "A group of people working on a tetris like set of building blocks trying to stack them all together. "
23+
title: "Contribute to our packaging resources"
24+
excerpt: "More here about our review process with links :
25+
26+
* More
27+
28+
* More
29+
"
30+
url: https://www.pyopensci.org/python-package-guide
31+
btn_label: View our Python packaging guide
32+
btn_class: btn--primary
33+
partnership_benefits:
34+
- image_path: /images/peer-review/pyos-partnerships-peer-review.png
35+
alt: "Diagram with a light purple background. On the left there is the pyOpenSci purple flower and it says accepted with a check mark above. There are two arrows leading to boxes on the right. The top box says JOSS published with a check next to it and the JOSS logo. The box below says Community Affiliated with a check. THe boxes are numbered 1,2,3. "
36+
excerpt: "
37+
Through a single review process, community maintainers:
38+
39+
* Have their package accepted into the pyOpenSci ecosystem
40+
41+
* Can be [published in JOSS (if in scope)](https://www.pyopensci.org/software-peer-review/partners/joss.html#)
42+
43+
* Can become an affiliated package with your community, following your community guidelines.
44+
45+
* Are supported in maintaining their tools, with input from our diverse, knowledgeable community, including active members from across the Python, Conda, PyPA and broader Python packaging ecosystem."
46+
title: "Benefits of partnering with us"
47+
toc: false
48+
---
49+
50+
{% include feature_row id="intro" type="center" %}
51+
52+
<div class="pyos-section purple">
53+
<div class="content" markdown="1">
54+
55+
## Check out our Python Packaging guidebook pages
56+
57+
They've been reviewed.. etc etc...
58+
59+
<div class="entries-grid">
60+
{% for atutorial in site.packaging %}
61+
{% include tutorial_grid.html %}
62+
{% endfor %}
63+
</div>
64+
65+
<div class="clearfix"></div>
66+
67+
More here
68+
69+
</div>
70+
</div>
71+
72+
{% include div_purple_bottom.html %}
73+
74+
<div class="pyos-section">
75+
<div class="content" markdown="1">
76+
77+
## Check out our Python Packaging tutorials
78+
79+
We are currently developing a beginner-friendly packaging tutorial series.
80+
81+
<div class="entries-grid">
82+
{% for atutorial in site.tutorials %}
83+
{% include tutorial_grid.html %}
84+
{% endfor %}
85+
</div>
86+
87+
<div class="clearfix"></div>
88+
89+
More here
90+
91+
</div>
92+
</div>
93+
94+
{% include div_purple_top.html %}
95+
96+
<div class="pyos-section purple" markdown="1">
97+
<div class="content" markdown="1">
98+
{% include feature_row id="scientists" type="left" %}
99+
100+
</div>
101+
</div>
102+
103+
104+
{% include div_purple_bottom.html %}
105+
106+
<div class="pyos-section" markdown="1">
107+
<div class="content" markdown="1">
108+
109+
SDFSDF
110+
111+
</div>
112+
</div>
113+
114+
{% include div_purple_top.html %}
115+
116+
<div class="pyos-section purple" markdown="1">
117+
<div class="content" markdown="1">
118+
119+
{% include feature_row id="packaging-easier" type="left" %}
120+
121+
</div>
122+
</div>
123+
124+
{% include div_purple_bottom.html %}
125+
126+
<div class="pyos-section" markdown="1">
127+
<div class="content" markdown="1">
128+
{% include feature_row id="community" type="right" %}
129+
</div>
130+
</div>
131+
132+
<div class="pyos-section" markdown="1">
133+
<div class="content" markdown="1">
134+
## Raising the bar for Scientific Python software
135+
136+
137+
</div>
138+
</div>
139+
140+
<div class="pyos-section purple" markdown="1">
141+
<div class="content" markdown="1">
142+
143+
144+
</div>
145+
</div>

‎_pages/tutorials.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: scientific Python tutorials
3+
layout: collection
4+
permalink: /tutorials/
5+
collection: portfolio
6+
entries_layout: grid
7+
classes: wide
8+
---

‎_sass/minimal-mistakes/_pyos-grid.scss

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
1+
.clearfix::after {
2+
content: "";
3+
display: table;
4+
clear: both;
5+
}
26

37
/* Create & style a 3x3 grid wrapper */
48
.grid {

0 commit comments

Comments
 (0)