Metadata-Version: 2.1
Name: sharpei
Version: 0.4.0
Summary: Watchdog to sync file changes to AWS S3
Home-page: https://github.com/polymathian/sharpei
Author: Polymathian
License: Apache License 2.0
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: System :: Archiving
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# Sharpei

Python watchdog to sync file changes to AWS S3

Requires Python 3.6+

## Usage

Sharpei can be run from the CLI or Docker.

#### CLI

Install from [PyPI](https://pypi.org/project/sharpei/)

```bash
pip install sharpei
```

To run:

```bash
# Monitor the current directory and send all files
> sharpei . s3://bucket/key-prefix/
```

Use `sharpei --help` to discover additional options

#### Docker

You will need to mount a directory to the Docker image as `/data`.

```bash
> docker run --mount type=bind,source=YOUR_DIRECTORY,target=/data sharpei s3://bucket/key-prefix
```

For example, given a folder structure:

```
working-dir
│   README.md
|
└───target-folder
        file011.txt
        file012.txt
```

To monitor file changes in `target-folder`, run:

```bash
> docker run --mount type=bind,source="$(pwd)"/target-folder,target=/data polymathian/sharpei s3://my-bucket/my-prefix
```


