Metadata-Version: 2.1
Name: daily-udw-upload
Version: 1.1.2
Summary: Upload of daily underway data received from ships by mail to cloud storage
Home-page: UNKNOWN
Author: Claas Faber, GEOMAR Data Management
License: Copyright (c) 2019, Claas Faber, GEOMAR Data Management
Requires-Dist: gmr-underway-connect
Requires-Dist: pyocclient
Requires-Dist: click

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are NOT PERMITTED
without prior permission by GEOMAR data management team. INTERNAL USE ONLY.

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Description: # Upload of daily underway data
        tool for automatic upload of underway data sent by ships.
        
        # Prerequisites
        You need to provide
        * python > 3.6
        * working internet connection
        * password for mailbox dm-data for download of data sets
        * nextcloud instance URL. Default provided
        * nextcloud user + password; use an app password here, *never* your account password!
        * a base folder in your cloud + a sub folder for each platform you want to import. Defaults are configured
        
        # Installation
        ```bash
        (.venv) bash$ pip install --index-url https://pypi.fury.io/cfgmr/ daily-udw-upload
        ```
        
        ## Optional: create/ activate virtual environment
        Use conda, virtualenv, pipenv or your favourite flavour. You know what to do
        
        # Usage
        ```bash
        (.venv) bash$ export DAILY_UDW_CLOUD_USER=mememe
        (.venv) bash$ export DAILY_UDW_CLOUD_PWD=SECRET
        (.venv) bash$ export UDW_MAIL_PASSWD=TOPSECRET
        (.venv) bash$ export upload_daily_underway_data meteor
        (.venv) bash$ export upload_daily_underway_data merian
        (.venv) bash$ export upload_daily_underway_data alkor
        (.venv) bash$ export upload_daily_underway_data sonne
        ```
        
        # Automation
        upload of daily data for Alkor, Merian, Meteor and Sonne is automatically performed
        by running the ci pipeline every two hours. The test job includes a test which performs the upload, and the
        pipeline is  running on a [schedule](https://git.geomar.de/dm/daily_udw_upload/pipeline_schedules)
        
        Running the import from a CI schedule is currently done as a test of feasibility. The job will most likely
        be moved to the VM dm-ingest-www at a later time.
        
        
        
        
Platform: UNKNOWN
Requires-Python: >= 3.6