Metadata-Version: 2.1
Name: flashtool
Version: 0.0.2
Summary: A few ready-to use python tools for machine learning
Home-page: https://github.com/Gatech-Flash/FlashPythonToolbox
Author: Haoming Jiang
Author-email: jianghm.ustc@gmail.com
License: UNKNOWN
Description: # FlashPythonToolbox
        A few ready-to use python tools for machine learning
        
        ## Install
        ```
        pip install flashtool
        ```
        
        ## Logger (to file)
        For every print function, we print a copy to file without changing the whole file.
        
        ```python
        Logger(filepath = "./log.txt", mode = "w", stdout = None)
        ```
        - `filepath`: output path. Default: "./log.txt"
        - `mode`: write mode, e.g., w,w+,a,a+. Default: "w"
        - `stdout`: capture which print source. Default: "sys.stdout"
        
        Example:
        ```python
        from flashtool import Logger
        import sys
        sys.stdout = Logger("path/to/log/file/log.txt")
        sys.stdout = Logger("path/to/log/file/log.txt","w")
        sys.stdout = Logger("path/to/log/file/log.txt","w", sys.stdout)
        ```
        
        ## Email Module
        
        Default Sender: `gtflashauto@gmail.com`. You need a password for this.
        
        ```python
        # Function api
        def send_email(port = 587,password = None,
                sender_email = "gtflashauto@gmail.com",
                smtp_server="smtp.gmail.com",
                receiver_email = None,
                subject="Subject",
                message="Hello! "):
            ...
        
        # Example
        from flashtool import send_email
        send_email(receiver_email="xxx@gmail.com", subject="Hi", message="first email")
        ```
        
        ## Track Job
        
        Track your job. Send you an email when it is done.
        
        **Tracking by PID**
        Step 1: find your job pid by `ps`, e.g., `ps aux | grep python`
        Step 2:
        ```python
        from flashtool import checkpid
        f(12345,5,"xxx@gmail.com")
        ```
        *API*:
        ```python
        def trackpid(pid, checktime=1, receiver_email=None, sender_email="gtflashauto@gmail.com", msg=""):
          ...
        ```
        - `checktime`: check pid every `checktime` seconds
        - `msg`: additional message
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.0
Description-Content-Type: text/markdown
