stubber.publish.package

prepare a set of stub files for publishing to PyPi

Module Contents

Functions

package_name(→ str)

generate a package name for the given package type

get_package_info(→ Union[Dict, None])

get a package's record from the json db if it can be found

create_package(→ stubber.publish.stubpacker.StubPackage)

create and initialize a package with the correct sources
stubber.publish.package.package_name(pkg_type, port: str = '', board: str = '', family='micropython', **kwargs) → str

generate a package name for the given package type

Parameters

  • port (str) –

  • board (str) –

Return type

str

stubber.publish.package.get_package_info(db: pysondb.PysonDB, pub_path: pathlib.Path, *, pkg_name: str, mpy_version: str) → Union[Dict, None]

get a package’s record from the json db if it can be found matches om the package name and version

pkg_name: package name (micropython-esp32-stubs) mpy_version: micropython/firmware version (1.18)

Parameters

  • db (pysondb.PysonDB) –

  • pub_path (pathlib.Path) –

  • pkg_name (str) –

  • mpy_version (str) –

Return type

Union[Dict, None]

stubber.publish.package.create_package(pkg_name: str, mpy_version: str, *, port: str = '', board: str = '', family: str = 'micropython', pkg_type=COMBO_STUBS) → stubber.publish.stubpacker.StubPackage

create and initialize a package with the correct sources

Parameters

  • pkg_name (str) –

  • mpy_version (str) –

  • port (str) –

  • board (str) –

  • family (str) –

Return type

stubber.publish.stubpacker.StubPackage