Metadata-Version: 2.1
Name: synchro
Version: 0.0.0rc2
Summary: Customisable file transfers using rsync
Home-page: https://github.com/instituteofcancerresearch/synchro
Author: Adam Tyson
Author-email: code@adamltyson.com
License: UNKNOWN
Project-URL: Source, https://github.com/instituteofcancerresearch/synchro
Project-URL: Tracker, https://github.com/instituteofcancerresearch/synchro/issues
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev

# synchro
Customisable file transfers using rsync

---

## To install
To install, you need a Unix-based system with conda (miniconda or anaconda) installed.

```bash
conda create --name synchro python=3.9
conda activate synchro
pip install synchro
```

If you don't have rsync installed, you will need to do so. E.g. on macOS 
it can be installed with homebrew:
```bash
brew install rsync
```

## To use
`synchro` has two modes of use on the command line, either with flags, or a config file.

### Command line flags
**Not yet implemented**


### Config file
The only input is the path to a source directory (the one being transferred).
```bash
synchro /path/to/source_directory
```

This source directory must contain a `file_transfers.conf` file which contains the 
information needed for the transfer.
```text
destination = /path/to/destination_directory # Where to move the data to
untar = y # Untar the data after copying?
create_dest = y # Create the destination directory if it doesn't exist?
transfer_ready_file = ready.txt # Not yet implemented
```

N.B. the destination can also be on a remote host (an ssh key must be set up), e.g.:
```text
destination = user@IP:/path/to/destination_directory
```

