Skip to content

pb-413/python-package-guide

Β 
Β 

Repository files navigation

pyOpenSci scientific Python Packaging Guide

All Contributors

GitHub release (latest by date)

DOI

CircleCI

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

    $ 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
Erik Welch

πŸ“– 🎨
David Nicholson
David Nicholson

πŸ“– 🎨 βœ…
Leah Wasser
Leah Wasser

πŸ“– 🎨
Ariane Sasso
Ariane Sasso

πŸ“– 🎨 πŸ’» πŸ‘€
Simon
Simon

πŸ“– 🎨
Alexandre Batisse
Alexandre Batisse

πŸ“– 🎨
Pamphile Roy
Pamphile Roy

πŸ“– 🎨
Filipe
Filipe

πŸ’» 🎨
Jonny Saunders
Jonny Saunders

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

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

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

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

πŸ’» 🎨 πŸ‘€
Eli Schwartz
Eli Schwartz

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

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

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

πŸ’» 🎨 πŸ‘€ βœ…
Chiara Marmo
Chiara Marmo

πŸ’» 🎨 πŸ‘€
James Tocknell
James Tocknell

πŸ’» πŸ‘€
Frost Ming
Frost Ming

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

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

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

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

πŸ‘€
Jeremy Paige
Jeremy Paige

πŸ’» πŸ‘€ βœ… 🚧 πŸ“–
Anderson Bravalheri
Anderson Bravalheri

πŸ’» 🎨
Daniel Possenriede
Daniel Possenriede

πŸ’» πŸ‘€
ruoxi
ruoxi

πŸ’» πŸ‘€
Isabel Zimmerman
Isabel Zimmerman

πŸ’» πŸ‘€
Nick Murphy
Nick Murphy

πŸ’» πŸ‘€
Trevor James Smith
Trevor James Smith

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

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

πŸ’» πŸ‘€
Joseph H Kennedy
Joseph H Kennedy

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

πŸ’» πŸ‘€ βœ…
William F. Broderick
William F. Broderick

βœ…
Jesse Mostipak
Jesse Mostipak

βœ…
Maria Knorps
Maria Knorps

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

πŸ’» πŸ‘€
Moritz E. Beber
Moritz E. Beber

πŸ’» βœ…
Jackson Burns
Jackson Burns

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

πŸ’» πŸ‘€ βœ…
h-vetinari
h-vetinari

πŸ’» πŸ‘€ βœ…
Ivan Ogasawara
Ivan Ogasawara

πŸ’» πŸ‘€ βœ…
Tom Russell
Tom Russell

πŸ’» πŸ‘€ βœ…
C. Titus Brown
C. Titus Brown

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

πŸ’» πŸ‘€
miguelalizo
miguelalizo

πŸ’» πŸ‘€
nyeshlur
nyeshlur

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

πŸ’» πŸ‘€
Pat Tressel
Pat Tressel

πŸ’» πŸ‘€

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

About

scientific Python package recommendations & guidance curated by pyOpenSci

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 55.4%
  • Python 41.3%
  • JavaScript 3.3%