Metadata-Version: 2.1
Name: send-ip
Version: 0.0.7
Summary: python package to send its own IP to another machine through ssh
Home-page: https://github.com/matiasandina/send_ip
Author: Matias Andina
Author-email: matiasandina@gmail.com
License: UNKNOWN
Description: # Send IP
        
        Python software to configure machines for sending their IP through ssh.
        
        ## Installation
        
        Run the following to install:
        
        ```python
        pip3 install send_ip
        ```
        
        ## Usage
        
        1. Edit the `config.yaml` file to match your destination. These fields will be used to `scp` into the target machine (`user@ip:port` using password `pass` to login).
        
        ```yaml
        user: target-user
        ip: ip-address
        pass: target-password
        port: target-port #default port is usually 22 
        remote-path: target-folder # this folder will be created under /home/user might create errors for not linux users
        refresh-freq: 15 # minutes for cron-job
        ```
        2. Use the pacakge functions, for example:
        
        ```
        from send_ip.send_ip import *
        
        info_file = create_info()
        send_info(info_file)
        ```
        
        You can save this into a `send_ip_script.py` and schedule this task to run automatically (see below)
        
        ## Schedule task
        
        ### Chron
        
        
        ### Windows machines
        
        Please refer to [this example](https://stackoverflow.com/a/59079452/3215940) and file issues if having trouble.
        
        ## For developers of `send_ip`
        
        To install `send_ip` and tools needed for tests, you can install into a virtualenvironment like so:
        
        ```bash
        pip install -e .[dev]
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Provides-Extra: dev
