From 5ab036284093f0eb79c513db22ef98afa11479a1 Mon Sep 17 00:00:00 2001 From: Alexey Date: Tue, 5 Oct 2021 14:05:16 +0300 Subject: [PATCH 1/7] Create LICENSE --- LICENSE | 201 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 201 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. From 69fb92077d9fb236d9c65a2eaf52fab5b3a27592 Mon Sep 17 00:00:00 2001 From: Alexey Date: Tue, 5 Oct 2021 19:58:56 +0300 Subject: [PATCH 2/7] Add dependencies to setup --- setup.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/setup.py b/setup.py index 8ca649fe..1d3753e5 100644 --- a/setup.py +++ b/setup.py @@ -23,6 +23,16 @@ 'Programming Language :: Python :: 3.9', 'Programming Language :: Python :: 3.10', ], + install_requires=[ + 'certifi~=2021.5.30', + 'cffi~=1.14.6', + 'charset-normalizer~=2.0.6', + 'cryptography~=3.4.8', + 'idna~=3.2', + 'pycparser~=2.20', + 'requests~=2.26.0', + 'urllib3~=1.26.7' + ], project_urls={ 'Documentation': 'https://github.com/DKE-Data/agrirouter-sdk-python', 'Source': 'https://github.com/DKE-Data/agrirouter-sdk-python', From 3b1d573109c1ad8108cc5888822bd004cd691c1a Mon Sep 17 00:00:00 2001 From: Alexey Date: Tue, 5 Oct 2021 20:12:09 +0300 Subject: [PATCH 3/7] Add assets --- assets/images/agrirouter.svg | 69 +++++++++++++++++++++++++++++++ assets/images/lmis.svg | 79 ++++++++++++++++++++++++++++++++++++ 2 files changed, 148 insertions(+) create mode 100755 assets/images/agrirouter.svg create mode 100644 assets/images/lmis.svg diff --git a/assets/images/agrirouter.svg b/assets/images/agrirouter.svg new file mode 100755 index 00000000..c3d214b6 --- /dev/null +++ b/assets/images/agrirouter.svg @@ -0,0 +1,69 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/assets/images/lmis.svg b/assets/images/lmis.svg new file mode 100644 index 00000000..95e5da4a --- /dev/null +++ b/assets/images/lmis.svg @@ -0,0 +1,79 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From e347fad31c1fa9543fc88aee106b55b9b0d3f5b6 Mon Sep 17 00:00:00 2001 From: Alexey Date: Tue, 5 Oct 2021 20:12:50 +0300 Subject: [PATCH 4/7] Add README --- README.adoc | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 README.adoc diff --git a/README.adoc b/README.adoc new file mode 100644 index 00000000..59227151 --- /dev/null +++ b/README.adoc @@ -0,0 +1,67 @@ += agrirouter-sdk-python +:imagesdir: assets/images +:toc: +:toc-title: +:toclevels: 4 + +[abstract] +== Abstract +image::agrirouter.svg[agrirouter] + +The agrirouter is a universal data exchange platform for farmers and agricultural contractors that makes it possible to connect machinery and agricultural software, regardless of vendor or manufacturer. Agrirouter does not save data; it transfers data. +As a universal data exchange platform, agrirouter fills a gap on the way to Farming 4.0. Its underlying concept unites cross-vendor and discrimination-free data transfer. You retain full control over your data. Even data exchange with service providers (e.g. agricultural contractors) and other partners is uncomplicated: Data are very rapidly transferred via the online connection, and if you wish, is intelligently connected to other datasets. + +== Supporters & Maintainers +image::lmis.svg[agrirouter] + +The LMIS AG is a recognised german IT service company, certified according to DIN EN ISO 9001:2015 and based in +Osnabrück, Berlin, Friedland and Wuppertal. Our core competence is the individual development, optimisation and support +of IT solutions. We also provide professional IT consulting services and training courses. We have been supporting +the whole project during the development in the field of test management and are currently responsible for the development +support of the platform. + +We are active maintainers of the SDK and are using the SDK for internal testing purposes as well. Therefore, we have a +high interest in a stable and usable interface to connect to the agrirouter. + +Feel free to get in touch by visiting our https://www.lmis.de[website] or contacting us via GitHub. + +== The current project you're looking at + +This project contains the SDK for the communication with the agrirouter. Everything you need for the onboard process, secure communication and much more. + +== Installation + +The necessary dependencies are installed via `composer`. Just run the following command to add the SDK to your project. + + +`git clone https://github.com/DKE-Data/agrirouter-sdk-python.git` + +To install the SDK run the 'setup.py' script in the main directory (for a global install you will need to run this command with root privileges): + +`cd agrirouter-sdk-python` + +`virtualenv venv` + +`...` + +`$ . venv/bin/activate` + +`python setup.py install` + +For more install options type: + +`python setup.py --help` + +== Requirements + +Python 3.6 or above is required. + + +== External resources + +Here are some external resources for the development: + +* https://my-agrirouter.com[My Agrirouter Website] +* https://github.com/DKE-Data/agrirouter-interface-documentation[Integration Guide] +* https://www.aef-online.org[EFDI Protobuf Definition] +* https://www.lmis.de[LMIS - Maintenance & Support] From c5382a85ed638b94ea771efaebf159cb1315b3db Mon Sep 17 00:00:00 2001 From: Alexey Date: Tue, 5 Oct 2021 20:15:08 +0300 Subject: [PATCH 5/7] Add tests directory --- tests/__init__.py | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 tests/__init__.py diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 00000000..e69de29b From 8c81141e8d6bd3d5b40dbd0544979c879e8b7bd6 Mon Sep 17 00:00:00 2001 From: Alexey Date: Tue, 5 Oct 2021 20:15:40 +0300 Subject: [PATCH 6/7] Ignore build dir --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 25dda8a9..b8c6d657 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +build dist venv .idea From 2787dde3f1b951333ee7d5c999dfb442659d2579 Mon Sep 17 00:00:00 2001 From: Alexey Date: Wed, 6 Oct 2021 10:50:37 +0300 Subject: [PATCH 7/7] Clean up the README --- README.adoc | 24 +++---------- assets/images/lmis.svg | 79 ------------------------------------------ 2 files changed, 5 insertions(+), 98 deletions(-) delete mode 100644 assets/images/lmis.svg diff --git a/README.adoc b/README.adoc index 59227151..37137e1d 100644 --- a/README.adoc +++ b/README.adoc @@ -11,19 +11,6 @@ image::agrirouter.svg[agrirouter] The agrirouter is a universal data exchange platform for farmers and agricultural contractors that makes it possible to connect machinery and agricultural software, regardless of vendor or manufacturer. Agrirouter does not save data; it transfers data. As a universal data exchange platform, agrirouter fills a gap on the way to Farming 4.0. Its underlying concept unites cross-vendor and discrimination-free data transfer. You retain full control over your data. Even data exchange with service providers (e.g. agricultural contractors) and other partners is uncomplicated: Data are very rapidly transferred via the online connection, and if you wish, is intelligently connected to other datasets. -== Supporters & Maintainers -image::lmis.svg[agrirouter] - -The LMIS AG is a recognised german IT service company, certified according to DIN EN ISO 9001:2015 and based in -Osnabrück, Berlin, Friedland and Wuppertal. Our core competence is the individual development, optimisation and support -of IT solutions. We also provide professional IT consulting services and training courses. We have been supporting -the whole project during the development in the field of test management and are currently responsible for the development -support of the platform. - -We are active maintainers of the SDK and are using the SDK for internal testing purposes as well. Therefore, we have a -high interest in a stable and usable interface to connect to the agrirouter. - -Feel free to get in touch by visiting our https://www.lmis.de[website] or contacting us via GitHub. == The current project you're looking at @@ -34,23 +21,23 @@ This project contains the SDK for the communication with the agrirouter. Everyth The necessary dependencies are installed via `composer`. Just run the following command to add the SDK to your project. -`git clone https://github.com/DKE-Data/agrirouter-sdk-python.git` +`$ git clone https://github.com/DKE-Data/agrirouter-sdk-python.git` To install the SDK run the 'setup.py' script in the main directory (for a global install you will need to run this command with root privileges): -`cd agrirouter-sdk-python` +`$ cd agrirouter-sdk-python` -`virtualenv venv` +`$ virtualenv venv` `...` `$ . venv/bin/activate` -`python setup.py install` +`$ python setup.py install` For more install options type: -`python setup.py --help` +`$ python setup.py --help` == Requirements @@ -64,4 +51,3 @@ Here are some external resources for the development: * https://my-agrirouter.com[My Agrirouter Website] * https://github.com/DKE-Data/agrirouter-interface-documentation[Integration Guide] * https://www.aef-online.org[EFDI Protobuf Definition] -* https://www.lmis.de[LMIS - Maintenance & Support] diff --git a/assets/images/lmis.svg b/assets/images/lmis.svg deleted file mode 100644 index 95e5da4a..00000000 --- a/assets/images/lmis.svg +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -