diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000000000000000000000000000000000000..c5a70023c1ca02f91c63cab956d4ec940f8a2895 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,202 @@ + 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 2022 Stichting Nederlandse Wetenschappelijk Onderzoek Instituten, + ASTRON Netherlands Institute for Radio Astronomy + + 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. diff --git a/README.md b/README.md index 71053a66b19a988668ee3f18a6f44a060b02fe4e..9fb14f6ea9d569ecf3fd70260875bb80bdd2c22b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # adex-elastic-crawler -The adex-crawler is a pip installable runnable package that gathers data from our several ASTRON archives to deliver it to an Elastic Search instance in SDC where ADEX can access it. \ No newline at end of file +The adex-elastic crawler is a pip installable runnable package that gathers data from our several ASTRON archives to deliver it to an Elastic Search instance in SDC where ADEX can access it. + +## Installation + +### build +> build.sh +> upload_to_nexus.sh + +### deploy +> pip install https://support.astron.nl/nexus/content/repositories/snapshots/nl/astron/atdb/adex-elastic-crawler-1.0.0.tar.gz --upgrade + +## Running + +> adex_elastic_crawler -h + diff --git a/README.rst b/README.rst new file mode 100644 index 0000000000000000000000000000000000000000..caf200e01b133330efb8deb45f47078047d384de --- /dev/null +++ b/README.rst @@ -0,0 +1,6 @@ +adex-elastic-crawler +==================== + +The adex-crawler is a pip installable runnable package that gathers data from our several ASTRON archives to deliver it to an Elastic Search instance in SDC where ADEX can access it. + +See 'adex_elastic_crawler -h' for help \ No newline at end of file diff --git a/build.sh b/build.sh new file mode 100644 index 0000000000000000000000000000000000000000..916fad351703a2861b8a6139d8b56591ef5f52c2 --- /dev/null +++ b/build.sh @@ -0,0 +1,9 @@ +#!/bin/bash +# This script make a source distribution for the pip installable package in the current folder +echo "Build package for adex-elastic-crawler" +python --version +# Explicit give format otherwise a zip is created (Windows?) +python setup.py sdist --formats=gztar + +# Next command will not close the window, can be handy if something goes wrong +# exec $SHELL \ No newline at end of file diff --git a/crawler/__init__.py b/crawler/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/crawler/main.py b/crawler/main.py new file mode 100644 index 0000000000000000000000000000000000000000..0aea518b3bf02f4a863e76f13b07317622ba9412 --- /dev/null +++ b/crawler/main.py @@ -0,0 +1,26 @@ +import argparse +import os + +def run_crawler(args): + + if args.mode == 'simulate': + pass + else: + pass + + +def main(): + parser = argparse.ArgumentParser(fromfile_prefix_chars='@') + + parser.add_argument("--mode", default="simulate", help="simulated data") + args = args = parser.parse_args() + + print("--- adex-elastic-crawler (version 10 feb 2022) ---") + print(args) + + run_crawler(args) + +if __name__ == '__main__': + main() + + diff --git a/scripts/start_adex_elastic_crawler.sh b/scripts/start_adex_elastic_crawler.sh new file mode 100644 index 0000000000000000000000000000000000000000..be8ca64671670ed2b9293fe8d8a6153a0e796241 --- /dev/null +++ b/scripts/start_adex_elastic_crawler.sh @@ -0,0 +1,3 @@ +#!/bin/sh +# example script that shows how to script the crawler +adex_elastic_crawler -h \ No newline at end of file diff --git a/setup.py b/setup.py new file mode 100644 index 0000000000000000000000000000000000000000..81e289c4665119b9e6ec35b131e814076030bcda --- /dev/null +++ b/setup.py @@ -0,0 +1,20 @@ +from setuptools import setup, find_packages + +setup(name='adex-elastic-crawler', + version='1.0.0', + description='Crawler package to gather ASTRON data for Elastic Search for use by ADEX', + url='https://git.astron.nl/astron-sdc/adex-elastic-crawler', + author='Fanna Lautenback, Nico Vermaas', + author_email='vermaas@astron.nl', + license='Apache 2.0', + install_requires=['requests'], + packages=find_packages(), + #packages=['astrobase_services'], + include_package_data=True, + entry_points={ + 'console_scripts': [ + 'adex_elastic_crawler=crawler.main:main', + ], + }, + scripts=['scripts/start_adex_elastic_crawler.sh'], + ) \ No newline at end of file diff --git a/upload_to_nexus.sh b/upload_to_nexus.sh new file mode 100644 index 0000000000000000000000000000000000000000..7bf1ffecb759dea150a9e66de811e718074d4ce0 --- /dev/null +++ b/upload_to_nexus.sh @@ -0,0 +1,21 @@ +#!/bin/bash + +VERSION=$(python setup.py --version) +ARTIFACT_NAME="adex-elastic-crawler" +ARTIFACT_BUILD="/dist/adex-elastic-crawler-${VERSION}.tar.gz" + +ARTIFACT_UPLOAD_BASE_PATH="https://support.astron.nl/nexus/content/repositories/snapshots/nl/astron/atdb/" +if [[ $# -eq 1 ]]; then + ARTIFACT_VERSION="-${VERSION}-${1}" +else + ARTIFACT_VERSION="-${VERSION}" +fi + +ARTIFACT_UPLOAD_PATH="${ARTIFACT_UPLOAD_BASE_PATH}${ARTIFACT_NAME}${ARTIFACT_VERSION}.tar.gz" +ARTIFACT_BUILD_PATH="$(pwd)${ARTIFACT_BUILD}" + +echo "Upload ${ARTIFACT_BUILD_PATH} to $ARTIFACT_UPLOAD_PATH" +curl --insecure --upload-file ${ARTIFACT_BUILD_PATH} -u upload:upload ${ARTIFACT_UPLOAD_PATH} + +# Next command will not close the window, can be handy if something goes wrong +exec $SHELL \ No newline at end of file