adafruit-circuitpython-rfm 1.0.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. adafruit_circuitpython_rfm-1.0.4/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md +13 -0
  2. adafruit_circuitpython_rfm-1.0.4/.github/workflows/build.yml +14 -0
  3. adafruit_circuitpython_rfm-1.0.4/.github/workflows/failure-help-text.yml +19 -0
  4. adafruit_circuitpython_rfm-1.0.4/.github/workflows/release_gh.yml +19 -0
  5. adafruit_circuitpython_rfm-1.0.4/.github/workflows/release_pypi.yml +19 -0
  6. adafruit_circuitpython_rfm-1.0.4/.pre-commit-config.yaml +21 -0
  7. adafruit_circuitpython_rfm-1.0.4/.readthedocs.yaml +22 -0
  8. adafruit_circuitpython_rfm-1.0.4/CODE_OF_CONDUCT.md +158 -0
  9. adafruit_circuitpython_rfm-1.0.4/LICENSE +21 -0
  10. adafruit_circuitpython_rfm-1.0.4/LICENSES/CC-BY-4.0.txt +324 -0
  11. adafruit_circuitpython_rfm-1.0.4/LICENSES/MIT.txt +19 -0
  12. adafruit_circuitpython_rfm-1.0.4/LICENSES/Unlicense.txt +20 -0
  13. adafruit_circuitpython_rfm-1.0.4/PKG-INFO +128 -0
  14. adafruit_circuitpython_rfm-1.0.4/README.rst +107 -0
  15. adafruit_circuitpython_rfm-1.0.4/README.rst.license +3 -0
  16. adafruit_circuitpython_rfm-1.0.4/adafruit_circuitpython_rfm.egg-info/PKG-INFO +128 -0
  17. adafruit_circuitpython_rfm-1.0.4/adafruit_circuitpython_rfm.egg-info/SOURCES.txt +51 -0
  18. adafruit_circuitpython_rfm-1.0.4/adafruit_circuitpython_rfm.egg-info/dependency_links.txt +1 -0
  19. adafruit_circuitpython_rfm-1.0.4/adafruit_circuitpython_rfm.egg-info/requires.txt +5 -0
  20. adafruit_circuitpython_rfm-1.0.4/adafruit_circuitpython_rfm.egg-info/top_level.txt +1 -0
  21. adafruit_circuitpython_rfm-1.0.4/adafruit_rfm/__init__.py +0 -0
  22. adafruit_circuitpython_rfm-1.0.4/adafruit_rfm/rfm69.py +651 -0
  23. adafruit_circuitpython_rfm-1.0.4/adafruit_rfm/rfm9x.py +534 -0
  24. adafruit_circuitpython_rfm-1.0.4/adafruit_rfm/rfm9xfsk.py +575 -0
  25. adafruit_circuitpython_rfm-1.0.4/adafruit_rfm/rfm_common.py +557 -0
  26. adafruit_circuitpython_rfm-1.0.4/docs/_static/favicon.ico +0 -0
  27. adafruit_circuitpython_rfm-1.0.4/docs/_static/favicon.ico.license +3 -0
  28. adafruit_circuitpython_rfm-1.0.4/docs/api.rst +17 -0
  29. adafruit_circuitpython_rfm-1.0.4/docs/api.rst.license +4 -0
  30. adafruit_circuitpython_rfm-1.0.4/docs/conf.py +185 -0
  31. adafruit_circuitpython_rfm-1.0.4/docs/examples.rst +8 -0
  32. adafruit_circuitpython_rfm-1.0.4/docs/examples.rst.license +4 -0
  33. adafruit_circuitpython_rfm-1.0.4/docs/index.rst +47 -0
  34. adafruit_circuitpython_rfm-1.0.4/docs/index.rst.license +4 -0
  35. adafruit_circuitpython_rfm-1.0.4/docs/requirements.txt +7 -0
  36. adafruit_circuitpython_rfm-1.0.4/examples/rfm_fsk_node1.py +93 -0
  37. adafruit_circuitpython_rfm-1.0.4/examples/rfm_fsk_node2.py +93 -0
  38. adafruit_circuitpython_rfm-1.0.4/examples/rfm_msgpack_data.py +118 -0
  39. adafruit_circuitpython_rfm-1.0.4/examples/rfm_raw.py +92 -0
  40. adafruit_circuitpython_rfm-1.0.4/examples/rfm_rh_asyncio_listen.py +95 -0
  41. adafruit_circuitpython_rfm-1.0.4/examples/rfm_rh_asyncio_listen_ack.py +96 -0
  42. adafruit_circuitpython_rfm-1.0.4/examples/rfm_rh_asyncio_node1.py +129 -0
  43. adafruit_circuitpython_rfm-1.0.4/examples/rfm_rh_base.py +71 -0
  44. adafruit_circuitpython_rfm-1.0.4/examples/rfm_rh_base_ack.py +71 -0
  45. adafruit_circuitpython_rfm-1.0.4/examples/rfm_rh_node1.py +87 -0
  46. adafruit_circuitpython_rfm-1.0.4/examples/rfm_rh_node1_ack.py +89 -0
  47. adafruit_circuitpython_rfm-1.0.4/examples/rfm_simpletest.py +88 -0
  48. adafruit_circuitpython_rfm-1.0.4/examples/rfm_transmit.py +100 -0
  49. adafruit_circuitpython_rfm-1.0.4/optional_requirements.txt +3 -0
  50. adafruit_circuitpython_rfm-1.0.4/pyproject.toml +51 -0
  51. adafruit_circuitpython_rfm-1.0.4/requirements.txt +8 -0
  52. adafruit_circuitpython_rfm-1.0.4/ruff.toml +99 -0
  53. adafruit_circuitpython_rfm-1.0.4/setup.cfg +4 -0
