Metadata-Version: 2.1
Name: vipwrap
Version: 0.1.0
Summary: Python package that allows interacting with VIP.
Home-page: https://github.com/pepsimidamerica/vippy
Author: Jordan Maynor
Author-email: jmaynor@pepsimidamerica.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: The Unlicense (Unlicense)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: paramiko
Requires-Dist: pandas
Requires-Dist: pandera

# Summary

TODO: Need to rename project. Conflicts with a a package on PyPI.

At the moment, the package is mainly just a wrapper around FTP and SFTP libraries. It's used to upload files to VIP's GDI system. But could be expanded on with SQL functionality or if VIP ever added a genuine API in the future.

As is, the point of the package is largely just defining how to upload a file to VIP in one place so it doesn't need to be rewritten every time a repo involving VIP is created and can instead just be imported.

There are also pandera models defined for an order and an invoice.

## Installation

`pip install vipwrap`

Import done as below. Will rewrite package with distribution name once I find a valid one that isn't too similar to existing package in PyPI.

```python
import vippy
```

## Usage

Currently consists of one function.

### Send File to VIP

Takes standard parameters expected of uploading an existing local file to a remote location via FTP or SFTP.

| parameter | type | description |
| - | - | - |
| ftp_method | str | 'ftp' or 'sftp' |
| host | str | the FTP server host |
| port | int | the SFTP server port, not used with FTP |
| user | str | username to authenticate with |
| password | str | password to authenticate with |
| folder | str | The base folder location to upload the file to |
| file | IO[str] | File stream being uploaded. Usually the output of an open() function |
