Skip to content

Commit f198dfd

Browse files
committed
blogpost
1 parent 1427eb0 commit f198dfd

File tree

3 files changed

+31
-6
lines changed

3 files changed

+31
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ This must pass before the PR will be merged, furthermore, one review is required
4646
Blog posts can be added by creating a new text file in the `posts/<current year>` directory.
4747
The filename must use the following naming convention `YEAR-MONTH-DAY-title.{ext}` and be written in one of the following formats:
4848

49-
- [RST](https://www.sphinx-doc.org/en/stable/rest.html) formatted text, `ext=rst`,
50-
- [Jupyter notebook](https://jupyter.org/), `ext=ipynb`; (notebooks are converted to RST using the [nbsphinx](https://nbsphinx.readthedocs.io) extension)
51-
- [MD](https://www.markdownguide.org/cheat-sheet/) formatted text, `ext=md`,
49+
- [ReStructuredText (RST)](https://www.sphinx-doc.org/en/stable/rest.html) formatted text, `ext=rst`,
50+
- [Jupyter Notebook (NB)](https://jupyter.org/), `ext=ipynb`; (notebooks are converted to RST using the [nbsphinx](https://nbsphinx.readthedocs.io) extension)
51+
- [Markdown (MD)](https://www.markdownguide.org/cheat-sheet/) formatted text, `ext=md`,
5252

5353
Please also see the [ABlog documentation](https://ablog.readthedocs.io/) for more information.
5454

@@ -99,7 +99,7 @@ See the [nbsphinx docs](https://nbsphinx.readthedocs.io/raw-cells.html) for info
9999

100100
You might have to open the notebook in a text editor and change the "metadata" for the post cell to include the following
101101

102-
```
102+
```json
103103
"metadata": {
104104
"raw_mimetype": "text/restructuredtext"
105105
},
@@ -114,7 +114,7 @@ If your notebook requires any other dependencies besides SunPy (or its dependenc
114114

115115
If you write your post in markdown formatted text, each file must contain the following header for Sphinx via [Ablog](https://github.com/sunpy/ablog) to parse the post properly:
116116

117-
```
117+
```markdown
118118
---
119119
blogpost: true
120120
date: <Date>
@@ -123,7 +123,6 @@ category: <One of the below>
123123
---
124124

125125
# <Title>
126-
127126
```
128127

129128
### Metadata

node_modules/.cache/prettier/.prettier-caches/36c129363814956cf04fae582bdc4f8dff577d8c.json

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

posts/2024/2024-01-24-pyopensci.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
blogpost: true
3+
date: Jan 24 2024
4+
author: Nabil Freij
5+
category: Update
6+
---
7+
8+
# pyOpenSci and `sunpy`
9+
10+
![pyOpenSci logo](https://avatars.githubusercontent.com/u/28938222?s=200&v=4)
11+
12+
[pyOpenSci](https://www.pyopensci.org/) is a "diverse community of people interested in building a community of practice around scientific software written in Python".
13+
They are working on improving the information around the packaging and tooling used by the larger community as well to provide support for package maintainers.
14+
There is a review process to become a pyOpenSci accepted package which comes with two extensive reviews from independent members of the wider community.
15+
16+
With this in mind, the SunPy Project decided to submit `sunpy` to pyOpenSci to ensure that it is aligned with the broader Python community that pyOpenSci is building.
17+
As one of the The Project's core aim is to ensure that we are not isolated from this wider community.
18+
19+
[The review](https://github.com/pyOpenSci/software-submission/issues/147) was started on the [pyOpenSci software-submission repository](https://github.com/pyOpenSci/software-submission).
20+
The entire review process is open, with one editor and two reviewers and the entire exchange between the `sunpy` maintainers and them is on that issue.
21+
This process was incredibly helpful as it pointed some miscommunication within our documentation and some choices that were made several years ago but now were redundant or not best practice.
22+
23+
After these issues were fixed, `sunpy` was accepted into pyOpenSci and we added the badge to the `sunpy` readme.
24+
The plan in future is to submit more SunPy Project packages as well as integrate more closely with pyOpenSci to replace our own affiliated package system.
25+
These are still work in progress and will be announced here in due course.

0 commit comments

Comments
 (0)