Metadata-Version: 2.1
Name: win-roboco-py
Version: 0.5.0
Summary: A wrapper for Window's Robocopy utility.
Keywords: copy,move,filesystem,windows
Author: Emilian Cioca
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft
Project-URL: Bug Tracker, https://github.com/EmilianC/win-roboco-py/issues
Project-URL: Changes, https://github.com/EmilianC/win-roboco-py/blob/main/CHANGELOG.md
Project-URL: Homepage, https://github.com/EmilianC/win-roboco-py
Project-URL: Repository, https://github.com/EmilianC/win-roboco-py

# win-roboco-py
A thin python wrapper around Window's [Robocopy](https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/robocopy) utility.

This package is not intended to cover 100% of Robocopy's functionality.
Instead, the focus of the package is allow you to easily take advantage of Robocopy's robustness for the most common operations.

# Contributions
Pull requests or issue tickets are very welcome and appreciated.

# Quick Usage

```python
import win_roboco_py as robo

# Copies the file to the destination, with the same filename.
robo.copy_file(Path('./src/file.txt'), Path('./dst'))

# Copies the file to the destination, then deletes the source file.
robo.move_file(Path('./src/file.txt'), Path('./dst'))

# Copies all files to the destination.
robo.copy_directory(Path('./src'), Path('./dst'), recursive=True)

# Copies all files to the destination, then deletes the sources.
robo.move_directory(Path('./src'), Path('./dst'), recursive=False)

# Copies all files to the destination, and deletes extra files.
robo.mirror_directory(Path('./src'), Path('./dst'))
```

