*****************
Tutorial Schedule
*****************

Outline
=======

How are we spending our afternoon?

Agenda
------

* 0:00-0:20 Getting setup and overview of packaging
* 0:20-0:45 python packages: the setup.py file
*  **Break**
* 1:00-1:30 Building and uploading to PyPI
* 1:30-2:00 Binaries and dependencies
* 2:00-2:45 Exercises
* **Break**
* 3:00-3:15 Conda-build overview
* 3:15-3:45 Exercise
* 3:45-4:00 conda-forge

0:00-00:10 Getting setup for this Tutorial
------------------------------------------

There is a repo for this tutorial here:

https://github.com/python-packaging-tutorial/python-packaging-tutorial

or:

http://bit.ly/JoyOfPackaging

And the materials are rendered as html here:

https://python-packaging-tutorial.github.io/python-packaging-tutorial/

(linked from the git repo)

Clone that repo now -- so you can follow along.

``git clone https://github.com/python-packaging-tutorial/python-packaging-tutorial.git``

0:10-00:20 Overview of packaging
--------------------------------

.. ifnotslides::

  :ref:`overview`

* What is a package, anyway?
* Source/binary
* Wheel vs conda packages
* PyPI/anaconda.org


0:20-0:45 python packages: the setup.py file
--------------------------------------------

.. ifnotslides::

  :ref:`setup`


* Python packages -- what are they?
* The setup.py file
* Specifying requirements
* When and how to "pin" requirements
* Let's make a package!


0:45-1:00 Building and uploading to PyPI
----------------------------------------

.. ifnotslides::

  :ref:`uploading`

* Packaging Terminology 101
* Building and publishing a python distribution


1:00-1:10 Break
---------------

1:10-1:30 Exercises
-------------------

* Prepare environment.
* Build source distribution and wheel.
* Publish artifacts on PyPI.


1:30-2:00 Binaries and dependencies
-----------------------------------

.. ifnotslides::

  :ref:`binaries`

* Why we build Python packages with native binaries: 1)
  **performance** and 2) **library integration**
* Different components of the binary build process and their role:
  *headers, libraries, compilers, linkers, build systems, system introspection
  tools, package managers*
* Basic requirements for binary compatibility: a) **C-runtime library
  compatibility** and b) **shared library compatibilty**
* Joyous tools: **scikit-build**'s role in coordinating components of the binary
  build process and **conda**'s role in resolving dependencies and creating compatible platform binaries

2:00-2:45 Exercises
-------------------

* Build a Python package with a C++-based C-extension.
* Build a Python package with a Cython-based C-extension.
* Build a distributable Linux wheel package.


2:45-3:00 Break
---------------


3:00-3:15 Conda-build overview
------------------------------

.. ifnotslides::

  :ref:`conda_build`


3:15-3:30 Exercises
-------------------

* Write a conda recipe for the sample package from previous exercises (pure python)
* noarch packages
* Upload to anaconda cloud


3:30-3:45 Exercises
-------------------

* Recipe for package with compiled extensions
* Add compiled extension (source will be provided to students) to sample package
* Modify recipe, if needed
* Rebuild the package
* Version pinning (python, numpy)
* Split packages - multi-ecosystem ones
* Compiler packages + pin_downstream
* Interoperation with scikit-build


3:45-4:00 Automated building with cloud-based CI services
---------------------------------------------------------


**conda-forge** (optional; as time allows)

CI service overview & Conda-forge -- what are the pieces and how do they fit together?

* Recipe format
* staged-recipes
* feedstocks
* Re-rendering and conda-smithy
* Updating package when new version released
* Future direction/community needs
* Invitation to sprints
* Contributing to Conda-forge
* Intro to conda-forge: staged-recipes, maintainer role, contributing to an existing package
* conda-smithy lint/rerender
* Example to go from the conda-skeleton to a PR on staged-recipes
* Comment on some special cases: cython extensions,  non-python pkgs, the use of the CIs, etc.
* Exercise: put a package on staged-recipes