velocitas-sdk 0.14.1__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 (123) hide show
  1. velocitas_sdk-0.14.1/.github/ISSUE_TEMPLATE.md +32 -0
  2. velocitas_sdk-0.14.1/.github/PULL_REQUEST_TEMPLATE.md +25 -0
  3. velocitas_sdk-0.14.1/.project-creation/.skeleton/README.md +3 -0
  4. velocitas_sdk-0.14.1/.pytest_cache/README.md +8 -0
  5. velocitas_sdk-0.14.1/CODE_OF_CONDUCT.md +93 -0
  6. velocitas_sdk-0.14.1/CONTRIBUTING.md +127 -0
  7. velocitas_sdk-0.14.1/LICENSE +201 -0
  8. velocitas_sdk-0.14.1/MANIFEST.in +16 -0
  9. velocitas_sdk-0.14.1/NOTICE-3RD-PARTY-CONTENT.md +83 -0
  10. velocitas_sdk-0.14.1/NOTICE.md +30 -0
  11. velocitas_sdk-0.14.1/PKG-INFO +104 -0
  12. velocitas_sdk-0.14.1/README.md +65 -0
  13. velocitas_sdk-0.14.1/SECURITY.md +49 -0
  14. velocitas_sdk-0.14.1/examples/__init__.py +13 -0
  15. velocitas_sdk-0.14.1/examples/array-datatype/AppManifest.json +20 -0
  16. velocitas_sdk-0.14.1/examples/array-datatype/src/__init__.py +13 -0
  17. velocitas_sdk-0.14.1/examples/array-datatype/src/main.py +65 -0
  18. velocitas_sdk-0.14.1/examples/array-datatype/tests/__init__.py +13 -0
  19. velocitas_sdk-0.14.1/examples/array-datatype/tests/integration/__init__.py +13 -0
  20. velocitas_sdk-0.14.1/examples/array-datatype/tests/unit/__init__.py +13 -0
  21. velocitas_sdk-0.14.1/examples/atomic-set/AppManifest.json +35 -0
  22. velocitas_sdk-0.14.1/examples/atomic-set/src/__init__.py +13 -0
  23. velocitas_sdk-0.14.1/examples/atomic-set/src/main.py +88 -0
  24. velocitas_sdk-0.14.1/examples/atomic-set/tests/__init__.py +13 -0
  25. velocitas_sdk-0.14.1/examples/atomic-set/tests/integration/__init__.py +13 -0
  26. velocitas_sdk-0.14.1/examples/atomic-set/tests/unit/__init__.py +13 -0
  27. velocitas_sdk-0.14.1/examples/datapoint-set/AppManifest.json +36 -0
  28. velocitas_sdk-0.14.1/examples/datapoint-set/src/__init__.py +13 -0
  29. velocitas_sdk-0.14.1/examples/datapoint-set/src/main.py +97 -0
  30. velocitas_sdk-0.14.1/examples/datapoint-set/tests/__init__.py +13 -0
  31. velocitas_sdk-0.14.1/examples/datapoint-set/tests/integration/__init__.py +13 -0
  32. velocitas_sdk-0.14.1/examples/datapoint-set/tests/unit/__init__.py +13 -0
  33. velocitas_sdk-0.14.1/examples/dog-mode/AppManifest.json +54 -0
  34. velocitas_sdk-0.14.1/examples/dog-mode/README.md +73 -0
  35. velocitas_sdk-0.14.1/examples/dog-mode/src/__init__.py +13 -0
  36. velocitas_sdk-0.14.1/examples/dog-mode/src/main.py +135 -0
  37. velocitas_sdk-0.14.1/examples/dog-mode/src/vehicle_model/__init__.py +13 -0
  38. velocitas_sdk-0.14.1/examples/dog-mode/src/vehicle_model/__pycache__/__init__.cpython-310.pyc +0 -0
  39. velocitas_sdk-0.14.1/examples/dog-mode/src/vehicle_model/__pycache__/sample.cpython-310.pyc +0 -0
  40. velocitas_sdk-0.14.1/examples/dog-mode/src/vehicle_model/proto/__pycache__/hvac_pb2.cpython-310.pyc +0 -0
  41. velocitas_sdk-0.14.1/examples/dog-mode/src/vehicle_model/proto/__pycache__/hvac_pb2_grpc.cpython-310.pyc +0 -0
  42. velocitas_sdk-0.14.1/examples/dog-mode/src/vehicle_model/proto/hvac.proto +80 -0
  43. velocitas_sdk-0.14.1/examples/dog-mode/src/vehicle_model/proto/hvac_pb2.py +74 -0
  44. velocitas_sdk-0.14.1/examples/dog-mode/src/vehicle_model/proto/hvac_pb2.pyi +76 -0
  45. velocitas_sdk-0.14.1/examples/dog-mode/src/vehicle_model/proto/hvac_pb2_grpc.py +135 -0
  46. velocitas_sdk-0.14.1/examples/dog-mode/src/vehicle_model/sample.py +110 -0
  47. velocitas_sdk-0.14.1/examples/dog-mode/tests/__init__.py +13 -0
  48. velocitas_sdk-0.14.1/examples/dog-mode/tests/integration/__init__.py +13 -0
  49. velocitas_sdk-0.14.1/examples/dog-mode/tests/unit/__init__.py +13 -0
  50. velocitas_sdk-0.14.1/examples/dynamic-rule/AppManifest.json +36 -0
  51. velocitas_sdk-0.14.1/examples/dynamic-rule/README.md +15 -0
  52. velocitas_sdk-0.14.1/examples/dynamic-rule/src/__init__.py +13 -0
  53. velocitas_sdk-0.14.1/examples/dynamic-rule/src/main.py +96 -0
  54. velocitas_sdk-0.14.1/examples/dynamic-rule/tests/__init__.py +13 -0
  55. velocitas_sdk-0.14.1/examples/dynamic-rule/tests/integration/__init__.py +13 -0
  56. velocitas_sdk-0.14.1/examples/dynamic-rule/tests/unit/__init__.py +13 -0
  57. velocitas_sdk-0.14.1/examples/run-app.sh +62 -0
  58. velocitas_sdk-0.14.1/examples/seat-adjuster/AppManifest.json +36 -0
  59. velocitas_sdk-0.14.1/examples/seat-adjuster/Dockerfile +65 -0
  60. velocitas_sdk-0.14.1/examples/seat-adjuster/README.md +48 -0
  61. velocitas_sdk-0.14.1/examples/seat-adjuster/requirements-links.txt +0 -0
  62. velocitas_sdk-0.14.1/examples/seat-adjuster/requirements-velocitas.txt +1 -0
  63. velocitas_sdk-0.14.1/examples/seat-adjuster/requirements.in +19 -0
  64. velocitas_sdk-0.14.1/examples/seat-adjuster/requirements.txt +38 -0
  65. velocitas_sdk-0.14.1/examples/seat-adjuster/src/__init__.py +13 -0
  66. velocitas_sdk-0.14.1/examples/seat-adjuster/src/main.py +44 -0
  67. velocitas_sdk-0.14.1/examples/seat-adjuster/src/vapp.py +104 -0
  68. velocitas_sdk-0.14.1/examples/seat-adjuster/tests/__init__.py +13 -0
  69. velocitas_sdk-0.14.1/examples/seat-adjuster/tests/integration/__init__.py +13 -0
  70. velocitas_sdk-0.14.1/examples/seat-adjuster/tests/integration/integration_test.py +154 -0
  71. velocitas_sdk-0.14.1/examples/seat-adjuster/tests/requirements.in +20 -0
  72. velocitas_sdk-0.14.1/examples/seat-adjuster/tests/requirements.txt +38 -0
  73. velocitas_sdk-0.14.1/examples/seat-adjuster/tests/unit/__init__.py +13 -0
  74. velocitas_sdk-0.14.1/examples/seat-adjuster/tests/unit/test_run.py +243 -0
  75. velocitas_sdk-0.14.1/examples/static-rule/AppManifest.json +20 -0
  76. velocitas_sdk-0.14.1/examples/static-rule/src/__init__.py +13 -0
  77. velocitas_sdk-0.14.1/examples/static-rule/src/main.py +57 -0
  78. velocitas_sdk-0.14.1/examples/static-rule/tests/__init__.py +13 -0
  79. velocitas_sdk-0.14.1/examples/static-rule/tests/integration/__init__.py +13 -0
  80. velocitas_sdk-0.14.1/examples/static-rule/tests/unit/__init__.py +13 -0
  81. velocitas_sdk-0.14.1/examples/vdb-queries/AppManifest.json +24 -0
  82. velocitas_sdk-0.14.1/examples/vdb-queries/src/__init__.py +13 -0
  83. velocitas_sdk-0.14.1/examples/vdb-queries/src/main.py +113 -0
  84. velocitas_sdk-0.14.1/examples/vdb-queries/tests/__init__.py +13 -0
  85. velocitas_sdk-0.14.1/examples/vdb-queries/tests/integration/__init__.py +13 -0
  86. velocitas_sdk-0.14.1/examples/vdb-queries/tests/unit/__init__.py +13 -0
  87. velocitas_sdk-0.14.1/setup.cfg +22 -0
  88. velocitas_sdk-0.14.1/setup.py +90 -0
  89. velocitas_sdk-0.14.1/velocitas_sdk/__init__.py +13 -0
  90. velocitas_sdk-0.14.1/velocitas_sdk/base.py +77 -0
  91. velocitas_sdk-0.14.1/velocitas_sdk/config.py +48 -0
  92. velocitas_sdk-0.14.1/velocitas_sdk/model.py +948 -0
  93. velocitas_sdk-0.14.1/velocitas_sdk/native/__init__.py +13 -0
  94. velocitas_sdk-0.14.1/velocitas_sdk/native/locator.py +48 -0
  95. velocitas_sdk-0.14.1/velocitas_sdk/native/middleware.py +43 -0
  96. velocitas_sdk-0.14.1/velocitas_sdk/native/mqtt.py +91 -0
  97. velocitas_sdk-0.14.1/velocitas_sdk/proto/broker_pb2.py +59 -0
  98. velocitas_sdk-0.14.1/velocitas_sdk/proto/broker_pb2.pyi +240 -0
  99. velocitas_sdk-0.14.1/velocitas_sdk/proto/broker_pb2_grpc.py +180 -0
  100. velocitas_sdk-0.14.1/velocitas_sdk/proto/collector_pb2.py +61 -0
  101. velocitas_sdk-0.14.1/velocitas_sdk/proto/collector_pb2.pyi +227 -0
  102. velocitas_sdk-0.14.1/velocitas_sdk/proto/collector_pb2_grpc.py +166 -0
  103. velocitas_sdk-0.14.1/velocitas_sdk/proto/types_pb2.py +53 -0
  104. velocitas_sdk-0.14.1/velocitas_sdk/proto/types_pb2.pyi +401 -0
  105. velocitas_sdk-0.14.1/velocitas_sdk/proto/types_pb2_grpc.py +4 -0
  106. velocitas_sdk-0.14.1/velocitas_sdk/py.typed +0 -0
  107. velocitas_sdk-0.14.1/velocitas_sdk/test/__init__.py +13 -0
  108. velocitas_sdk-0.14.1/velocitas_sdk/test/databroker_testhelper.py +36 -0
  109. velocitas_sdk-0.14.1/velocitas_sdk/test/inttesthelper.py +338 -0
  110. velocitas_sdk-0.14.1/velocitas_sdk/test/mqtt_util.py +151 -0
  111. velocitas_sdk-0.14.1/velocitas_sdk/util/__init__.py +13 -0
  112. velocitas_sdk-0.14.1/velocitas_sdk/util/log.py +88 -0
  113. velocitas_sdk-0.14.1/velocitas_sdk/vdb/__init__.py +13 -0
  114. velocitas_sdk-0.14.1/velocitas_sdk/vdb/client.py +118 -0
  115. velocitas_sdk-0.14.1/velocitas_sdk/vdb/reply.py +192 -0
  116. velocitas_sdk-0.14.1/velocitas_sdk/vdb/subscriptions.py +136 -0
  117. velocitas_sdk-0.14.1/velocitas_sdk/vdb/types.py +28 -0
  118. velocitas_sdk-0.14.1/velocitas_sdk/vehicle_app.py +128 -0
  119. velocitas_sdk-0.14.1/velocitas_sdk.egg-info/PKG-INFO +104 -0
  120. velocitas_sdk-0.14.1/velocitas_sdk.egg-info/SOURCES.txt +122 -0
  121. velocitas_sdk-0.14.1/velocitas_sdk.egg-info/dependency_links.txt +1 -0
  122. velocitas_sdk-0.14.1/velocitas_sdk.egg-info/requires.txt +27 -0
  123. velocitas_sdk-0.14.1/velocitas_sdk.egg-info/top_level.txt +2 -0
