Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Lee Talman committed Apr 19, 2024
1 parent 35ce7a5 commit 8767a22
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
Python utility that duplicates file modifications over the web via REST API, (or to a local directory) powered by [watchdog](https://github.com/gorakhargosh/watchdog).

## Usage
You can run `restdog.py` as a standalone command-line tool:
```ps
$python restdog.py [-h] [--api] [--interval INTERVAL] [--file_types FILE_TYPES [FILE_TYPES ...]] src_dir dest_dir
Expand All @@ -15,6 +16,14 @@ options:
--interval # update interval in seconds (default: 3600)
--file_types # whitespace-separated list of watched file types (default: "*.csv" "*.xls" "*.xlsx" "*.xlsm")
```
Or install it into your local environment with `pip install restdog`, then invoke the CLI from another module with the `watch()` function:

```py
import restdog

restdog.watch()
```


## Example
```ps
Expand Down

0 comments on commit 8767a22

Please sign in to comment.