Skip to content

Commit 2116c98

Browse files
cloudxxx8cloudxxx8
authored
Merge pull request #1 from cloudxxx8/init-commit
feat: Init commit
2 parents e44fb76 + bfd6414 commit 2116c98

File tree

271 files changed

+26504
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

271 files changed

+26504
-0
lines changed

‎LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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.

‎Makefile

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
#
2+
# Copyright (c) 2024 IOTech Ltd
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
#
16+
17+
.PHONY: test
18+
19+
docker:
20+
make -C ./app-service-template docker
21+
22+
lint:
23+
@which pylint >/dev/null || echo "WARNING: pylint not installed. To install, run make install-lint"
24+
pylint ./src
25+
26+
install-sdk:
27+
pip install .
28+
29+
install-lint:
30+
pip install pylint
31+
32+
test-template:
33+
make -C ./app-service-template test
34+
35+
test-sdk:
36+
python3 -m unittest discover -s tests -v
37+
38+
test: lint test-sdk test-template

‎README.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Application Functions SDK for Python
2+
3+
The EdgeXFoundry Application Functions Software Development Kit (SDK) for Python. This is a Python para SDK for the [app-functions-sdk-go](https://github.com/edgexfoundry/app-functions-sdk-go), which is designed to help you create EdgeX application services that can process/transform/export data from EdgeX.
4+
5+
## Prerequisites
6+
7+
This Python SDK is supported on Python 3.10 or later.
8+
9+
## File Structure
10+
11+
This Python SDK is designed to follow the file structure that can be installed by [pip package installer](https://pypi.org/project/pip/) as a Python package **app_functions_sdk_py**.
12+
13+
The file structure of this Python SDK is as follows:
14+
- [app-service-template](./app-service-template): this folder contains a template for creating a new EdgeX application service using this Python SDK.
15+
- [src/app_functions_sdk_py](./src/app_functions_sdk_py): this folder contains the source code of the Python SDK with top-level package **app_functions_sdk_py**, which is further divided into the following subpackages:
16+
- [app_functions_sdk_py](./src/app_functions_sdk_py): this subpackage contains modules for implementation of the Python SDK.
17+
- [boostrap](./src/app_functions_sdk_py/bootstrap): this subpackage contains modules for implementation of the bootstrap library for service bootstrap.
18+
- [clients](./src/app_functions_sdk_py/clients): this subpackage contains modules for implementation of various client libraries that are similar to https://github.com/edgexfoundry/go-mod-core-contracts/tree/main/clients.
19+
- [configuration](./src/app_functions_sdk_py/configuration): this subpackage contains modules for implementation of configuration client library that are similar to https://github.com/edgexfoundry/go-mod-configuration.
20+
- [contracts](./src/app_functions_sdk_py/contracts): this subpackage contains modules for implementation of contract models that are similar to https://github.com/edgexfoundry/go-mod-core-contracts.
21+
- [functions](./src/app_functions_sdk_py/functions): this subpackage contains modules for implementation of functions that can be used to process/transform/export data from EdgeX.
22+
- [interfaces](./src/app_functions_sdk_py/interfaces): this subpackage contains modules for various abstract class definition of a role or contract that can be fulfilled by any class or struct that inherits the abstract class. These abstract classes are defined to promote flexibility and decoupling in this SDK.
23+
- [internal](./src/app_functions_sdk_py/internal): this subpackage contains modules for internal implementation of the SDK. These modules are not intended to be used by the end user.
24+
- [messaging](./src/app_functions_sdk_py/messaging): this subpackage contains modules for implementation of messaging client library that are similar to https://github.com/edgexfoundry/go-mod-messaging.
25+
- [registry](./src/app_functions_sdk_py/registry): this subpackage contains modules for implementation of registry client library that are similar to https://github.com/edgexfoundry/go-mod-registry.
26+
- [utils](./src/app_functions_sdk_py/utils): this subpackage contains utility functionality.
27+
- [tests](./tests): this folder contains the unit tests for the Python SDK. Any new unit-tests should be added here with corresponding file structure as to src/app_functions_sdk_py.
28+
- [setup.py](./setup.py): this file is used to package the Python SDK into a Python package. This file is used to dynamically specify the package version.
29+
- [pyproject.toml](./pyproject.toml): this file is used to specify the build system requirements for the Python SDK.
30+
- [Makefile](./Makefile): the Makefile used to build and test the Python SDK.
31+
- [requirements.txt](./requirements.txt): this file specifies the dependencies required to build and test the Python SDK.
32+
33+
## Features Supported
34+
35+
This Python SDK aims to facilitate the development for a python developer to create their own EdgeX Application Service with following features:
36+
- Basic logging mechanism
37+
- Load and apply the EdgeX environment variables
38+
- Consume configuration from YAML configuration file
39+
- Consume configuration from EdgeX Keeper
40+
- Process incoming data from EdgeX Message Bus via either MQTT or NATS-Core
41+
- Process incoming data from a HTTP POST request
42+
- Basic EdgeX common REST API, such as ping, version, and config
43+
44+
The SDK also provides the following built-in functions to process/transform/export data from EdgeX:
45+
46+
- [Filtering functions](./src/app_functions_sdk_py/functions/filter.py) to filter data based on profile name, source name, device name, or resource name
47+
- [MQTT Export function](./src/app_functions_sdk_py/functions/mqtt.py) to export data to an external MQTT broker
48+
- [Batch functions](./src/app_functions_sdk_py/functions/batch.py) to batch data based on the number of events or the time window
49+
- [Compression functions](./src/app_functions_sdk_py/functions/compression.py) to compress data
50+
- [Data protection functions](./src/app_functions_sdk_py/functions/aesprotection.py) to encrypt data
51+
- [Conversion functions](./src/app_functions_sdk_py/functions/conversion.py) to convert data from one format to another
52+
- [JSONLogic function](./src/app_functions_sdk_py/functions/jsonlogic.py) to process data based on JSONLogic rules
53+
- [Set response function](./src/app_functions_sdk_py/functions/responsedata.py) to set the response data into passed in event that received from previous function
54+
- [Wrap into event function](./src/app_functions_sdk_py/functions/wrap_into_event.py) to create an EventRequest using the Event/Reading metadata that have been set
55+
56+
## Run Tests
57+
58+
To run the unit-tests against SDK, you can use the following command:
59+
60+
```shell
61+
make test-sdk
62+
```
63+
64+
You can also run the tests against the app-service-template by using the following command:
65+
66+
```shell
67+
make test-template
68+
```
69+
70+
To have lint to analyse the SDK, you can use the following command:
71+
72+
```shell
73+
make lint
74+
```
75+
76+
To run tests, and lint analysis altogether, you can use the following command:
77+
78+
```shell
79+
make test
80+
```
81+
82+
## Build Docker images
83+
84+
To build the Docker image for the app-service-template, you can use the following command:
85+
86+
```shell
87+
make docker
88+
```
89+
By a successful build, a docker image **$(USER)/app-service-template:latest** will be created in your local environment.

‎app-service-template/Dockerfile

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
FROM python:3.10-alpine3.20
2+
3+
# TODO: Change Copyright to your company if open sourcing or remove label
4+
LABEL license='SPDX-License-Identifier: Apache-2.0' \
5+
copyright='Copyright (c) 2024: IOTech'
6+
7+
# Must specify root to the parent directory of app-functions-sdk-python source folder with --build-context argument
8+
# when running docker build command
9+
COPY --from=root /src /src
10+
COPY --from=root /pyproject.toml /pyproject.toml
11+
COPY --from=root /requirements.txt /requirements.txt
12+
COPY --from=root /setup.py /setup.py
13+
ADD res ./res
14+
ADD main.py .
15+
RUN pip3 install .
16+
RUN pip3 install -r requirements.txt
17+
CMD [ "python" , "./main.py" ]

0 commit comments

Comments
 (0)