@@ -0,0 +1,32 @@
1
+ Issue tracker is **ONLY** used for reporting bugs.
2
+
3
+ <!--- Provide a general summary of the issue in the Title above -->
4
+
5
+ ## Expected Behavior
6
+ <!--- Tell us what should happen -->
7
+
8
+ ## Current Behavior
9
+ <!--- Tell us what happens instead of the expected behavior -->
10
+
11
+ ## Possible Solution
12
+ <!--- Not obligatory, but suggest a fix/reason for the bug, -->
13
+
14
+ ## Steps to Reproduce
15
+ <!--- Provide a link to a live example, or an unambiguous set of steps to -->
16
+ <!--- reproduce this bug. Include code to reproduce, if relevant -->
17
+ 1.
18
+ 2.
19
+ 3.
20
+ 4.
21
+
22
+ ## Context (Environment)
23
+ <!--- How has this issue affected you? What are you trying to accomplish? -->
24
+ <!--- Providing context helps us come up with a solution that is most useful in the real world -->
25
+
26
+ <!--- Provide a general summary of the issue in the Title above -->
27
+
28
+ ## Detailed Description
29
+ <!--- Provide a detailed description of the change or addition you are proposing -->
30
+
31
+ ## Possible Implementation
32
+ <!--- Not obligatory, but suggest an idea for implementing addition or change -->
@@ -0,0 +1,25 @@
1
+ ## Describe your changes
2
+
3
+ <!--
4
+ Please provide a brief description to what your change does.
5
+ -->
6
+
7
+ ## Issue ticket number and link
8
+
9
+ <!--
10
+ Please provide a reference to the issue or the bug that you filed for the issue you are solving.
11
+ -->
12
+
13
+ ## Checklist - Manual tasks
14
+
15
+ <!--
16
+ Please check which manual tasks have bee performed as part of this pull request.
17
+ -->
18
+
19
+ * [ ] Examples are executing successfully
20
+ * [ ] Created/updated unit tests. Code Coverage percentage on new code shall be >= 80%.
21
+ * [ ] Created/updated integration tests.
22
+ * [ ] Devcontainer can be opened successfully
23
+ * [ ] Devcontainer can be opened successfully behind a corporate proxy
24
+ * [ ] Devcontainer can be re-built successfully
25
+ * [ ] Extended the documentation (e.g. README.md, CONTRIBUTING.md, Velocitas)
@@ -0,0 +1,3 @@
1
+ # AppName Readme
2
+
3
+ A simple skeleton app for getting you up and running with Velocitas app development.
@@ -0,0 +1,8 @@
1
+ # pytest cache directory #
2
+
3
+ This directory contains data from the pytest's cache plugin,
4
+ which provides the `--lf` and `--ff` options, as well as the `cache` fixture.
5
+
6
+ **Do not** commit this to version control.
7
+
8
+ See [the docs](https://docs.pytest.org/en/stable/how-to/cache.html) for more information.
@@ -0,0 +1,93 @@
1
+ # Community Code of Conduct
2
+
3
+ **Version 1.0
4
+ January 1, 2023**
5
+
6
+ ## Our Pledge
7
+
8
+ In the interest of fostering an open and welcoming environment, we as community members, contributors, Committers[^1], and Project Leads (collectively "Contributors") pledge to make participation in our projects and our community a harassment-free and inclusive experience for everyone.
9
+
10
+ This Community Code of Conduct ("Code") outlines our behavior expectations as members of our community in all Eclipse Foundation activities, both offline and online. It is not intended to govern scenarios or behaviors outside of the scope of Eclipse Foundation activities. Nor is it intended to replace or supersede the protections offered to all our community members under the law. Please follow both the spirit and letter of this Code and encourage other Contributors to follow these principles into our work. Failure to read or acknowledge this Code does not excuse a Contributor from compliance with the Code.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contribute to creating a positive and professional environment include:
15
+
16
+ - Using welcoming and inclusive language;
17
+ - Actively encouraging all voices;
18
+ - Helping others bring their perspectives and listening actively. If you find yourself dominating a discussion, it is especially important to encourage other voices to join in;
19
+ - Being respectful of differing viewpoints and experiences;
20
+ - Gracefully accepting constructive criticism;
21
+ - Focusing on what is best for the community;
22
+ - Showing empathy towards other community members;
23
+ - Being direct but professional; and
24
+ - Leading by example by holding yourself and others accountable
25
+
26
+ Examples of unacceptable behavior by Contributors include:
27
+
28
+ - The use of sexualized language or imagery;
29
+ - Unwelcome sexual attention or advances;
30
+ - Trolling, insulting/derogatory comments, and personal or political attacks;
31
+ - Public or private harassment, repeated harassment;
32
+ - Publishing others' private information, such as a physical or electronic address, without explicit permission;
33
+ - Violent threats or language directed against another person;
34
+ - Sexist, racist, or otherwise discriminatory jokes and language;
35
+ - Posting sexually explicit or violent material;
36
+ - Sharing private content, such as emails sent privately or non-publicly, or unlogged forums such as IRC channel history;
37
+ - Personal insults, especially those using racist or sexist terms;
38
+ - Excessive or unnecessary profanity;
39
+ - Advocating for, or encouraging, any of the above behavior; and
40
+ - Other conduct which could reasonably be considered inappropriate in a professional setting
41
+
42
+ ## Our Responsibilities
43
+
44
+ With the support of the Eclipse Foundation employees, consultants, officers, and directors (collectively, the "Staff"), Committers, and Project Leads, the Eclipse Foundation Conduct Committee (the "Conduct Committee") is responsible for clarifying the standards of acceptable behavior. The Conduct Committee takes appropriate and fair corrective action in response to any instances of unacceptable behavior.
45
+
46
+ ## Scope
47
+
48
+ This Code applies within all Project, Working Group, and Interest Group spaces and communication channels of the Eclipse Foundation (collectively, "Eclipse spaces"), within any Eclipse-organized event or meeting, and in public spaces when an individual is representing an Eclipse Foundation Project, Working Group, Interest Group, or their communities. Examples of representing a Project or community include posting via an official social media account, personal accounts, or acting as an appointed representative at an online or offline event. Representation of Projects, Working Groups, and Interest Groups may be further defined and clarified by Committers, Project Leads, or the Staff.
49
+
50
+ ## Enforcement
51
+
52
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Conduct Committee via <velocitas-dev@eclipse.org>. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Without the explicit consent of the reporter, the Conduct Committee is obligated to maintain confidentiality with regard to the reporter of an incident. The Conduct Committee is further obligated to ensure that the respondent is provided with sufficient information about the complaint to reply. If such details cannot be provided while maintaining confidentiality, the Conduct Committee will take the respondent‘s inability to provide a defense into account in its deliberations and decisions. Further details of enforcement guidelines may be posted separately.
53
+
54
+ Staff, Committers and Project Leads have the right to report, remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code, or to block temporarily or permanently any Contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. Any such actions will be reported to the Conduct Committee for transparency and record keeping.
55
+
56
+ Any Staff (including officers and directors of the Eclipse Foundation), Committers, Project Leads, or Conduct Committee members who are the subject of a complaint to the Conduct Committee will be recused from the process of resolving any such complaint.
57
+
58
+ ## Responsibility
59
+
60
+ The responsibility for administering this Code rests with the Conduct Committee, with oversight by the Executive Director and the Board of Directors. For additional information on the Conduct Committee and its process, please write to <velocitas-dev@eclipse.org>.
61
+
62
+ ## Investigation of Potential Code Violations
63
+
64
+ All conflict is not bad as a healthy debate may sometimes be necessary to push us to do our best. It is, however, unacceptable to be disrespectful or offensive, or violate this Code. If you see someone engaging in objectionable behavior violating this Code, we encourage you to address the behavior directly with those involved. If for some reason, you are unable to resolve the matter or feel uncomfortable doing so, or if the behavior is threatening or harassing, please report it following the procedure laid out below.
65
+
66
+ Reports should be directed to <velocitas-dev@eclipse.org>. It is the Conduct Committee’s role to receive and address reported violations of this Code and to ensure a fair and speedy resolution.
67
+
68
+ The Eclipse Foundation takes all reports of potential Code violations seriously and is committed to confidentiality and a full investigation of all allegations. The identity of the reporter will be omitted from the details of the report supplied to the accused. Contributors who are being investigated for a potential Code violation will have an opportunity to be heard prior to any final determination. Those found to have violated the Code can seek reconsideration of the violation and disciplinary action decisions. Every effort will be made to have all matters disposed of within 60 days of the receipt of the complaint.
69
+
70
+ ## Actions
71
+ Contributors who do not follow this Code in good faith may face temporary or permanent repercussions as determined by the Conduct Committee.
72
+
73
+ This Code does not address all conduct. It works in conjunction with our [Communication Channel Guidelines](https://www.eclipse.org/org/documents/communication-channel-guidelines/), [Social Media Guidelines](https://www.eclipse.org/org/documents/social_media_guidelines.php), [Bylaws](https://www.eclipse.org/org/documents/eclipse-foundation-be-bylaws-en.pdf), and [Internal Rules](https://www.eclipse.org/org/documents/ef-be-internal-rules.pdf) which set out additional protections for, and obligations of, all contributors. The Foundation has additional policies that provide further guidance on other matters.
74
+
75
+ It’s impossible to spell out every possible scenario that might be deemed a violation of this Code. Instead, we rely on one another’s good judgment to uphold a high standard of integrity within all Eclipse Spaces. Sometimes, identifying the right thing to do isn’t an easy call. In such a scenario, raise the issue as early as possible.
76
+
77
+ ## No Retaliation
78
+
79
+ The Eclipse community relies upon and values the help of Contributors who identify potential problems that may need to be addressed within an Eclipse Space. Any retaliation against a Contributor who raises an issue honestly is a violation of this Code. That a Contributor has raised a concern honestly or participated in an investigation, cannot be the basis for any adverse action, including threats, harassment, or discrimination. If you work with someone who has raised a concern or provided information in an investigation, you should continue to treat the person with courtesy and respect. If you believe someone has retaliated against you, report the matter as described by this Code. Honest reporting does not mean that you have to be right when you raise a concern; you just have to believe that the information you are providing is accurate.
80
+
81
+ False reporting, especially when intended to retaliate or exclude, is itself a violation of this Code and will not be accepted or tolerated.
82
+
83
+ Everyone is encouraged to ask questions about this Code. Your feedback is welcome, and you will get a response within three business days. Write to <velocitas-dev@eclipse.org>.
84
+
85
+ ## Amendments
86
+
87
+ The Eclipse Foundation Board of Directors may amend this Code from time to time and may vary the procedures it sets out where appropriate in a particular case.
88
+
89
+ ### Attribution
90
+
91
+ This Code was inherited from [Eclipse Foundation Code of Conduct](https://www.eclipse.org/org/documents/Community_Code_of_Conduct.php) and inspired by the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.4, available [here](https://www.contributor-covenant.org/version/1/4/code-of-conduct/).
92
+
93
+ [^1]: Capitalized terms used herein without definition shall have the meanings assigned to them in the Eclipse Bylaws.
@@ -0,0 +1,127 @@
1
+ # How to Contribute to Eclipse Velocitas Vehicle App SDK for Python
2
+
3
+ First of all, thanks for considering to contribute to Eclipse Velocitas. We really
4
+ appreciate the time and effort you want to spend helping to improve things around here.
5
+
6
+ In order to get you started as fast as possible we need to go through some organizational issues first, though.
7
+
8
+ ## Eclipse Contributor Agreement
9
+
10
+ Before your contribution can be accepted by the project team contributors must
11
+ electronically sign the Eclipse Contributor Agreement (ECA).
12
+
13
+ * http://www.eclipse.org/legal/ECA.php
14
+
15
+ Commits that are provided by non-committers must have a Signed-off-by field in
16
+ the footer indicating that the author is aware of the terms by which the
17
+ contribution has been provided to the project. The non-committer must
18
+ additionally have an Eclipse Foundation account and must have a signed Eclipse
19
+ Contributor Agreement (ECA) on file.
20
+
21
+ For more information, please see the Eclipse Committer Handbook:
22
+ https://www.eclipse.org/projects/handbook/#resources-commit
23
+
24
+ ## Code Style Guide
25
+ * Use [Ruff](https://docs.astral.sh/ruff/) to format your code.
26
+ * Use [mypy](https://mypy.readthedocs.io/) to check for type errors.
27
+ * Above and other tools will run automatically if you install
28
+ [pre-commit](https://pre-commit.com/) using the instructions below.
29
+
30
+ ## Making Your Changes
31
+
32
+ * Fork the repository on GitHub.
33
+ * Create a new branch for your changes.
34
+ * Install dependencies:
35
+
36
+ ```bash
37
+ pip3 install -r requirements.txt
38
+ ```
39
+ * Install package in editable mode:
40
+
41
+ ```bash
42
+ pip3 install -e .
43
+ ```
44
+ * Make your changes following the code style guide (see Code Style Guide section above).
45
+ * When you create new files make sure you include a proper license header at the top of the file (see License Header section below).
46
+ * When you make changes to existing protocol buffer files, regenerate the python descriptors with the following command:
47
+
48
+ ```bash
49
+ ./generate-grpc-stubs.sh
50
+ ```
51
+ or use the corresponding VSCode task.
52
+ * Make sure you include test cases and new examples for non-trivial features.
53
+ * Make sure test cases provide sufficient code coverage (see GitHub actions for minimal accepted coverage).
54
+ * Install and run [pre-commit](https://pre-commit.com/) to automatically check for style guide issues.
55
+ ```bash
56
+ pre-commit install
57
+ pre-commit run --all-files
58
+ ```
59
+ > **_NOTE:_** Or just use task `Local - Pre Commit Action` by pressing `F1` and select `Tasks - Run Task`
60
+ * Make sure the unit and integration test suites passes after your changes.
61
+ ```bash
62
+ tox -e py38
63
+ ```
64
+ * Add new examples for non-trivial features.
65
+ * Commit your changes into that branch.
66
+ * Use descriptive and meaningful commit messages. Start the first line of the commit message with the issue number and title e.g. `[#9865] Add token based authentication`.
67
+ * Squash multiple commits that are related to each other semantically into a single one.
68
+ * Make sure you use the `-s` flag when committing as explained above.
69
+ * Push your changes to your branch in your forked repository.
70
+
71
+ ## Python Dependency Management
72
+
73
+ In this project, the [pip-tools](https://github.com/jazzband/pip-tools) are used to manage the python dependencies and to keep all packages up-to-date.
74
+
75
+ The required pip-based dependencies of this project are defined in the [setup.py](./setup.py). All runtime dependencies are listed in the `"install_requires"` while the development dependencies are listed in the `[dev]` section of the `"extras_require"`. In other words:
76
+ * The requirements that are defined in the `"install_requires"` are only installed when using the Vehicle app SDK as a runtime dependency for vehicle app development.
77
+ * The requirements that are defined in the `"extras_require[dev]"` are installed for the contribution of the Vehicle app SDK development within the dev-container or in a dedicated virtual environments. This list consists of all the necessary runtime, testing and development tools packages and need to be installed before start contributing to the project.
78
+
79
+ The process for the dependency management of this project can be summarized as following:
80
+ * The `pip-compile` tool will generate the [requirements.txt](./requirements.txt). By executing this tools, the `"requirements.txt"` file will be updated with all underlying dependencies. The command below shall be executed every time a new python package is added to the project and/or to bump the package versions.
81
+
82
+ ```bash
83
+ pip-compile --extra=dev
84
+ ```
85
+ * Please run the `pip-compile` with `-U` flag in order to force update all packages with the latest versions. However, you need to make sure when force updating all packages that everything works as expected.
86
+ ```bash
87
+ pip-compile --extra=dev -U
88
+ ```
89
+ * Run `pip-sync` or `pip install` to install the required dependencies from the [requirements.txt](./requirements.txt) alternatively.
90
+ ```bash
91
+ pip-sync
92
+ ```
93
+ ```bash
94
+ pip3 install -r requirements.txt
95
+ ```
96
+ If there are any other `none public python dependencies` (E.g. GitHub links), they shall not be added to the setup.py file directly. Instead, they must be added to the [requirements-links.txt](./requirements-links.txt).
97
+
98
+ > **_NOTE:_** `Please don't try to update the versions of the dependencies manually.`
99
+
100
+ ## License Header
101
+
102
+ Please make sure any file you newly create contains a proper license header like this:
103
+
104
+ ```python
105
+ # Copyright (c) 2024 Contributors to the Eclipse Foundation
106
+ #
107
+ # This program and the accompanying materials are made available under the
108
+ # terms of the Apache License, Version 2.0 which is available at
109
+ # https://www.apache.org/licenses/LICENSE-2.0.
110
+ #
111
+ # Unless required by applicable law or agreed to in writing, software
112
+ # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
113
+ # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
114
+ # License for the specific language governing permissions and limitations
115
+ # under the License.
116
+ #
117
+ # SPDX-License-Identifier: Apache-2.0
118
+ ```
119
+ Please adjusted the comment character to the specific file format.
120
+
121
+ ## Submitting the Changes
122
+
123
+ Submit a pull request via the normal GitHub UI.
124
+
125
+ ## After Submitting
126
+
127
+ * Do not use your branch for any other development, otherwise further changes that you make will be visible in the PR.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,16 @@
1
+ # Copyright (c) 2023-2024 Contributors to the Eclipse Foundation
2
+ #
3
+ # This program and the accompanying materials are made available under the
4
+ # terms of the Apache License, Version 2.0 which is available at
5
+ # https://www.apache.org/licenses/LICENSE-2.0.
6
+ #
7
+ # Unless required by applicable law or agreed to in writing, software
8
+ # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
9
+ # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
10
+ # License for the specific language governing permissions and limitations
11
+ # under the License.
12
+ #
13
+ # SPDX-License-Identifier: Apache-2.0
14
+
15
+ global-include *.md LICENSE
16
+ recursive-include examples *
@@ -0,0 +1,83 @@
1
+ # Licenses Notice
2
+ *Note*: This file is auto-generated. Do not modify it manually.
3
+ ## Python
4
+ | Dependency | Version | License |
5
+ |:-----------|:-------:|--------:|
6
+ |aiohttp|3.9.3|Apache 2.0|
7
+ |aiosignal|1.3.1|Apache 2.0|
8
+ |APScheduler|3.10.4|MIT|
9
+ |async-timeout|4.0.3|Apache 2.0|
10
+ |attrs|23.1.0|MIT|
11
+ |build|1.0.3|MIT|
12
+ |cachetools|5.3.2|MIT|
13
+ |cfgv|3.4.0|MIT|
14
+ |chardet|5.2.0|LGPL|
15
+ |click|8.1.7|New BSD|
16
+ |cloudevents|1.10.1|Apache 2.0|
17
+ |colorama|0.4.6|BSD|
18
+ |coverage|7.4.1|Apache 2.0|
19
+ |Deprecated|1.2.14|MIT|
20
+ |deprecation|2.1.0|Apache 2.0|
21
+ |distlib|0.3.8|Python Software Foundation License|
22
+ |exceptiongroup|1.2.0|MIT|
23
+ |filelock|3.13.1|The Unlicense (Unlicense)|
24
+ |frozenlist|1.4.0|Apache 2.0|
25
+ |grpc-stubs|1.53.0.5|MIT|
26
+ |grpcio|1.59.0|Apache 2.0|
27
+ |grpcio-tools|1.59.0|Apache 2.0|
28
+ |identify|2.5.33|MIT|
29
+ |idna|3.4|BSD|
30
+ |iniconfig|2.0.0|MIT|
31
+ |multidict|6.0.4|Apache 2.0|
32
+ |mypy|1.8.0|MIT|
33
+ |mypy-extensions|1.0.0|MIT|
34
+ |mypy-protobuf|3.4.0|Apache 2.0|
35
+ |nodeenv|1.8.0|BSD|
36
+ |opentelemetry-api|1.15.0|Apache 2.0|
37
+ |opentelemetry-distro|0.36b0|Apache 2.0|
38
+ |opentelemetry-instrumentation|0.36b0|Apache 2.0|
39
+ |opentelemetry-instrumentation-logging|0.36b0|Apache 2.0|
40
+ |opentelemetry-sdk|1.15.0|Apache 2.0|
41
+ |opentelemetry-semantic-conventions|0.36b0|Apache 2.0|
42
+ |packaging|23.1|Apache 2.0<br/>BSD|
43
+ |paho-mqtt|1.6.1|OSI Approved|
44
+ |pip|24.0|MIT|
45
+ |pip-tools|7.3.0|BSD|
46
+ |platformdirs|4.2.0|MIT|
47
+ |pluggy|1.4.0|MIT|
48
+ |pre-commit|3.6.0|MIT|
49
+ |protobuf|4.21.12|Google License|
50
+ |pyproject-api|1.6.1|MIT|
51
+ |pyproject-hooks|1.0.0|MIT|
52
+ |pytest|7.4.4|MIT|
53
+ |pytest-asyncio|0.23.4|Apache 2.0|
54
+ |pytest-cov|4.1.0|MIT|
55
+ |pytz|2024.1|MIT|
56
+ |PyYAML|6.0.1|MIT|
57
+ |setuptools|58.1.0|MIT|
58
+ |six|1.16.0|MIT|
59
+ |tomli|2.0.1|MIT|
60
+ |tox|4.11.4|MIT|
61
+ |types-Deprecated|1.2.9.20240106|Apache 2.0|
62
+ |types-mock|5.1.0.20240106|Apache 2.0|
63
+ |types-protobuf|4.24.0.20240129|Apache 2.0|
64
+ |typing-extensions|4.7.1|Python Software Foundation License|
65
+ |tzlocal|5.2|MIT|
66
+ |virtualenv|20.25.0|MIT|
67
+ |wheel|0.42.0|MIT|
68
+ |wrapt|1.15.0|BSD|
69
+ |yarl|1.9.2|Apache 2.0|
70
+ ## Workflows
71
+ | Dependency | Version | License |
72
+ |:-----------|:-------:|--------:|
73
+ |actions/checkout|v4|MIT License|
74
+ |actions/setup-java|v1.4.4|MIT License|
75
+ |actions/setup-node|v4|MIT License|
76
+ |actions/setup-python|v5|MIT License|
77
+ |actions/upload-artifact|v3|MIT License|
78
+ |danielpalme/ReportGenerator-GitHub-Action|5.2.0|Apache License 2.0|
79
+ |devcontainers/ci|v0.3|MIT License|
80
+ |github/codeql-action|v2|MIT License|
81
+ |mikepenz/action-junit-report|v4|Apache License 2.0|
82
+ |pre-commit/action|v3.0.0|MIT License|
83
+ |softprops/action-gh-release|v1|MIT License|
@@ -0,0 +1,30 @@
1
+ ## Declared Project Licenses
2
+
3
+ This program and the accompanying materials are made available under the terms of the Apache License, Version 2.0 which is available at https://www.apache.org/licenses/LICENSE-2.0.
4
+
5
+ SPDX-License-Identifier: Apache-2.0
6
+
7
+ ## Contributors:
8
+ * Robert Bosch GmbH
9
+ * Microsoft Corporation
10
+
11
+ ## Third-party Content
12
+
13
+ ### Devcontainer
14
+
15
+ | Software | License |
16
+ | :------------------ | :--------------------------------------------------------------------------------------------------------------- |
17
+ | Python | https://docs.python.org/3/license.html |
18
+ | Mosquitto | https://github.com/eclipse/mosquitto/blob/master/LICENSE.txt |
19
+
20
+ ### Development
21
+ | Software | License |
22
+ | :------: | :------------------------------------------------------------------: |
23
+ | GRPC | https://github.com/grpc/grpc/blob/master/LICENSE |
24
+ | Pre-Commit | https://github.com/pre-commit/pre-commit/blob/main/LICENSE |
25
+ | Mypy | https://github.com/python/mypy/blob/master/LICENSE |
26
+ | Ruff | https://raw.githubusercontent.com/astral-sh/ruff/main/LICENSE |
27
+
28
+ ### Further 3rd party licenses used in project
29
+ * [Auto-generated 3rd party licenses](./NOTICE-3RD-PARTY-CONTENT.md)
30
+ * [Full list of dependencies in the devcontainer base-image](https://github.com/eclipse-velocitas/devcontainer-base-images/tree/sbom/SBOM/Markdown)