From ca6a7f96a59d46ce0583fa62eeb49d803f3f5a63 Mon Sep 17 00:00:00 2001 From: Nao Ueda Date: Wed, 11 Mar 2020 09:29:36 +0900 Subject: initial commit. --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..b096a61 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# Papertrail log archives downloader + +## Usage + +Please set your token to the environment variable named `PAPERTRAIL_API_TOKEN` to run the script. + +```bash +$ PAPERTRAIL_API_TOKEN=YOUR_TOKEN ./ppad.py # Download all the log archives +$ PAPERTRAIL_API_TOKEN=YOUR_TOKEN ./ppad.py 2020-01-01~2020-02-01 # Download the archives which have logged January 2020 +$ PAPERTRAIL_API_TOKEN=YOUR_TOKEN ./ppad.py 2020-01-01~ # Specified the since date (including the since date file) +$ PAPERTRAIL_API_TOKEN=YOUR_TOKEN ./ppad.py ~2020-02-01 # Specified the until date (NOT including the until date file) +``` + +The date format is ISO-8601 format supported. + +(The script uses [dateutil.isoparse](https://dateutil.readthedocs.io/en/stable/parser.html#dateutil.parser.isoparse)) -- cgit v1.2.3-54-g00ecf