djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
main
circuitpython/README.rst-stubs

30 lines
1.6 KiB
Plaintext
Raw Permalink Normal View History

refine stubs-building procedure * so that excess files are not included in sdist, perform build down in circuitpython-stubs * This means we need to * Remove the need-pypi check * Copy a setup.py, README, and MANIFEST.in into the stubs build location * Revamp how the overall `mypy --strict` check lists its inputs * Add a new test that actually installing the stubs lets us do type checking (tools/test-stubs.sh) * Add a missing return type to a __init__ function (why was this not an error under `mypy --strict`, I wonder)
2021-06-22 09:59:05 -04:00
CircuitPython
=============
.. image:: https://s3.amazonaws.com/adafruit-circuit-python/CircuitPython_Repo_header_logo.png
|Build Status| |Doc Status| |License| |Discord| |Weblate|
`circuitpython.org <https://circuitpython.org>`__ \| `Get CircuitPython <#get-circuitpython>`__ \|
`Documentation <#documentation>`__ \| `Contributing <#contributing>`__ \|
`Branding <#branding>`__ \| `Differences from Micropython <#differences-from-micropython>`__ \|
`Project Structure <#project-structure>`__
**CircuitPython** is a *beginner friendly*, open source version of Python for tiny, inexpensive
Actually reduce the README text for the stubs package
2021-06-24 14:37:09 -04:00
computers called microcontrollers.
refine stubs-building procedure * so that excess files are not included in sdist, perform build down in circuitpython-stubs * This means we need to * Remove the need-pypi check * Copy a setup.py, README, and MANIFEST.in into the stubs build location * Revamp how the overall `mypy --strict` check lists its inputs * Add a new test that actually installing the stubs lets us do type checking (tools/test-stubs.sh) * Add a missing return type to a __init__ function (why was this not an error under `mypy --strict`, I wonder)
2021-06-22 09:59:05 -04:00
Actually reduce the README text for the stubs package
2021-06-24 14:37:09 -04:00
This package contains the "stubs", or type definitions for CircuitPython. With some advanced
editors and other tools, this information can be identify TypeErrors, AttributeErrors, and other
problems before you deploy your code to a device and can even help autocomplete your code.
refine stubs-building procedure * so that excess files are not included in sdist, perform build down in circuitpython-stubs * This means we need to * Remove the need-pypi check * Copy a setup.py, README, and MANIFEST.in into the stubs build location * Revamp how the overall `mypy --strict` check lists its inputs * Add a new test that actually installing the stubs lets us do type checking (tools/test-stubs.sh) * Add a missing return type to a __init__ function (why was this not an error under `mypy --strict`, I wonder)
2021-06-22 09:59:05 -04:00
.. |Build Status| image:: https://github.com/adafruit/circuitpython/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/circuitpython/actions?query=branch%3Amain
.. |Doc Status| image:: https://readthedocs.org/projects/circuitpython/badge/?version=latest
:target: http://circuitpython.readthedocs.io/
.. |Discord| image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
.. |License| image:: https://img.shields.io/badge/License-MIT-brightgreen.svg
:target: https://choosealicense.com/licenses/mit/
.. |Weblate| image:: https://hosted.weblate.org/widgets/circuitpython/-/svg-badge.svg
:target: https://hosted.weblate.org/engage/circuitpython/?utm_source=widget
Reference in New Issue Copy Permalink