Skip to content

Commit ed1341e

Browse files
microbit-matt-hillsdonmicrobit-matt-hillsdon
authored
Add docs for when repo is public (#78)
1 parent 53df7e0 commit ed1341e

File tree

3 files changed

+276
-10
lines changed

3 files changed

+276
-10
lines changed

‎CONTRIBUTING.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Thanks for looking here! We'd love your help. The micro:bit project is only
2+
possible through contributions of companies and individuals around the world.
3+
4+
This project is managed on GitHub:
5+
6+
https://github.com/microbit-foundation/micropython-microbit-stubs
7+
8+
If you find a problem with these stubs then please file an issue to discuss it.
9+
If possible please include Python code (as text, not a screenshot) that
10+
demonstrates the issue. If a tool gave you an unexpected error message when
11+
using these stubs them please include it along with the name and version of the
12+
tool.
13+
14+
Pull requests are welcome. We'll need to ensure that changes work well with
15+
the micro:bit Python Editor and, if they affect translated text, that they
16+
don't cause an amount re-translation work that's disproportionate to the
17+
benefit of the change.
18+
19+
The project uses [Black](https://black.readthedocs.io/en/stable/) to format
20+
Python code so please check out their documentation and set it up with your
21+
code editor.

‎LICENSE.md

+236
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,236 @@
1+
The builtins module and utility definitions are derived from [typeshed](https://github.com/python/typeshed). These have been modified by Micro:bit Educational Foundation to adapt them for MicroPython for micro:bit. Typeshed is Apache 2.0 licensed and our modifications are under the same license.
2+
3+
MicroPython and micro:bit stubs are derived from the restructured text documentation for [micro:bit](https://github.com/bbcmicrobit/micropython/tree/v2-docs) and, where not otherwise covered in micro:bit-specific docs, [MicroPython](https://github.com/micropython/micropython/tree/master/docs/library). MicroPython is MIT Licensed and Copyright (c) 2013-2021 Damien P. George.
4+
MicroPython for the micro:bit is MIT licensed and Copyright (c) 2013-2016 The MicroPython-on-micro:bit Developers (see [the authors file](https://github.com/bbcmicrobit/micropython/blob/v2-docs/AUTHORS)). These stub files are available under the same MIT license.
5+
6+
Both licenses are reproduced in full below.
7+
8+
= = = = =
9+
10+
Apache License
11+
Version 2.0, January 2004
12+
http://www.apache.org/licenses/
13+
14+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
15+
16+
1. Definitions.
17+
18+
"License" shall mean the terms and conditions for use, reproduction,
19+
and distribution as defined by Sections 1 through 9 of this document.
20+
21+
"Licensor" shall mean the copyright owner or entity authorized by
22+
the copyright owner that is granting the License.
23+
24+
"Legal Entity" shall mean the union of the acting entity and all
25+
other entities that control, are controlled by, or are under common
26+
control with that entity. For the purposes of this definition,
27+
"control" means (i) the power, direct or indirect, to cause the
28+
direction or management of such entity, whether by contract or
29+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
30+
outstanding shares, or (iii) beneficial ownership of such entity.
31+
32+
"You" (or "Your") shall mean an individual or Legal Entity
33+
exercising permissions granted by this License.
34+
35+
"Source" form shall mean the preferred form for making modifications,
36+
including but not limited to software source code, documentation
37+
source, and configuration files.
38+
39+
"Object" form shall mean any form resulting from mechanical
40+
transformation or translation of a Source form, including but
41+
not limited to compiled object code, generated documentation,
42+
and conversions to other media types.
43+
44+
"Work" shall mean the work of authorship, whether in Source or
45+
Object form, made available under the License, as indicated by a
46+
copyright notice that is included in or attached to the work
47+
(an example is provided in the Appendix below).
48+
49+
"Derivative Works" shall mean any work, whether in Source or Object
50+
form, that is based on (or derived from) the Work and for which the
51+
editorial revisions, annotations, elaborations, or other modifications
52+
represent, as a whole, an original work of authorship. For the purposes
53+
of this License, Derivative Works shall not include works that remain
54+
separable from, or merely link (or bind by name) to the interfaces of,
55+
the Work and Derivative Works thereof.
56+
57+
"Contribution" shall mean any work of authorship, including
58+
the original version of the Work and any modifications or additions
59+
to that Work or Derivative Works thereof, that is intentionally
60+
submitted to Licensor for inclusion in the Work by the copyright owner
61+
or by an individual or Legal Entity authorized to submit on behalf of
62+
the copyright owner. For the purposes of this definition, "submitted"
63+
means any form of electronic, verbal, or written communication sent
64+
to the Licensor or its representatives, including but not limited to
65+
communication on electronic mailing lists, source code control systems,
66+
and issue tracking systems that are managed by, or on behalf of, the
67+
Licensor for the purpose of discussing and improving the Work, but
68+
excluding communication that is conspicuously marked or otherwise
69+
designated in writing by the copyright owner as "Not a Contribution."
70+
71+
"Contributor" shall mean Licensor and any individual or Legal Entity
72+
on behalf of whom a Contribution has been received by Licensor and
73+
subsequently incorporated within the Work.
74+
75+
2. Grant of Copyright License. Subject to the terms and conditions of
76+
this License, each Contributor hereby grants to You a perpetual,
77+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78+
copyright license to reproduce, prepare Derivative Works of,
79+
publicly display, publicly perform, sublicense, and distribute the
80+
Work and such Derivative Works in Source or Object form.
81+
82+
3. Grant of Patent License. Subject to the terms and conditions of
83+
this License, each Contributor hereby grants to You a perpetual,
84+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
85+
(except as stated in this section) patent license to make, have made,
86+
use, offer to sell, sell, import, and otherwise transfer the Work,
87+
where such license applies only to those patent claims licensable
88+
by such Contributor that are necessarily infringed by their
89+
Contribution(s) alone or by combination of their Contribution(s)
90+
with the Work to which such Contribution(s) was submitted. If You
91+
institute patent litigation against any entity (including a
92+
cross-claim or counterclaim in a lawsuit) alleging that the Work
93+
or a Contribution incorporated within the Work constitutes direct
94+
or contributory patent infringement, then any patent licenses
95+
granted to You under this License for that Work shall terminate
96+
as of the date such litigation is filed.
97+
98+
4. Redistribution. You may reproduce and distribute copies of the
99+
Work or Derivative Works thereof in any medium, with or without
100+
modifications, and in Source or Object form, provided that You
101+
meet the following conditions:
102+
103+
(a) You must give any other recipients of the Work or
104+
Derivative Works a copy of this License; and
105+
106+
(b) You must cause any modified files to carry prominent notices
107+
stating that You changed the files; and
108+
109+
(c) You must retain, in the Source form of any Derivative Works
110+
that You distribute, all copyright, patent, trademark, and
111+
attribution notices from the Source form of the Work,
112+
excluding those notices that do not pertain to any part of
113+
the Derivative Works; and
114+
115+
(d) If the Work includes a "NOTICE" text file as part of its
116+
distribution, then any Derivative Works that You distribute must
117+
include a readable copy of the attribution notices contained
118+
within such NOTICE file, excluding those notices that do not
119+
pertain to any part of the Derivative Works, in at least one
120+
of the following places: within a NOTICE text file distributed
121+
as part of the Derivative Works; within the Source form or
122+
documentation, if provided along with the Derivative Works; or,
123+
within a display generated by the Derivative Works, if and
124+
wherever such third-party notices normally appear. The contents
125+
of the NOTICE file are for informational purposes only and
126+
do not modify the License. You may add Your own attribution
127+
notices within Derivative Works that You distribute, alongside
128+
or as an addendum to the NOTICE text from the Work, provided
129+
that such additional attribution notices cannot be construed
130+
as modifying the License.
131+
132+
You may add Your own copyright statement to Your modifications and
133+
may provide additional or different license terms and conditions
134+
for use, reproduction, or distribution of Your modifications, or
135+
for any such Derivative Works as a whole, provided Your use,
136+
reproduction, and distribution of the Work otherwise complies with
137+
the conditions stated in this License.
138+
139+
5. Submission of Contributions. Unless You explicitly state otherwise,
140+
any Contribution intentionally submitted for inclusion in the Work
141+
by You to the Licensor shall be under the terms and conditions of
142+
this License, without any additional terms or conditions.
143+
Notwithstanding the above, nothing herein shall supersede or modify
144+
the terms of any separate license agreement you may have executed
145+
with Licensor regarding such Contributions.
146+
147+
6. Trademarks. This License does not grant permission to use the trade
148+
names, trademarks, service marks, or product names of the Licensor,
149+
except as required for reasonable and customary use in describing the
150+
origin of the Work and reproducing the content of the NOTICE file.
151+
152+
7. Disclaimer of Warranty. Unless required by applicable law or
153+
agreed to in writing, Licensor provides the Work (and each
154+
Contributor provides its Contributions) on an "AS IS" BASIS,
155+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
156+
implied, including, without limitation, any warranties or conditions
157+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
158+
PARTICULAR PURPOSE. You are solely responsible for determining the
159+
appropriateness of using or redistributing the Work and assume any
160+
risks associated with Your exercise of permissions under this License.
161+
162+
8. Limitation of Liability. In no event and under no legal theory,
163+
whether in tort (including negligence), contract, or otherwise,
164+
unless required by applicable law (such as deliberate and grossly
165+
negligent acts) or agreed to in writing, shall any Contributor be
166+
liable to You for damages, including any direct, indirect, special,
167+
incidental, or consequential damages of any character arising as a
168+
result of this License or out of the use or inability to use the
169+
Work (including but not limited to damages for loss of goodwill,
170+
work stoppage, computer failure or malfunction, or any and all
171+
other commercial damages or losses), even if such Contributor
172+
has been advised of the possibility of such damages.
173+
174+
9. Accepting Warranty or Additional Liability. While redistributing
175+
the Work or Derivative Works thereof, You may choose to offer,
176+
and charge a fee for, acceptance of support, warranty, indemnity,
177+
or other liability obligations and/or rights consistent with this
178+
License. However, in accepting such obligations, You may act only
179+
on Your own behalf and on Your sole responsibility, not on behalf
180+
of any other Contributor, and only if You agree to indemnify,
181+
defend, and hold each Contributor harmless for any liability
182+
incurred by, or claims asserted against, such Contributor by reason
183+
of your accepting any such warranty or additional liability.
184+
185+
END OF TERMS AND CONDITIONS
186+
187+
APPENDIX: How to apply the Apache License to your work.
188+
189+
To apply the Apache License to your work, attach the following
190+
boilerplate notice, with the fields enclosed by brackets "{}"
191+
replaced with your own identifying information. (Don't include
192+
the brackets!) The text should be enclosed in the appropriate
193+
comment syntax for the file format. We also recommend that a
194+
file or class name and description of purpose be included on the
195+
same "printed page" as the copyright notice for easier
196+
identification within third-party archives.
197+
198+
Copyright {yyyy} {name of copyright owner}
199+
200+
Licensed under the Apache License, Version 2.0 (the "License");
201+
you may not use this file except in compliance with the License.
202+
You may obtain a copy of the License at
203+
204+
http://www.apache.org/licenses/LICENSE-2.0
205+
206+
Unless required by applicable law or agreed to in writing, software
207+
distributed under the License is distributed on an "AS IS" BASIS,
208+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
209+
See the License for the specific language governing permissions and
210+
limitations under the License.
211+
212+
= = = = =
213+
214+
The MIT License
215+
216+
Copyright (c) 2013-2021 Damien P. George, 2013-2016 The MicroPython-on-micro:bit Developers, 2022 Micro:bit Education Foundation
217+
218+
Permission is hereby granted, free of charge, to any person obtaining a
219+
copy of this software and associated documentation files (the "Software"),
220+
to deal in the Software without restriction, including without limitation
221+
the rights to use, copy, modify, merge, publish, distribute, sublicense,
222+
and/or sell copies of the Software, and to permit persons to whom the
223+
Software is furnished to do so, subject to the following conditions:
224+
225+
The above copyright notice and this permission notice shall be included in
226+
all copies or substantial portions of the Software.
227+
228+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
229+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
230+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
231+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
232+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
233+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
234+
DEALINGS IN THE SOFTWARE.
235+
236+
= = = = =

‎README.md

+19-10
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# micro:bit MicroPython stubs for editor support
22

3-
The easiest way to try these type stubs is to use the online [micro:bit Python Editor](https://python.microbit.org) which bundles them.
3+
This project contains Python stub files for [MicroPython for micro:bit V2](https://github.com/microbit-foundation/micropython-microbit-v2).
4+
5+
The easiest way to try these type stubs is to use the online [micro:bit Python Editor](https://python.microbit.org) which uses them for its code intelligence features and the API documentation.
46

57
## Translations
68

@@ -17,16 +19,10 @@ We translate:
1719
- The API name, e.g. function name, with underscores replaced with spaces to make clear it's a hint not the actual name. This is displayed alongside the English API name.
1820
- Parameter names (again with underscores replaced). These are displayed alongside the English parameter name.
1921

20-
## Credit and licensing
21-
22-
builtins and utility definitions are derived from [typeshed](https://github.com/python/typeshed). These stubs don't provide documentation, though we'd love to add it in future.
23-
24-
MicroPython and micro:bit stubs are based on the restructured text documentation for [micro:bit](https://github.com/bbcmicrobit/micropython/tree/v2-docs) and, where not otherwise covered in micro:bit-specific docs, [MicroPython](https://github.com/micropython/micropython/tree/master/docs/library). These stubs provide documentation.
22+
## Licensing
2523

26-
Typeshed is Apache 2.0 licensed.
27-
28-
MicroPython is MIT Licensed and Copyright (c) 2013-2021 Damien P. George.
29-
MicroPython for the micro:bit is MIT licensed and Copyright (c) 2013-2016 The MicroPython-on-micro:bit Developers (see [the authors file](https://github.com/bbcmicrobit/micropython/blob/v2-docs/AUTHORS)).
24+
These stubs are MIT or Apache 2.0 licensed depending on their origin (typeshed or MicroPython).
25+
See [LICENSING.md](./LICENSING.md) for details.
3026

3127
## Scripts
3228

@@ -35,3 +31,16 @@ MicroPython for the micro:bit is MIT licensed and Copyright (c) 2013-2016 The Mi
3531
## Testing
3632

3733
The stubs are tested against the code in the `examples/` folder using Pyright. To run the tests locally run `npm install` to install Pyright and then `npm test`.
34+
35+
## Code of Conduct
36+
37+
Trust, partnership, simplicity and passion are our core values we live and
38+
breathe in our daily work life and within our projects. Our open-source
39+
projects are no exception. We have an active community which spans the globe
40+
and we welcome and encourage participation and contributions to our projects
41+
by everyone. We work to foster a positive, open, inclusive and supportive
42+
environment and trust that our community respects the micro:bit code of
43+
conduct. Please see our [code of conduct](https://microbit.org/safeguarding/)
44+
which outlines our expectations for all those that participate in our
45+
community and details on how to report any concerns and what would happen
46+
should breaches occur.

0 commit comments

Comments
 (0)