diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..c48cb5b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,15 @@ +--- +name: 'Bug report' +title: '[Bug]: ' +labels: bug +--- + +## Description +[//]: # (Briefly describe the bug) + +## Impact +[//]: # (Add detail on the impact of this issue, both the who and the how) + +## Artifacts +[//]: # (Add screenshots / loom video, etc) + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..a49eab2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..d6f27d8 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,18 @@ +--- +labels: mergeable +--- +[//]: # (Link to the issue corresponding to this chunk of work) +Fixes: #__issue__ + +## Motivation and Context +[//]: # (Why is this change required? What problem does it solve?) + +## Description +[//]: # (Describe your changes in detail) + +## How has this been tested? +[//]: # (Please describe in detail how you tested your changes) + + +[//]: # (OPTIONAL) +[//]: # (Add one or multiple labels: enhancement, refactoring, bugfix) diff --git a/.github/workflows/test-and-lint-sdk.yml b/.github/workflows/test-and-lint-sdk.yml new file mode 100644 index 0000000..4f7078b --- /dev/null +++ b/.github/workflows/test-and-lint-sdk.yml @@ -0,0 +1,65 @@ +name: Lint and Test SDK + +on: + pull_request: + paths: + - '**/*' + + +jobs: + check-format-with-black: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: "actions/setup-python@v2" + with: + python-version: '3.x' + - name: "install dependencies" + run: | + python -m pip install black + black --version + - name: "format-black" + run: | + black . --check --diff + lint-with-flake8: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: "actions/setup-python@v2" + with: + python-version: '3.x' + - name: "install dependencies" + run: | + python -m pip install flake8 + - name: "lint-flake8" + run: | + flake8 . --max-line-length 120 + type-check-with-mypy: + runs-on: ubuntu-latest + steps: + - uses: "actions/checkout@v2" + - name: "Install dependencies" + run: | + python -VV + python -m pip install --upgrade pip setuptools wheel + python -m pip install -r requirements.txt + python -m pip install -r requirements-test.txt + - name: "Run mypy tests" + run: | + mypy . + run-tests-with-tox: + runs-on: ubuntu-latest + steps: + - uses: "actions/checkout@v2" + - uses: "actions/setup-python@v2" + with: + python-version: '3.9.x' + - name: "Install dependencies" + run: | + python -VV + python -m pip install --upgrade pip setuptools wheel + python -m pip install -r requirements.txt + python -m pip install -r requirements-test.txt + - name: "Run tox tests" + run: | + tox diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6446e0e --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +dist/ +*.egg-info +.vscode/ +.env +__pycache__ +.tox/ diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..77a684b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,12 @@ + \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e69de29 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f49a4e1 --- /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. \ No newline at end of file diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..d27ff90 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,4 @@ +include requirements.txt +include README.md +include requirements-test.txt +include VERSION.txt \ No newline at end of file diff --git a/README.md b/README.md index ad11e29..f82c56c 100644 --- a/README.md +++ b/README.md @@ -1 +1,4 @@ # Eppo SDK for Python + +## Supported Python Versions +This version of the SDK is compatible with Python 3.6 and above. \ No newline at end of file diff --git a/VERSION.txt b/VERSION.txt new file mode 100644 index 0000000..8a9ecc2 --- /dev/null +++ b/VERSION.txt @@ -0,0 +1 @@ +0.0.1 \ No newline at end of file diff --git a/eppo_client/__init__.py b/eppo_client/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/eppo_client/example.py b/eppo_client/example.py new file mode 100644 index 0000000..c929f88 --- /dev/null +++ b/eppo_client/example.py @@ -0,0 +1,2 @@ +def add_one(number): + return number + 1 diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..fa7093a --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["setuptools>=42"] +build-backend = "setuptools.build_meta" \ No newline at end of file diff --git a/requirements-test.txt b/requirements-test.txt new file mode 100644 index 0000000..32ec8d6 --- /dev/null +++ b/requirements-test.txt @@ -0,0 +1,3 @@ +tox +pytest +mypy \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..e69de29 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..833d48d --- /dev/null +++ b/setup.cfg @@ -0,0 +1,24 @@ +[metadata] +name = eppo-server-sdk +version = file: VERSION.txt +author = Eppo +author_email = eppo-team@geteppo.com +description = Eppo SDK for Python +long_description = file: README.md +long_description_content_type = text/markdown +url = https://github.com/Eppo-exp/python-sdk +project_urls = + Bug Tracker = https://github.com/Eppo-exp/python-sdk/issues +classifiers = + Programming Language :: Python :: 3 + License :: OSI Approved :: Apache Software License + Operating System :: OS Independent + +[options] +package_dir = + = eppo_client +packages = find: +python_requires = >=3.6 + +[options.packages.find] +where = eppo_client \ No newline at end of file diff --git a/test/example_test.py b/test/example_test.py new file mode 100644 index 0000000..1be1d20 --- /dev/null +++ b/test/example_test.py @@ -0,0 +1,5 @@ +from eppo_client import example + + +def test_example(): + assert example.add_one(3) == 4 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..c4f5d64 --- /dev/null +++ b/tox.ini @@ -0,0 +1,14 @@ +[tox] +envlist = py39 +isolated_build = True + +[testenv] +deps = + -rrequirements.txt + -rrequirements-test.txt +commands = + python -m pytest {posargs} + +[gh-actions] +python = + 3.9: py39 \ No newline at end of file