Skip to content

pyOpenSci/python-package-guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

pyOpenSci scientific Python Packaging Guide

All Contributors

GitHub release (latest by date)

DOI

CircleCI

Mentioned in Awesome Scientific Python

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
  • 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):

Alexandre Batisse
Alexandre Batisse

πŸ“– 🎨
Ananthu C V
Ananthu C V

πŸ‘€
Anderson Bravalheri
Anderson Bravalheri

πŸ’» 🎨
Ariane Sasso
Ariane Sasso

πŸ“– 🎨 πŸ’» πŸ‘€
Brianne Wilhelmi
Brianne Wilhelmi

πŸ’» πŸ‘€
C. Titus Brown
C. Titus Brown

πŸ’» πŸ‘€
Cale Kochenour
Cale Kochenour

πŸ’» πŸ‘€
Carol Willing
Carol Willing

πŸ‘€
Cheng H. Lee
Cheng H. Lee

πŸ’» πŸ‘€
Chiara Marmo
Chiara Marmo

πŸ’» 🎨 πŸ‘€
Chris Holdgraf
Chris Holdgraf

πŸ’» πŸ‘€
Daniel Possenriede
Daniel Possenriede

πŸ’» πŸ‘€
Dave Hirschfeld
Dave Hirschfeld

πŸ‘€
David Nicholson
David Nicholson

πŸ“– 🎨 βœ…
Eli Schwartz
Eli Schwartz

πŸ’» 🎨 πŸ‘€
Erik Welch
Erik Welch

πŸ“– 🎨
Felipe Moreno
Felipe Moreno

πŸ‘€ πŸ’» 🌍 πŸ“–
Filipe
Filipe

πŸ’» 🎨
Frost Ming
Frost Ming

πŸ’» πŸ‘€
Han
Han

πŸ’» πŸ‘€
Henry Schreiner
Henry Schreiner

πŸ’» 🎨 πŸ‘€
Hugo van Kemenade
Hugo van Kemenade

πŸ’» πŸ‘€
Inessa Pawson
Inessa Pawson

πŸ’» πŸ‘€ βœ…
Isabel Zimmerman
Isabel Zimmerman

πŸ’» πŸ‘€
Ivan Ogasawara
Ivan Ogasawara

πŸ’» πŸ‘€ βœ…
Jackson Burns
Jackson Burns

πŸ’» πŸ‘€ βœ…
James Tocknell
James Tocknell

πŸ’» πŸ‘€
Jannis Leidel
Jannis Leidel

πŸ’» πŸ‘€
Jeremy Paige
Jeremy Paige

πŸ’» πŸ‘€ βœ… 🚧 πŸ“–
Jesse Mostipak
Jesse Mostipak

βœ…
John Drake
John Drake

πŸ’» πŸ‘€
Jonny Saunders
Jonny Saunders

πŸ’» 🎨 πŸ€”
Joseph H Kennedy
Joseph H Kennedy

πŸ’» πŸ‘€
Juan Luis Cano RodrΓ­guez
Juan Luis Cano RodrΓ­guez

πŸ’» 🎨 πŸ‘€
Karen Cranston
Karen Cranston

πŸ’» πŸ‘€
Ken Seehart
Ken Seehart

πŸ’» πŸ‘€
Kozo Nishida
Kozo Nishida

πŸ‘€ 🌍
Leah Wasser
Leah Wasser

πŸ“– 🎨
Maria Knorps
Maria Knorps

πŸ’» πŸ‘€
Matt Hall
Matt Hall

πŸ’» πŸ‘€
Megan Sosey
Megan Sosey

πŸ’» πŸ‘€
Melissa Weber Mendonça
Melissa Weber Mendonça

πŸ’¬
Moritz E. Beber
Moritz E. Beber

πŸ’» βœ…
Naty Clementi
Naty Clementi

πŸ’» πŸ‘€ 🌍
Neil Chue Hong
Neil Chue Hong

πŸ‘€
Nick Murphy
Nick Murphy

πŸ’» πŸ‘€
Ofek Lev
Ofek Lev

πŸ’» 🎨 πŸ‘€ βœ…
Olek
Olek

πŸ’» πŸ‘€
Oriol Abril-Pla
Oriol Abril-Pla

πŸ’¬
Pamphile Roy
Pamphile Roy

πŸ“– 🎨
Pat Tressel
Pat Tressel

πŸ’» πŸ‘€
Patrick Byers
Patrick Byers

πŸ’» πŸ‘€
Philipp A.
Philipp A.

πŸ’» πŸ‘€
Pradyun Gedam
Pradyun Gedam

πŸ’» 🎨 πŸ‘€
Ralf Gommers
Ralf Gommers

πŸ’» 🎨 πŸ‘€
Randy DΓΆring
Randy DΓΆring

πŸ’» πŸ‘€
Revathy Venugopal
Revathy Venugopal

πŸ’» πŸ‘€ πŸ“–
Roberto Pastor Muela
Roberto Pastor Muela

πŸ’» πŸ‘€ 🌍 πŸ€”
Ryan
Ryan

πŸ’» πŸ‘€
Simon
Simon

πŸ“– 🎨
Sneha Yadav
Sneha Yadav

πŸ’» πŸ‘€
Stefan van der Walt
Stefan van der Walt

πŸ’» 🎨 πŸ‘€
Stefanie Molin
Stefanie Molin

πŸ’» πŸ‘€
Stefano Rivera
Stefano Rivera

πŸ‘€
Tetsuo Koyama
Tetsuo Koyama

πŸ’» πŸ‘€ πŸ“– 🌍 πŸ€”
Tom Russell
Tom Russell

πŸ’» πŸ‘€ βœ…
Trevor James Smith
Trevor James Smith

πŸ’» πŸ‘€
Tyler Bonnell
Tyler Bonnell

πŸ’» πŸ‘€
Vaunty
Vaunty

πŸ’» πŸ‘€
William F. Broderick
William F. Broderick

βœ…
Zack Weinberg
Zack Weinberg

πŸ‘€
h-vetinari
h-vetinari

πŸ’» πŸ‘€ βœ…
hpodzorski-USGS
hpodzorski-USGS

πŸ’» πŸ‘€
jaimergp
jaimergp

πŸ’» πŸ‘€ βœ…
miguelalizo
miguelalizo

πŸ’» πŸ‘€ πŸ“–
nyeshlur
nyeshlur

πŸ’» πŸ‘€
ruoxi
ruoxi

πŸ’» πŸ‘€
Γ‰ric
Γ‰ric

πŸ’» πŸ‘€

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

Star History

Star History Chart