Merge pull request #43 from RaspberryPiFoundation/dev

v0.1.0

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+web@raspberrypi.org.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

.github/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing
+
+Contributions to the picozero are welcome. Here is some advice.
+
+1. picozero is 'lightweight', it is designed to be easy to use but also needs to run on a micro controller, please take this into account when considering feature requests or raising issues.
+2. see below for other stuff!
+
+# Status
+
+picozero is currently in Beta, pre release 1.0, you should consider the following:
+
+- The API is not yet set, however, this doesn't mean that backwards compatibility is not important! It is a balancing act.
+- Requests for new features will need to be prioritised and responses to feature requests may take some time.
+- Refactoring of the code base is very likely and as a result pull requests may need rework.
+- Issues are likely to exist within the code base, be kind!
+
+# Suggestions
+
+If you have an idea for a new feature or would like to see a device included in picozero, please raise an [issue](https://github.com/RaspberryPiFoundation/picozero/issues). Please explain your reasoning clearly.
+
+# Bugs 
+
+Please raise an [issue](https://github.com/RaspberryPiFoundation/picozero/issues) for any bugs found. Please include code examples and circuit diagrams if appropriate. 
+
+# Pull requests
+
+All pull requests should be based on the [dev](https://github.com/RaspberryPiFoundation/picozero/tree/dev) branch of picozero. 
+

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behaviour:
+1. Setup this device like this '...'
+2. Run this code '....'
+3. This thing occurred '...'
+4. This error was reported '...'
+
+Please include code in code blocks e.g.
+
+```python
+print("picozero")
+```
+
+**Expected behaviour**
+A clear and concise description of what you expected to happen.
+
+**System information:**
+ - OS: [e.g. Windows]
+ - Development environment [e.g. Thonny]
+ - picozero version: [available in `/Lib/picozero/__init__.py`]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this picozero
+title: ''
+labels: nice to have
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

README.rst

@@ -1,6 +1,8 @@
 picozero
 ========
 
+|pypibadge| |docsbadge|
+
 A beginner-friendly library for using common electronics components with the Raspberry Pi Pico.
 
 .. code-block:: python
@@ -19,9 +21,9 @@ A beginner-friendly library for using common electronics components with the Ras
 Status
 ------
 
-Pre-alpha - not yet for general release. Documentation is not yet available. There will be many bugs and issues.
+Beta. There will be bugs and issues. API changes are likely.
 
-Full documentation will be available at `picozero.readthedocs.io <https://picozero.readthedocs.io>`_ :
+Documentation is available at `picozero.readthedocs.io <https://picozero.readthedocs.io>`_ :
 
 - `Installation and getting started guide <https://picozero.readthedocs.io/en/latest/gettingstarted.html>`_
 - `Recipes and how-to's <https://picozero.readthedocs.io/en/latest/recipes.html>`_
@@ -32,3 +34,10 @@ Notes
 
 picozero is inspired by `gpiozero <https://gpiozero.readthedocs.io/en/stable/>`_ (and reuses some of its underlying structure), but is by design lighter weight and aligned with the Raspberry Pi Pico. Thank you to everyone who has contributed to the gpiozero project.
 
+.. |pypibadge| image:: https://badge.fury.io/py/picozero.svg
+   :target: https://badge.fury.io/py/picozero
+   :alt: Latest Version
+
+.. |docsbadge| image:: https://readthedocs.org/projects/picozero/badge/
+   :target: https://readthedocs.org/projects/picozero/
+   :alt: Docs

docs/api.rst

@@ -56,6 +56,21 @@ Speaker
     :inherited-members:
     :members: 
 
+
+DigitalOutputDevice
+-------------------
+.. autoclass:: DigitalOutputDevice
+    :show-inheritance:
+    :inherited-members:
+    :members:
+
+PWMOutputDevice
+---------------
+.. autoclass:: PWMOutputDevice
+    :show-inheritance:
+    :inherited-members:
+    :members:
+
 Button
 ------
 
@@ -87,3 +102,11 @@ TemperatureSensor
     :show-inheritance:
     :inherited-members:
     :members: 
+
+DigitalInputDevice
+------------------
+
+.. autoclass:: DigitalInputDevice
+    :show-inheritance:
+    :inherited-members:
+    :members: 

docs/changelog.rst

@@ -3,6 +3,13 @@ Change log
 
 .. currentmodule:: picozero
 
+0.1.0 - 2022-04-08
+~~~~~~~~~~~~~~~~~~
+
++ Beta release
++ Documentation updates
++ Minor bug fixes and refactoring
+
 0.0.2 - 2022-03-31
 ~~~~~~~~~~~~~~~~~~
 

docs/conf.py

@@ -14,6 +14,7 @@
 import sys
 # sys.path.insert(0, os.path.abspath('.'))
 sys.path.insert(0, os.path.join(os.path.dirname(__file__), '..'))
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 
 # Mock out certain modules while building documentation
 class Mock:
@@ -45,7 +46,7 @@ def __getattr__(cls, name):
 author = 'Raspberry Pi Foundation'
 
 # The full version, including alpha/beta/rc tags
-release = '0.0.2'
+release = '0.1.0'
 
 
 # -- General configuration ---------------------------------------------------
@@ -73,7 +74,23 @@ def __getattr__(cls, name):
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+if on_rtd:
+    html_theme = 'sphinx_rtd_theme'
+    #html_theme_options = {}
+    html_sidebars = {
+        '**': [
+            'globaltoc.html',
+            'relations.html',
+            'searchbox.html',
+        ],
+    }
+else:
+    html_theme = 'alabaster'
+    #html_theme_options = {}
+    #html_sidebars = {}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/contributing.rst

@@ -0,0 +1,34 @@
+Contributing
+============
+
+Contributions to the picozero are welcome. Here is some advice.
+
+1. picozero is 'lightweight', it is designed to be easy to use but also needs to run on a micro controller, please take this into account when considering feature requests or raising issues.
+2. see below for other stuff!
+
+Status
+------
+
+picozero is currently in Beta, pre release 1.0, you should consider the following:
+
+- The API is not yet set, however, this doesn't mean that backwards compatibility is not important! It is a balancing act.
+- Requests for new features will need to be prioritised and responses to feature requests may take some time.
+- Refactoring of the code base is very likely and as a result pull requests may need rework.
+- Issues are likely to exist within the code base, be kind!
+
+Suggestions
+-----------
+
+If you have an idea for a new feature or would like to see a device included in picozero, please raise an `issue`_. Please explain your reasoning clearly.
+
+Bugs 
+----
+
+Please raise an `issue`_ for any bugs found. Please include code examples and circuit diagrams if appropriate. 
+
+Pull requests
+-------------
+
+All pull requests should be based on the `dev <https://github.com/RaspberryPiFoundation/picozero/tree/dev>`_ branch of picozero. 
+
+.. _issue: https://github.com/RaspberryPiFoundation/picozero/issues