From commits-return-21480-apmail-airavata-commits-archive=airavata.apache.org@airavata.apache.org Fri Oct 11 20:42:13 2019 Return-Path: X-Original-To: apmail-airavata-commits-archive@www.apache.org Delivered-To: apmail-airavata-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [207.244.88.153]) by minotaur.apache.org (Postfix) with SMTP id 3865019D8B for ; Fri, 11 Oct 2019 20:42:13 +0000 (UTC) Received: (qmail 74132 invoked by uid 500); 11 Oct 2019 20:42:09 -0000 Delivered-To: apmail-airavata-commits-archive@airavata.apache.org Received: (qmail 73954 invoked by uid 500); 11 Oct 2019 20:42:09 -0000 Mailing-List: contact commits-help@airavata.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@airavata.apache.org Delivered-To: mailing list commits@airavata.apache.org Received: (qmail 73359 invoked by uid 99); 11 Oct 2019 20:42:08 -0000 Received: from ec2-52-202-80-70.compute-1.amazonaws.com (HELO gitbox.apache.org) (52.202.80.70) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 11 Oct 2019 20:42:08 +0000 Received: by gitbox.apache.org (ASF Mail Server at gitbox.apache.org, from userid 33) id DFD59811DE; Fri, 11 Oct 2019 20:42:07 +0000 (UTC) Date: Fri, 11 Oct 2019 20:42:21 +0000 To: "commits@airavata.apache.org" Subject: [airavata-custos] 14/24: initial python custos library MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit From: machristie@apache.org In-Reply-To: <157082652754.4215.9107757484496232998@gitbox.apache.org> References: <157082652754.4215.9107757484496232998@gitbox.apache.org> X-Git-Host: gitbox.apache.org X-Git-Repo: airavata-custos X-Git-Refname: refs/heads/master X-Git-Reftype: branch X-Git-Rev: e56d294223fb10e1ddd3893d93b596e294d637b2 X-Git-NotificationType: diff X-Git-Multimail-Version: 1.5.dev Auto-Submitted: auto-generated Message-Id: <20191011204207.DFD59811DE@gitbox.apache.org> This is an automated email from the ASF dual-hosted git repository. machristie pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/airavata-custos.git commit e56d294223fb10e1ddd3893d93b596e294d637b2 Author: Marcus Christie AuthorDate: Fri Sep 6 09:06:32 2019 -0400 initial python custos library --- .gitignore | 1 + clients/python/.gitignore | 4 + clients/python/LICENSE | 201 ++++++++++++++++++++++++++ clients/python/README.md | 1 + clients/python/airavata_custos/__init__.py | 20 +++ clients/python/airavata_custos/well_knowns.py | 30 ++++ clients/python/requirements_dev.txt | 13 ++ clients/python/setup.cfg | 26 ++++ clients/python/setup.py | 26 ++++ clients/python/tests/__init__.py | 0 clients/python/tests/test_well_knowns.py | 38 +++++ clients/python/tox.ini | 22 +++ 12 files changed, 382 insertions(+) diff --git a/.gitignore b/.gitignore index 6366460..d0ada35 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .idea/* *.iml target/* +.vscode diff --git a/clients/python/.gitignore b/clients/python/.gitignore new file mode 100644 index 0000000..836c896 --- /dev/null +++ b/clients/python/.gitignore @@ -0,0 +1,4 @@ +venv +airavata_custos.egg-info +*.pyc +.tox diff --git a/clients/python/LICENSE b/clients/python/LICENSE new file mode 100644 index 0000000..f49a4e1 --- /dev/null +++ b/clients/python/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/clients/python/README.md b/clients/python/README.md new file mode 100644 index 0000000..5c4de03 --- /dev/null +++ b/clients/python/README.md @@ -0,0 +1 @@ +# Airavata Custos Python SDK diff --git a/clients/python/airavata_custos/__init__.py b/clients/python/airavata_custos/__init__.py new file mode 100644 index 0000000..227c90f --- /dev/null +++ b/clients/python/airavata_custos/__init__.py @@ -0,0 +1,20 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You 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. +# + +""" +airavata_custos is the Python API for Airavata Custos. +""" diff --git a/clients/python/airavata_custos/well_knowns.py b/clients/python/airavata_custos/well_knowns.py new file mode 100644 index 0000000..45e6ed6 --- /dev/null +++ b/clients/python/airavata_custos/well_knowns.py @@ -0,0 +1,30 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You 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. +# + +""" +Define URIs needed for configuring OIDC clients. +""" + + +def get_well_known_oidc_uri_for_realm(realm): + return ("https://iam.scigap.org/auth/realms/{}/.well-known/" + "openid-configuration".format(realm)) + + +def get_dev_well_known_oidc_uri_for_realm(realm): + return ("https://iamdev.scigap.org/auth/realms/{}/.well-known/" + "openid-configuration".format(realm)) diff --git a/clients/python/requirements_dev.txt b/clients/python/requirements_dev.txt new file mode 100644 index 0000000..a1d25f4 --- /dev/null +++ b/clients/python/requirements_dev.txt @@ -0,0 +1,13 @@ +atomicwrites==1.3.0 +attrs==19.1.0 +autopep8==1.4.3 +entrypoints==0.3 +flake8==3.7.7 +mccabe==0.6.1 +pluggy==0.9.0 +py==1.8.0 +pycodestyle==2.5.0 +pyflakes==2.1.1 +pytest==4.3.0 +pytest-runner==4.4 +six==1.12.0 diff --git a/clients/python/setup.cfg b/clients/python/setup.cfg new file mode 100644 index 0000000..4101d6d --- /dev/null +++ b/clients/python/setup.cfg @@ -0,0 +1,26 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You 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. +# + +[bdist_wheel] +universal = 1 + +[metadata] +description-file = README.md +license_file = LICENSE + +[aliases] +test = pytest diff --git a/clients/python/setup.py b/clients/python/setup.py new file mode 100644 index 0000000..e56024b --- /dev/null +++ b/clients/python/setup.py @@ -0,0 +1,26 @@ + +from setuptools import setup, find_packages + +setup_requirements = ['pytest-runner', ] + +test_requirements = ['pytest', ] + +setup( + name='airavata_custos', + version="0.0.1", + description='Apache Airavata Custos Python API', + author='Airavata Custos Developers', + author_email='custos@airavata.apache.org', + packages=find_packages(include=['airavata_custos']), + license='Apache License 2.0', + setup_requires=setup_requirements, + test_suite='tests', + tests_require=test_requirements, + classifiers=[ + 'Development Status :: 5 - Production/Stable', + 'License :: OSI Approved :: Apache Software License', + 'Programming Language :: Python :: 2.7', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.6' + ] +) diff --git a/clients/python/tests/__init__.py b/clients/python/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/clients/python/tests/test_well_knowns.py b/clients/python/tests/test_well_knowns.py new file mode 100644 index 0000000..8be65b2 --- /dev/null +++ b/clients/python/tests/test_well_knowns.py @@ -0,0 +1,38 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You 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. +# + +""" +Tests for the well_knowns module. +""" + +from airavata_custos import well_knowns + + +def test_get_well_known_oidc_uri_for_realm(): + well_known_oidc_uri = well_knowns.get_well_known_oidc_uri_for_realm( + "test-realm") + assert (well_known_oidc_uri == + "https://iam.scigap.org/auth/realms/" + "test-realm/.well-known/openid-configuration") + + +def test_get_dev_well_known_oidc_uri_for_realm(): + well_known_oidc_uri = well_knowns.get_dev_well_known_oidc_uri_for_realm( + "test-realm") + assert (well_known_oidc_uri == + "https://iamdev.scigap.org/auth/realms/" + "test-realm/.well-known/openid-configuration") diff --git a/clients/python/tox.ini b/clients/python/tox.ini new file mode 100644 index 0000000..d6e2cc2 --- /dev/null +++ b/clients/python/tox.ini @@ -0,0 +1,22 @@ + +[tox] +envlist = py27, py36, flake8 + +[testenv:flake8] +basepython = python +deps = flake8 +commands = flake8 airavata_custos + +[testenv] +setenv = + PYTHONPATH = {toxinidir} +deps = + -r{toxinidir}/requirements_dev.txt +; If you want to make tox run the tests with the same versions, create a +; requirements.txt with the pinned versions and uncomment the following line: +; -r{toxinidir}/requirements.txt +commands = + pip install -U pip + py.test --basetemp={envtmpdir} + +