Packaging and Distribution Lesson

This repository contains a lesson on software packaging and distribution, based in Python.

It was initially written by Henry Schreiner and Kyle Niemeyer during the INTERSECT RSE Workshop held in August 2022 at Princeton University.

This repository builds a website that is live here.

You can build this website with the following commands if you use rbenv:

rbenv install 3.1.2  # Build Ruby 3.1.2 from source
rbenv local 3.1.2  # Use Ruby 3.1.2 in this folder
bundle install  # Install all the Ruby requirements for Jekyll
bundle exec jekyll serve  # build and serve the website

Contributing

We welcome all contributions to improve the lesson! Maintainers will do their best to help you if you have any questions, concerns, or experience any difficulties along the way.

Please see the current list of issues for ideas for contributing to this repository. For making your contribution, we use the GitHub flow, which is nicely explained in the chapter Contributing to a Project in Pro Git by Scott Chacon. Look for the tag . This indicates that the maintainers will welcome a pull request fixing this issue.

If you contribute to this lesson and would like to acknowledge specific funding support, please add it to the Funding section of the README below.

Author(s)

The contributing author(s) to this lesson are:

• Henry Schreiner
• Kyle Niemeyer
• John G. Holland
• George Dang
• Maria Isabel Restrepo

Maintainer(s)

Henry Schreiner

If you would like to serve as a maintainer please contact us.

Citation

To cite this lesson, please consult with CITATION.cff.

Funding

The INTERSECT project is supported by NSF awards 2017424 and 2017259.