diff --git a/docs/changelog.rst b/docs/changelog.rst index a109d6c..8e77206 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -3,6 +3,11 @@ Change log .. currentmodule:: picozero +0.0.2 - 2022-03-31 +~~~~~~~~~~~~~~~~~~ + ++ Bug fixes and documentation updates + 0.0.1 - 2022-03-21 ~~~~~~~~~~~~~~~~~~ diff --git a/docs/conf.py b/docs/conf.py index d4bb81a..9efe805 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -45,7 +45,7 @@ def __getattr__(cls, name): author = 'Raspberry Pi Foundation' # The full version, including alpha/beta/rc tags -release = '0.0.0' +release = '0.0.2' # -- General configuration --------------------------------------------------- diff --git a/docs/developing.rst b/docs/developing.rst index 8ae012c..d18bbf8 100644 --- a/docs/developing.rst +++ b/docs/developing.rst @@ -6,14 +6,22 @@ Instructions on how build and deploy picozero. Build ----- -1. Run `setup.py` and create a source distribution.: +1. Update version numbers in the ``setup.py``, ``picozero/__init__.py``and ``docs/conf.py`` files. + +2. Add release to ``docs/changelog.rst`` + +3. Run `setup.py` and create a source distribution.: python3 setup.py sdist -2. Upload to PyPI: +4. Upload to PyPI: twine upload dist/* +5. Push all change to ``master`` branch + +6. Create a release in github and upload picozero-*.tar.gz to the release. + Documentation ------------- diff --git a/picozero/__init__.py b/picozero/__init__.py index c79179c..cb4067c 100644 --- a/picozero/__init__.py +++ b/picozero/__init__.py @@ -1,3 +1,8 @@ +__name__ = "picozero" +__package__ = "picozero" +__version__ = '0.0.2' +__author__ = "Raspberry Pi Foundation" + from .picozero import ( PWMChannelAlreadyInUse, diff --git a/setup.py b/setup.py index 720e15d..e53a08a 100644 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ __project__ = 'picozero' __packages__ = ['picozero'] __desc__ = 'A beginner-friendly library for using common electronics components with the Raspberry Pi Pico. Not yet for general release.' -__version__ = '0.0.1' +__version__ = '0.0.2' __author__ = "Raspberry Pi Foundation" __author_email__ = 'learning@raspberrypi.org' __license__ = 'MIT' @@ -38,7 +38,7 @@ setup( name=__project__, version=__version__, - description=__version__, + description=__desc__, long_description=__long_description__, long_description_content_type='text/markdown', url=__url__,