From cf1ffa7bc3f2c6e45789d373bab0164cddbbc2fc Mon Sep 17 00:00:00 2001 From: Nabil Freij Date: Sat, 27 Jan 2024 16:09:00 -0800 Subject: [PATCH] pyOpenSci blogpost (#401) * blogpost * Apply suggestions from code review Co-authored-by: Stuart Mumford --------- Co-authored-by: Stuart Mumford --- .gitignore | 1 + README.md | 11 +++++------ posts/2024/2024-01-24-pyopensci.md | 24 ++++++++++++++++++++++++ 3 files changed, 30 insertions(+), 6 deletions(-) create mode 100644 posts/2024/2024-01-24-pyopensci.md diff --git a/.gitignore b/.gitignore index 963723da..0a68c607 100755 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,4 @@ CITATION.rst CODE_OF_CONDUCT.rst .idea/ .tox +node_modules/ diff --git a/README.md b/README.md index 9a317e90..43104687 100644 --- a/README.md +++ b/README.md @@ -46,9 +46,9 @@ This must pass before the PR will be merged, furthermore, one review is required Blog posts can be added by creating a new text file in the `posts/` directory. The filename must use the following naming convention `YEAR-MONTH-DAY-title.{ext}` and be written in one of the following formats: -- [RST](https://www.sphinx-doc.org/en/stable/rest.html) formatted text, `ext=rst`, -- [Jupyter notebook](https://jupyter.org/), `ext=ipynb`; (notebooks are converted to RST using the [nbsphinx](https://nbsphinx.readthedocs.io) extension) -- [MD](https://www.markdownguide.org/cheat-sheet/) formatted text, `ext=md`, +- [ReStructuredText (RST)](https://www.sphinx-doc.org/en/stable/rest.html) formatted text, `ext=rst`, +- [Jupyter Notebook (NB)](https://jupyter.org/), `ext=ipynb`; (notebooks are converted to RST using the [nbsphinx](https://nbsphinx.readthedocs.io) extension) +- [Markdown (MD)](https://www.markdownguide.org/cheat-sheet/) formatted text, `ext=md`, Please also see the [ABlog documentation](https://ablog.readthedocs.io/) for more information. @@ -99,7 +99,7 @@ See the [nbsphinx docs](https://nbsphinx.readthedocs.io/raw-cells.html) for info You might have to open the notebook in a text editor and change the "metadata" for the post cell to include the following -``` +```json "metadata": { "raw_mimetype": "text/restructuredtext" }, @@ -114,7 +114,7 @@ If your notebook requires any other dependencies besides SunPy (or its dependenc 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: -``` +```markdown --- blogpost: true date: @@ -123,7 +123,6 @@ category: --- # - ``` ### Metadata diff --git a/posts/2024/2024-01-24-pyopensci.md b/posts/2024/2024-01-24-pyopensci.md new file mode 100644 index 00000000..293959fb --- /dev/null +++ b/posts/2024/2024-01-24-pyopensci.md @@ -0,0 +1,24 @@ +--- +blogpost: true +date: Jan 24 2024 +author: Nabil Freij +category: Update +--- + +# pyOpenSci and `sunpy` + +![pyOpenSci logo](https://avatars.githubusercontent.com/u/28938222?s=200&v=4) + +[pyOpenSci](https://www.pyopensci.org/) is a "diverse community of people interested in building a community of practice around scientific software written in Python". +They are an exciting community working on improving the information around the packaging and tooling used by the scientific Python community as well to provide support for package maintainers. +There is a review process to become a pyOpenSci accepted package which comes with two reviews from independent members of the wider community. + +With this in mind, the SunPy Project decided to submit the `sunpy` package to pyOpenSci to ensure that it is aligned with the community that pyOpenSci is building, and increase visibility of SunPy. + +[The review](https://github.com/pyOpenSci/software-submission/issues/147) was started on the [pyOpenSci software-submission repository](https://github.com/pyOpenSci/software-submission). +The entire review process is open, with one editor and two reviewers and the entire exchange between the `sunpy` maintainers and the reviewers are on that issue. +This process was incredibly helpful as it highlighted areas of our documentation which could be improved and some technical choices that were made several years ago but now were redundant or not best practice. + +After these issues were fixed, `sunpy` was accepted into pyOpenSci and we added the badge to the `sunpy` readme. +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. +Our hope is that by aligning with pyOpenSci we can help to contribute back to the wider community.