@@ -0,0 +1,13 @@
1
+ # SPDX-FileCopyrightText: 2021 Adafruit Industries
2
+ #
3
+ # SPDX-License-Identifier: MIT
4
+
5
+ Thank you for contributing! Before you submit a pull request, please read the following.
6
+
7
+ Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://docs.circuitpython.org/en/latest/docs/design_guide.html
8
+
9
+ If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs
10
+
11
+ Before submitting the pull request, make sure you've run Pylint and Black locally on your code. You can do this manually or using pre-commit. Instructions are available here: https://adafru.it/check-your-code
12
+
13
+ Please remove all of this text before submitting. Include an explanation or list of changes included in your PR, as well as, if applicable, a link to any related issues.
@@ -0,0 +1,14 @@
1
+ # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
2
+ #
3
+ # SPDX-License-Identifier: MIT
4
+
5
+ name: Build CI
6
+
7
+ on: [pull_request, push]
8
+
9
+ jobs:
10
+ test:
11
+ runs-on: ubuntu-latest
12
+ steps:
13
+ - name: Run Build CI workflow
14
+ uses: adafruit/workflows-circuitpython-libs/build@main
@@ -0,0 +1,19 @@
1
+ # SPDX-FileCopyrightText: 2021 Scott Shawcroft for Adafruit Industries
2
+ #
3
+ # SPDX-License-Identifier: MIT
4
+
5
+ name: Failure help text
6
+
7
+ on:
8
+ workflow_run:
9
+ workflows: ["Build CI"]
10
+ types:
11
+ - completed
12
+
13
+ jobs:
14
+ post-help:
15
+ runs-on: ubuntu-latest
16
+ if: ${{ github.event.workflow_run.conclusion == 'failure' && github.event.workflow_run.event == 'pull_request' }}
17
+ steps:
18
+ - name: Post comment to help
19
+ uses: adafruit/circuitpython-action-library-ci-failed@v1
@@ -0,0 +1,19 @@
1
+ # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
2
+ #
3
+ # SPDX-License-Identifier: MIT
4
+
5
+ name: GitHub Release Actions
6
+
7
+ on:
8
+ release:
9
+ types: [published]
10
+
11
+ jobs:
12
+ upload-release-assets:
13
+ runs-on: ubuntu-latest
14
+ steps:
15
+ - name: Run GitHub Release CI workflow
16
+ uses: adafruit/workflows-circuitpython-libs/release-gh@main
17
+ with:
18
+ github-token: ${{ secrets.GITHUB_TOKEN }}
19
+ upload-url: ${{ github.event.release.upload_url }}
@@ -0,0 +1,19 @@
1
+ # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
2
+ #
3
+ # SPDX-License-Identifier: MIT
4
+
5
+ name: PyPI Release Actions
6
+
7
+ on:
8
+ release:
9
+ types: [published]
10
+
11
+ jobs:
12
+ upload-release-assets:
13
+ runs-on: ubuntu-latest
14
+ steps:
15
+ - name: Run PyPI Release CI workflow
16
+ uses: adafruit/workflows-circuitpython-libs/release-pypi@main
17
+ with:
18
+ pypi-username: ${{ secrets.pypi_username }}
19
+ pypi-password: ${{ secrets.pypi_password }}
@@ -0,0 +1,21 @@
1
+ # SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
2
+ #
3
+ # SPDX-License-Identifier: Unlicense
4
+
5
+ repos:
6
+ - repo: https://github.com/pre-commit/pre-commit-hooks
7
+ rev: v4.5.0
8
+ hooks:
9
+ - id: check-yaml
10
+ - id: end-of-file-fixer
11
+ - id: trailing-whitespace
12
+ - repo: https://github.com/astral-sh/ruff-pre-commit
13
+ rev: v0.3.4
14
+ hooks:
15
+ - id: ruff-format
16
+ - id: ruff
17
+ args: ["--fix"]
18
+ - repo: https://github.com/fsfe/reuse-tool
19
+ rev: v3.0.1
20
+ hooks:
21
+ - id: reuse
@@ -0,0 +1,22 @@
1
+ # SPDX-FileCopyrightText: 2021 Melissa LeBlanc-Williams for Adafruit Industries
2
+ #
3
+ # SPDX-License-Identifier: Unlicense
4
+
5
+ # Read the Docs configuration file
6
+ # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
7
+
8
+ # Required
9
+ version: 2
10
+
11
+ sphinx:
12
+ configuration: docs/conf.py
13
+
14
+ build:
15
+ os: ubuntu-lts-latest
16
+ tools:
17
+ python: "3"
18
+
19
+ python:
20
+ install:
21
+ - requirements: docs/requirements.txt
22
+ - requirements: requirements.txt
@@ -0,0 +1,158 @@
1
+ <!--
2
+ SPDX-FileCopyrightText: 2014 Coraline Ada Ehmke
3
+ SPDX-FileCopyrightText: 2019-2021 Kattni Rembor for Adafruit Industries
4
+
5
+ SPDX-License-Identifier: CC-BY-4.0
6
+ -->
7
+ # Adafruit Community Code of Conduct
8
+
9
+ ## Our Pledge
10
+
11
+ In the interest of fostering an open and welcoming environment, we as
12
+ contributors and leaders pledge to making participation in our project and
13
+ our community a harassment-free experience for everyone, regardless of age, body
14
+ size, disability, ethnicity, gender identity and expression, level or type of
15
+ experience, education, socio-economic status, nationality, personal appearance,
16
+ race, religion, or sexual identity and orientation.
17
+
18
+ ## Our Standards
19
+
20
+ We are committed to providing a friendly, safe and welcoming environment for
21
+ all.
22
+
23
+ Examples of behavior that contributes to creating and maintaining a positive environment
24
+ include:
25
+
26
+ * Be kind and courteous to others
27
+ * Using welcoming and inclusive language
28
+ * Respecting the identity of every community member, including asking for their
29
+ pronouns if uncertain
30
+ * Being respectful of differing viewpoints and experiences
31
+ * Collaborating with other community members
32
+ * Providing desired assistance and knowledge to other community members
33
+ * Being open to new information and ideas
34
+ * Gracefully accepting constructive criticism
35
+ * Focusing on what is best for the community
36
+ * Showing empathy towards other community members
37
+
38
+ Examples of unacceptable behavior by community members include:
39
+
40
+ * The use of sexualized language or imagery and sexual attention or advances
41
+ * The use of inappropriate images, including in a community member's avatar
42
+ * The use of inappropriate language or profanity, including in a community member's nickname
43
+ * Any spamming, flaming, baiting or other attention-stealing behavior
44
+ * Excessive or unwelcome helping; answering outside the scope of the question
45
+ asked
46
+ * Discussion or promotion of activities or projects that intend or pose a risk of
47
+ significant harm
48
+ * Trolling, insulting/derogatory comments, and attacks of any nature (including,
49
+ but not limited to, personal or political attacks)
50
+ * Promoting or spreading disinformation, lies, or conspiracy theories against
51
+ a person, group, organisation, project, or community
52
+ * Public or private harassment
53
+ * Publishing others' private information, such as a physical or electronic
54
+ address, without explicit permission
55
+ * Engaging in behavior that creates an unwelcoming or uninclusive environment
56
+ * Other conduct which could reasonably be considered inappropriate
57
+
58
+ The Adafruit Community welcomes everyone and strives to create a safe space for all. It is built
59
+ around sharing and contributing to technology. We encourage discussing your thoughts, experiences,
60
+ and feelings within the scope of the community. However, there are topics that can sometimes stray
61
+ from that scope, and can lead to hurting others and create an unwelcoming, uninclusive environment.
62
+
63
+ Examples of discussion topics that have been known to stray outside the scope of the Adafruit
64
+ Community include, but are not limited to:
65
+
66
+ * Discussions regarding religion and related topics
67
+ * Discussions regarding politics and related topics
68
+
69
+ The goal of the standards and moderation guidelines outlined here is to build
70
+ and maintain a respectful community. We ask that you don’t just aim to be
71
+ "technically unimpeachable", but rather try to be your best self.
72
+
73
+ We value many things beyond technical expertise, including collaboration and
74
+ supporting others within our community. Providing a positive experience for
75
+ other community members can have a much more significant impact than simply
76
+ providing the correct answer.
77
+
78
+ ## Our Responsibilities
79
+
80
+ Project leaders are responsible for clarifying the standards of acceptable
81
+ behavior and are expected to take appropriate and fair corrective action in
82
+ response to any instances of unacceptable behavior.
83
+
84
+ Project leaders have the right and responsibility to remove, edit, or
85
+ reject messages, comments, commits, code, issues, and other contributions
86
+ that are not aligned to this Code of Conduct, or to ban temporarily or
87
+ permanently any community member for other behaviors that they deem
88
+ inappropriate, threatening, offensive, or harmful.
89
+
90
+ ## Moderation
91
+
92
+ Instances of behaviors that violate the Adafruit Community Code of Conduct
93
+ may be reported by any member of the community. Community members are
94
+ encouraged to report these situations, including situations they witness
95
+ involving other community members.
96
+
97
+ You may report in the following ways:
98
+
99
+ In any situation, you may email <support@adafruit.com>.
100
+
101
+ On the Adafruit Discord, you may send an open message from any channel
102
+ to all Community Moderators by tagging @community moderators. You may
103
+ also send an open message from the #help-with-community channel, or a
104
+ direct message to any Community Moderator.
105
+
106
+ The source of email and direct message reports will be kept confidential.
107
+
108
+ In situations on Discord where the issue is particularly offensive, possibly
109
+ illegal, requires immediate action, or violates the Discord terms of service,
110
+ you should also report the message directly to [Discord](https://discord.com/safety).
111
+
112
+ These are the steps for upholding our community’s standards of conduct.
113
+
114
+ 1. Any member of the community may report any situation that violates the
115
+ Adafruit Community Code of Conduct. All reports will be reviewed and
116
+ investigated.
117
+ 2. If the behavior is a severe violation, the community member who
118
+ committed the violation may be banned immediately, without warning.
119
+ 3. Otherwise, moderators will first respond to such behavior with a warning.
120
+ 4. Moderators follow a soft "three strikes" policy - the community member may
121
+ be given another chance, if they are receptive to the warning and change their
122
+ behavior.
123
+ 5. If the community member is unreceptive or unreasonable when warned by a
124
+ moderator, or the warning goes unheeded, they may be banned for a first or
125
+ second offense. Repeated offenses will result in the community member being
126
+ banned.
127
+ 6. Disciplinary actions (warnings, bans, etc) for Code of Conduct violations apply
128
+ to the platform where the violation occurred. However, depending on the severity
129
+ of the violation, the disciplinary action may be applied across Adafruit's other
130
+ community platforms. For example, a severe violation on the Adafruit Discord
131
+ server may result in a ban on not only the Adafruit Discord server, but also on
132
+ the Adafruit GitHub organisation, Adafruit Forums, Adafruit Twitter, etc.
133
+
134
+ ## Scope
135
+
136
+ This Code of Conduct and the enforcement policies listed above apply to all
137
+ Adafruit Community venues. This includes but is not limited to any community
138
+ spaces (both public and private), the entire Adafruit Discord server, and
139
+ Adafruit GitHub repositories. Examples of Adafruit Community spaces include
140
+ but are not limited to meet-ups, audio chats on the Adafruit Discord, or
141
+ interaction at a conference.
142
+
143
+ This Code of Conduct applies both within project spaces and in public spaces
144
+ when an individual is representing the project or its community. As a community
145
+ member, you are representing our community, and are expected to behave
146
+ accordingly.
147
+
148
+ ## Attribution
149
+
150
+ This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/),
151
+ version 1.4, available on [contributor-covenant.org](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html),
152
+ and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html).
153
+
154
+ For other projects adopting the Adafruit Community Code of
155
+ Conduct, please contact the maintainers of those projects for enforcement.
156
+ If you wish to use this code of conduct for your own project, consider
157
+ explicitly mentioning your moderation policy or making a copy with your
158
+ own moderation policy so as to avoid confusion.
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2024 Jerry Needell for Adafruit Industries
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,324 @@
1
+ Creative Commons Attribution 4.0 International Creative Commons Corporation
2
+ ("Creative Commons") is not a law firm and does not provide legal services
3
+ or legal advice. Distribution of Creative Commons public licenses does not
4
+ create a lawyer-client or other relationship. Creative Commons makes its licenses
5
+ and related information available on an "as-is" basis. Creative Commons gives
6
+ no warranties regarding its licenses, any material licensed under their terms
7
+ and conditions, or any related information. Creative Commons disclaims all
8
+ liability for damages resulting from their use to the fullest extent possible.
9
+
10
+ Using Creative Commons Public Licenses
11
+
12
+ Creative Commons public licenses provide a standard set of terms and conditions
13
+ that creators and other rights holders may use to share original works of
14
+ authorship and other material subject to copyright and certain other rights
15
+ specified in the public license below. The following considerations are for
16
+ informational purposes only, are not exhaustive, and do not form part of our
17
+ licenses.
18
+
19
+ Considerations for licensors: Our public licenses are intended for use by
20
+ those authorized to give the public permission to use material in ways otherwise
21
+ restricted by copyright and certain other rights. Our licenses are irrevocable.
22
+ Licensors should read and understand the terms and conditions of the license
23
+ they choose before applying it. Licensors should also secure all rights necessary
24
+ before applying our licenses so that the public can reuse the material as
25
+ expected. Licensors should clearly mark any material not subject to the license.
26
+ This includes other CC-licensed material, or material used under an exception
27
+ or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors
28
+
29
+ Considerations for the public: By using one of our public licenses, a licensor
30
+ grants the public permission to use the licensed material under specified
31
+ terms and conditions. If the licensor's permission is not necessary for any
32
+ reason–for example, because of any applicable exception or limitation to copyright–then
33
+ that use is not regulated by the license. Our licenses grant only permissions
34
+ under copyright and certain other rights that a licensor has authority to
35
+ grant. Use of the licensed material may still be restricted for other reasons,
36
+ including because others have copyright or other rights in the material. A
37
+ licensor may make special requests, such as asking that all changes be marked
38
+ or described. Although not required by our licenses, you are encouraged to
39
+ respect those requests where reasonable. More considerations for the public
40
+ : wiki.creativecommons.org/Considerations_for_licensees Creative Commons Attribution
41
+ 4.0 International Public License
42
+
43
+ By exercising the Licensed Rights (defined below), You accept and agree to
44
+ be bound by the terms and conditions of this Creative Commons Attribution
45
+ 4.0 International Public License ("Public License"). To the extent this Public
46
+ License may be interpreted as a contract, You are granted the Licensed Rights
47
+ in consideration of Your acceptance of these terms and conditions, and the
48
+ Licensor grants You such rights in consideration of benefits the Licensor
49
+ receives from making the Licensed Material available under these terms and
50
+ conditions.
51
+
52
+ Section 1 – Definitions.
53
+
54
+ a. Adapted Material means material subject to Copyright and Similar Rights
55
+ that is derived from or based upon the Licensed Material and in which the
56
+ Licensed Material is translated, altered, arranged, transformed, or otherwise
57
+ modified in a manner requiring permission under the Copyright and Similar
58
+ Rights held by the Licensor. For purposes of this Public License, where the
59
+ Licensed Material is a musical work, performance, or sound recording, Adapted
60
+ Material is always produced where the Licensed Material is synched in timed
61
+ relation with a moving image.
62
+
63
+ b. Adapter's License means the license You apply to Your Copyright and Similar
64
+ Rights in Your contributions to Adapted Material in accordance with the terms
65
+ and conditions of this Public License.
66
+
67
+ c. Copyright and Similar Rights means copyright and/or similar rights closely
68
+ related to copyright including, without limitation, performance, broadcast,
69
+ sound recording, and Sui Generis Database Rights, without regard to how the
70
+ rights are labeled or categorized. For purposes of this Public License, the
71
+ rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
72
+
73
+ d. Effective Technological Measures means those measures that, in the absence
74
+ of proper authority, may not be circumvented under laws fulfilling obligations
75
+ under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996,
76
+ and/or similar international agreements.
77
+
78
+ e. Exceptions and Limitations means fair use, fair dealing, and/or any other
79
+ exception or limitation to Copyright and Similar Rights that applies to Your
80
+ use of the Licensed Material.
81
+
82
+ f. Licensed Material means the artistic or literary work, database, or other
83
+ material to which the Licensor applied this Public License.
84
+
85
+ g. Licensed Rights means the rights granted to You subject to the terms and
86
+ conditions of this Public License, which are limited to all Copyright and
87
+ Similar Rights that apply to Your use of the Licensed Material and that the
88
+ Licensor has authority to license.
89
+
90
+ h. Licensor means the individual(s) or entity(ies) granting rights under this
91
+ Public License.
92
+
93
+ i. Share means to provide material to the public by any means or process that
94
+ requires permission under the Licensed Rights, such as reproduction, public
95
+ display, public performance, distribution, dissemination, communication, or
96
+ importation, and to make material available to the public including in ways
97
+ that members of the public may access the material from a place and at a time
98
+ individually chosen by them.
99
+
100
+ j. Sui Generis Database Rights means rights other than copyright resulting
101
+ from Directive 96/9/EC of the European Parliament and of the Council of 11
102
+ March 1996 on the legal protection of databases, as amended and/or succeeded,
103
+ as well as other essentially equivalent rights anywhere in the world.
104
+
105
+ k. You means the individual or entity exercising the Licensed Rights under
106
+ this Public License. Your has a corresponding meaning.
107
+
108
+ Section 2 – Scope.
109
+
110
+ a. License grant.
111
+
112
+ 1. Subject to the terms and conditions of this Public License, the Licensor
113
+ hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive,
114
+ irrevocable license to exercise the Licensed Rights in the Licensed Material
115
+ to:
116
+
117
+ A. reproduce and Share the Licensed Material, in whole or in part; and
118
+
119
+ B. produce, reproduce, and Share Adapted Material.
120
+
121
+ 2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions
122
+ and Limitations apply to Your use, this Public License does not apply, and
123
+ You do not need to comply with its terms and conditions.
124
+
125
+ 3. Term. The term of this Public License is specified in Section 6(a).
126
+
127
+ 4. Media and formats; technical modifications allowed. The Licensor authorizes
128
+ You to exercise the Licensed Rights in all media and formats whether now known
129
+ or hereafter created, and to make technical modifications necessary to do
130
+ so. The Licensor waives and/or agrees not to assert any right or authority
131
+ to forbid You from making technical modifications necessary to exercise the
132
+ Licensed Rights, including technical modifications necessary to circumvent
133
+ Effective Technological Measures. For purposes of this Public License, simply
134
+ making modifications authorized by this Section 2(a)(4) never produces Adapted
135
+ Material.
136
+
137
+ 5. Downstream recipients.
138
+
139
+ A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed
140
+ Material automatically receives an offer from the Licensor to exercise the
141
+ Licensed Rights under the terms and conditions of this Public License.
142
+
143
+ B. No downstream restrictions. You may not offer or impose any additional
144
+ or different terms or conditions on, or apply any Effective Technological
145
+ Measures to, the Licensed Material if doing so restricts exercise of the Licensed
146
+ Rights by any recipient of the Licensed Material.
147
+
148
+ 6. No endorsement. Nothing in this Public License constitutes or may be construed
149
+ as permission to assert or imply that You are, or that Your use of the Licensed
150
+ Material is, connected with, or sponsored, endorsed, or granted official status
151
+ by, the Licensor or others designated to receive attribution as provided in
152
+ Section 3(a)(1)(A)(i).
153
+
154
+ b. Other rights.
155
+
156
+ 1. Moral rights, such as the right of integrity, are not licensed under this
157
+ Public License, nor are publicity, privacy, and/or other similar personality
158
+ rights; however, to the extent possible, the Licensor waives and/or agrees
159
+ not to assert any such rights held by the Licensor to the limited extent necessary
160
+ to allow You to exercise the Licensed Rights, but not otherwise.
161
+
162
+ 2. Patent and trademark rights are not licensed under this Public License.
163
+
164
+ 3. To the extent possible, the Licensor waives any right to collect royalties
165
+ from You for the exercise of the Licensed Rights, whether directly or through
166
+ a collecting society under any voluntary or waivable statutory or compulsory
167
+ licensing scheme. In all other cases the Licensor expressly reserves any right
168
+ to collect such royalties.
169
+
170
+ Section 3 – License Conditions.
171
+
172
+ Your exercise of the Licensed Rights is expressly made subject to the following
173
+ conditions.
174
+
175
+ a. Attribution.
176
+
177
+ 1. If You Share the Licensed Material (including in modified form), You must:
178
+
179
+ A. retain the following if it is supplied by the Licensor with the Licensed
180
+ Material:
181
+
182
+ i. identification of the creator(s) of the Licensed Material and any others
183
+ designated to receive attribution, in any reasonable manner requested by the
184
+ Licensor (including by pseudonym if designated);
185
+
186
+ ii. a copyright notice;
187
+
188
+ iii. a notice that refers to this Public License;
189
+
190
+ iv. a notice that refers to the disclaimer of warranties;
191
+
192
+ v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
193
+
194
+ B. indicate if You modified the Licensed Material and retain an indication
195
+ of any previous modifications; and
196
+
197
+ C. indicate the Licensed Material is licensed under this Public License, and
198
+ include the text of, or the URI or hyperlink to, this Public License.
199
+
200
+ 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner
201
+ based on the medium, means, and context in which You Share the Licensed Material.
202
+ For example, it may be reasonable to satisfy the conditions by providing a
203
+ URI or hyperlink to a resource that includes the required information.
204
+
205
+ 3. If requested by the Licensor, You must remove any of the information required
206
+ by Section 3(a)(1)(A) to the extent reasonably practicable.
207
+
208
+ 4. If You Share Adapted Material You produce, the Adapter's License You apply
209
+ must not prevent recipients of the Adapted Material from complying with this
210
+ Public License.
211
+
212
+ Section 4 – Sui Generis Database Rights.
213
+
214
+ Where the Licensed Rights include Sui Generis Database Rights that apply to
215
+ Your use of the Licensed Material:
216
+
217
+ a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract,
218
+ reuse, reproduce, and Share all or a substantial portion of the contents of
219
+ the database;
220
+
221
+ b. if You include all or a substantial portion of the database contents in
222
+ a database in which You have Sui Generis Database Rights, then the database
223
+ in which You have Sui Generis Database Rights (but not its individual contents)
224
+ is Adapted Material; and
225
+
226
+ c. You must comply with the conditions in Section 3(a) if You Share all or
227
+ a substantial portion of the contents of the database.
228
+
229
+ For the avoidance of doubt, this Section 4 supplements and does not replace
230
+ Your obligations under this Public License where the Licensed Rights include
231
+ other Copyright and Similar Rights.
232
+
233
+ Section 5 – Disclaimer of Warranties and Limitation of Liability.
234
+
235
+ a. Unless otherwise separately undertaken by the Licensor, to the extent possible,
236
+ the Licensor offers the Licensed Material as-is and as-available, and makes
237
+ no representations or warranties of any kind concerning the Licensed Material,
238
+ whether express, implied, statutory, or other. This includes, without limitation,
239
+ warranties of title, merchantability, fitness for a particular purpose, non-infringement,
240
+ absence of latent or other defects, accuracy, or the presence or absence of
241
+ errors, whether or not known or discoverable. Where disclaimers of warranties
242
+ are not allowed in full or in part, this disclaimer may not apply to You.
243
+
244
+ b. To the extent possible, in no event will the Licensor be liable to You
245
+ on any legal theory (including, without limitation, negligence) or otherwise
246
+ for any direct, special, indirect, incidental, consequential, punitive, exemplary,
247
+ or other losses, costs, expenses, or damages arising out of this Public License
248
+ or use of the Licensed Material, even if the Licensor has been advised of
249
+ the possibility of such losses, costs, expenses, or damages. Where a limitation
250
+ of liability is not allowed in full or in part, this limitation may not apply
251
+ to You.
252
+
253
+ c. The disclaimer of warranties and limitation of liability provided above
254
+ shall be interpreted in a manner that, to the extent possible, most closely
255
+ approximates an absolute disclaimer and waiver of all liability.
256
+
257
+ Section 6 – Term and Termination.
258
+
259
+ a. This Public License applies for the term of the Copyright and Similar Rights
260
+ licensed here. However, if You fail to comply with this Public License, then
261
+ Your rights under this Public License terminate automatically.
262
+
263
+ b. Where Your right to use the Licensed Material has terminated under Section
264
+ 6(a), it reinstates:
265
+
266
+ 1. automatically as of the date the violation is cured, provided it is cured
267
+ within 30 days of Your discovery of the violation; or
268
+
269
+ 2. upon express reinstatement by the Licensor.
270
+
271
+ c. For the avoidance of doubt, this Section 6(b) does not affect any right
272
+ the Licensor may have to seek remedies for Your violations of this Public
273
+ License.
274
+
275
+ d. For the avoidance of doubt, the Licensor may also offer the Licensed Material
276
+ under separate terms or conditions or stop distributing the Licensed Material
277
+ at any time; however, doing so will not terminate this Public License.
278
+
279
+ e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
280
+
281
+ Section 7 – Other Terms and Conditions.
282
+
283
+ a. The Licensor shall not be bound by any additional or different terms or
284
+ conditions communicated by You unless expressly agreed.
285
+
286
+ b. Any arrangements, understandings, or agreements regarding the Licensed
287
+ Material not stated herein are separate from and independent of the terms
288
+ and conditions of this Public License.
289
+
290
+ Section 8 – Interpretation.
291
+
292
+ a. For the avoidance of doubt, this Public License does not, and shall not
293
+ be interpreted to, reduce, limit, restrict, or impose conditions on any use
294
+ of the Licensed Material that could lawfully be made without permission under
295
+ this Public License.
296
+
297
+ b. To the extent possible, if any provision of this Public License is deemed
298
+ unenforceable, it shall be automatically reformed to the minimum extent necessary
299
+ to make it enforceable. If the provision cannot be reformed, it shall be severed
300
+ from this Public License without affecting the enforceability of the remaining
301
+ terms and conditions.
302
+
303
+ c. No term or condition of this Public License will be waived and no failure
304
+ to comply consented to unless expressly agreed to by the Licensor.
305
+
306
+ d. Nothing in this Public License constitutes or may be interpreted as a limitation
307
+ upon, or waiver of, any privileges and immunities that apply to the Licensor
308
+ or You, including from the legal processes of any jurisdiction or authority.
309
+
310
+ Creative Commons is not a party to its public licenses. Notwithstanding, Creative
311
+ Commons may elect to apply one of its public licenses to material it publishes
312
+ and in those instances will be considered the "Licensor." The text of the
313
+ Creative Commons public licenses is dedicated to the public domain under the
314
+ CC0 Public Domain Dedication. Except for the limited purpose of indicating
315
+ that material is shared under a Creative Commons public license or as otherwise
316
+ permitted by the Creative Commons policies published at creativecommons.org/policies,
317
+ Creative Commons does not authorize the use of the trademark "Creative Commons"
318
+ or any other trademark or logo of Creative Commons without its prior written
319
+ consent including, without limitation, in connection with any unauthorized
320
+ modifications to any of its public licenses or any other arrangements, understandings,
321
+ or agreements concerning use of licensed material. For the avoidance of doubt,
322
+ this paragraph does not form part of the public licenses.
323
+
324
+ Creative Commons may be contacted at creativecommons.org.
@@ -0,0 +1,19 @@
1
+ MIT License Copyright (c) <year> <copyright holders>
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy
4
+ of this software and associated documentation files (the "Software"), to deal
5
+ in the Software without restriction, including without limitation the rights
6
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7
+ copies of the Software, and to permit persons to whom the Software is furnished
8
+ to do so, subject to the following conditions:
9
+
10
+ The above copyright notice and this permission notice (including the next
11
+ paragraph) shall be included in all copies or substantial portions of the
12
+ Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
16
+ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
17
+ OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
18
+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
19
+ OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.