Metadata-Version: 2.1
Name: seaschedule
Version: 0.0.1
Summary: Get sea schedules from Maersk and other shipping lines.
Home-page: https://github.com/alexcheng628/seaschedule
License: Proprietary
Author: Alex Cheng
Author-email: alex28.biz@gmail.com
Maintainer: Alex Cheng
Maintainer-email: alex28.biz@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: pandas (>=1.5.1,<2.0.0)
Requires-Dist: paramiko (>=2.11.0,<3.0.0)
Requires-Dist: requests (>=2.28.1,<3.0.0)
Requires-Dist: tomli (>=2.0.1,<3.0.0)
Project-URL: Documentation, https://github.com/alexcheng628/seaschedule
Project-URL: Repository, https://github.com/alexcheng628/seaschedule
Description-Content-Type: text/markdown

# seaschedule
Get sea schedules from Maersk and other shipping lines.

## Installation
From [PyPI](https://pypi.org/project/seaschedule/):

    python -m pip install seaschedule

## Setup
The following setup must be done before running seaschedule:
1. Create below environment variables in your OS environment:
    * `SS_SMTP_HOST`: SMTP host for sending notification emails
    * `SS_IB_SFTP_USER`: SFTP user for uploading schedule files to Information Broker
    * `SS_IB_SFTP_PWD`: SFTP password for uploading schedule files to Information Broker
    * `SS_MAEU_API_KEY`: API key given by Maersk 
<br/><br/>
2. Specify below directory paths in `site-packages\seaschedule\config\config.toml` for storing the schedule data files and log files. For example:
    ```
    [environment]
    directory.data = "/home/user1/seaschedule/data"
    directory.log = "/home/user1/seaschedule/log"

    # Windows
    directory.data = "C:\Users\user1\Documents\seaschedule\data"
    directory.log = "C:\Users\user1\Documents\seaschedule\data"
    ```

## How to Use
seaschedule is a console application, named `seaschedule`.

    >>> python -m seaschedule

