From 54cd6e3e4bb45f5ff649e3d31521f9a78015fb6b Mon Sep 17 00:00:00 2001 From: Paul Sokolovsky Date: Wed, 13 Dec 2017 00:12:37 +0200 Subject: [PATCH] docs/packages: Add quick "Creating distribution packages" section. Needs more details. --- docs/reference/packages.rst | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/reference/packages.rst b/docs/reference/packages.rst index 28f5f9f487..d8d198e628 100644 --- a/docs/reference/packages.rst +++ b/docs/reference/packages.rst @@ -199,6 +199,32 @@ Few notes: you may want to decrease the amount of frozen modules included. +Creating distribution packages +------------------------------ + +Distribution packages for MicroPython are created in the same manner +as for CPython or any other Python implementation, see references at +the end of chapter. "Source distribution" (sdist) format is used for +packaging. The post-processing discussed above, (and pre-processing +discussed in the following section) is achieved by using custom +"sdist" command for distutils/setuptools. Thus, packaging steps +remain the same as for standard distutils/setuptools, the user just +need to override "sdist" command implementation by passing the +appropriate argument to ``setup()`` call:: + + from setuptools import setup + import sdist_upip + + setup( + ..., + cmdclass={'sdist': sdist_upip.sdist} + ) + +The sdist_upip.py module as referenced above can be found in +`micropython-lib`: +https://github.com/micropython/micropython-lib/blob/master/sdist_upip.py + + Application resources ---------------------