SciWork 2020 Packaging Tutorial

This tutorial walks you through how to package a simple Python project. It will show you how to add the necessary files and structure to create the package, how to build the package, and how to upload it to a package index (such as PyPI).

Contents

• Set up a Development Environment
  • Install development tools
  • Register an account on Test PyPI
  • Put code in a directory
• Describe the project
  • Creating README.md
  • Creating pyproject.toml
  • Creating setup.cfg
  • Creating setup.py
• Distribute the Project
  • Build the distributions
  • Upload the distributions
  • Test package installation
  • Optional: Release your package to PyPI.org
• Distribute a Conda Package
  • Creating meta.yaml
  • Creating build scripts
  • Building the package
  • Testing the Conda package
  • Optional: Building for a different Python version
  • Optional: Converting a package for use on all platforms
  • Optional: Uploading to Anaconda.org
• Distribute Private Projects
  • Custom Conda channels
  • “Find-links” pages
  • devpi
• Further Guides

Indices and tables

• Index
• Module Index
• Search Page