Metadata-Version: 2.1
Name: Gdirsync
Version: 0.1.0
Summary: Simple multi-platform file syncing tool
Home-page: https://github.com/chrisbeardy/Gdirsync
Author: Christopher Beard
Author-email: christopherbeard@pm.me
License: UNKNOWN
Keywords: directory,folder,update,synchronisation
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Utilities
Classifier: Topic :: Desktop Environment
Classifier: Topic :: System :: Archiving :: Backup
Classifier: Topic :: System :: Archiving :: Mirroring
Requires-Python: >=3.5
Description-Content-Type: text/markdown

# Gdirsync

[![Build Status](https://travis-ci.com/chrisbeardy/Gdirsync.svg?branch=master)](https://travis-ci.com/chrisbeardy/Gdirsync)
[![Documentation Status](https://readthedocs.org/projects/gdirsync/badge/?version=latest)](https://gdirsync.readthedocs.io/en/latest/?badge=latest)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

Gdirsync is a simple multi-platform file syncing tool written in python.

Gdirsync at its simplest is a GUI wrapper for the dirsync library https://pypi.org/project/dirsync/

## Running the program using python
Clone the repository and run the python file
```
git clone https://github.com/chrisbeardy/Gdirsync.git
cd Gdirsync
pip install -r requirements.txt
python gdirsync/gdirsync.py 
```

## Development and build
Developing should be done inside a virtualenv.

Python requirements for development and build can be found in requirements.txt and requirements-dev.txt, use
```
pip install -r requirements.txt
pip install -r requirements-dev.txt
```

use pyinstaller to build an executable

```
pyinstaller gdirsync.spec
```

### Docs
Docs are written using Sphinx and hosted on read the docs, requirements for generating documentation locally are in docs/requirements.txt, use
```
pip install -r docs/requirements.txt
```


