pyOpenSci scientific Python Packaging Guide

What is pyOpenSci?

pyOpenSci is devoted to building diverse, supportive community around the Python open source tools that drive open science. We do this through:

• open peer review
• mentorship and
• training.

pyOpenSci is an independent organization, fiscally sponsored by Community Initiatives.

Contributing statement

How to setup

This repository contains the source files for the pyOpenSci Python packaging guide.

Build the guidebook locally

Our guidebook is built with Sphinx which is a documentation tool and uses the pydata-sphinx-theme.

The easiest way to build our documentation is to use the nox automation tool, a tool for quickly building environments and running commands within them.

Using nox ensures that your environment has all the dependencies needed to build the documentation.

To build, follow these steps:

1. Install nox

   $ python -m pip install nox

2. Build the documentation:

   $ nox -s docs

This should create a local environment in a .nox folder, build the documentation (as specified in the noxfile.py configuration), and the output will be in _build/html.

To build live documentation that updates when you update local files, run the following command:

$ nox -s docs-live

Contributing to this guide

We welcome and issues and pull requests to improve the content of this guide. If you'd like to see an improvement, please open an issue.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Erik Welch 📖 🎨	David Nicholson 📖 🎨 ✅	Leah Wasser 📖 🎨	Ariane Sasso 📖 🎨 💻 👀	Simon 📖 🎨	Alexandre Batisse 📖 🎨	Pamphile Roy 📖 🎨
Filipe 💻 🎨	Jonny Saunders 💻 🎨	Randy Döring 💻 👀	Juan Luis Cano Rodríguez 💻 🎨 👀	Henry Schreiner 💻 🎨 👀	Stefan van der Walt 💻 🎨 👀	Eli Schwartz 💻 🎨 👀
Ralf Gommers 💻 🎨 👀	Pradyun Gedam 💻 🎨 👀	Ofek Lev 💻 🎨 👀 ✅	Chiara Marmo 💻 🎨 👀	James Tocknell 💻 👀	Frost Ming 💻 👀	Hugo van Kemenade 💻 👀
Matt Hall 💻 👀	Jannis Leidel 💻 👀	Dave Hirschfeld 👀	Jeremy Paige 💻 👀 ✅ 🚧 📖	Anderson Bravalheri 💻 🎨	Daniel Possenriede 💻 👀	ruoxi 💻 👀
Isabel Zimmerman 💻 👀	Nick Murphy 💻 👀	Trevor James Smith 💻 👀	Éric 💻 👀	Karen Cranston 💻 👀	Joseph H Kennedy 💻 👀	Inessa Pawson 💻 👀 ✅
William F. Broderick ✅	Jesse Mostipak ✅	Maria Knorps 💻 👀	Philipp A. 💻 👀	Moritz E. Beber 💻 ✅	Jackson Burns 💻 👀 ✅	jaimergp 💻 👀 ✅
h-vetinari 💻 👀 ✅	Ivan Ogasawara 💻 👀 ✅	Tom Russell 💻 👀 ✅	C. Titus Brown 💻 👀	Cale Kochenour 💻 👀	miguelalizo 💻 👀	nyeshlur 💻 👀
Tyler Bonnell 💻 👀	Pat Tressel 💻 👀	Ken Seehart 💻 👀	Ryan 💻 👀	Patrick Byers 💻 👀	Megan Sosey 💻 👀	Brianne Wilhelmi 💻 👀
Cheng H. Lee 💻 👀	Vaunty 💻 👀	Zack Weinberg 👀	Felipe Moreno 👀 💻	Sneha Yadav 💻 👀	Stefano Rivera 👀	Stefanie Molin 💻 👀
Ananthu C V 👀	Chris Holdgraf 💻 👀	Neil Chue Hong 👀	Roberto Pastor Muela 💻 👀	Olek 💻 👀	Han 💻 👀	hpodzorski-USGS 💻 👀
Naty Clementi 💻 👀	John Drake 💻 👀	Revathy Venugopal 💻 👀

This project follows the all-contributors specification. Contributions of any kind welcome!