stubber.publish.package
=======================

.. py:module:: stubber.publish.package

.. autoapi-nested-parse::

   prepare a set of stub files for publishing to PyPi



Functions
---------

.. autoapisummary::

   stubber.publish.package.package_name
   stubber.publish.package.get_package
   stubber.publish.package.get_package_info
   stubber.publish.package.create_package
   stubber.publish.package.combo_sources


Module Contents
---------------

.. py:function:: package_name(*, port: str = '', board: str = '', family: str = 'micropython', **kwargs) -> str

   generate a package name for the given package type


.. py:function:: get_package(db_conn: sqlite3.Connection, *, version: str, port: str, board: str = GENERIC_L, family: str = 'micropython') -> stubber.publish.stubpackage.StubPackage

   Get the package from the database or create a new one if it does not exist.


.. py:function:: get_package_info(db_conn: sqlite3.Connection, 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 on the package name and version
       pkg_name: package name (micropython-esp32-stubs)
       mpy_version: micropython/firmware version (1.18)


.. py:function:: create_package(pkg_name: str, mpy_version: str, *, port: str, board: str = '', family: str = 'micropython') -> stubber.publish.stubpackage.StubPackage

   create and initialize a package with the correct sources


.. py:function:: combo_sources(family: str, port: str, board: str, ver_flat: str) -> stubber.publish.stubpackage.StubSources

   Build a source set for combo stubs