From 1e6668e606b33846b8ff0bfbc459fae3de145e8d Mon Sep 17 00:00:00 2001 From: Joseph Hunkeler Date: Sat, 10 Mar 2018 16:33:25 -0500 Subject: Initial commit --- README.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..a547c76 --- /dev/null +++ b/README.md @@ -0,0 +1,69 @@ +# Firewatch + +Is your user-base complaining their environment(s) broke after running `conda update [your_package]`? I bet they are! Have you ever wondered what packages were introduced into the Conda ecosystem without your knowledge? Wonder no more! + +## License + +BSD 3-clause + +## Support + +- None. +- Use at your own risk. + +## Requirements + +This utility requires Python 3.6 or greater and `requests`. + +## Usage + +``` +$ firewatch --help +usage: firewatch [-h] [--benchmark] [--brute-force] [--channel CHANNELS] + [--order ORDER] [--platform PLATFORMS] + [--time-span TIME_SPAN] + +optional arguments: + -h, --help show this help message and exit + --benchmark Display total time to parse and sort channel data + --brute-force Derive timestamps from HTTP header: "last-modified" + --channel CHANNELS, -c CHANNELS + Conda channel + --order ORDER, -o ORDER + [asc|dsc] + --platform PLATFORMS, -p PLATFORMS + [linux|osx|win]-[32|64] + --time-span TIME_SPAN, -t TIME_SPAN + i[s|m|h|d|w|M|y|D|c] (120s, 12h, 1d, 2w, 3m, 4y) +``` + + +## Examples + +_What's probably broken within..._ + +... the last 24 hours? + +```bash +$ firewatch -t 1d +``` + +... the last week? + +```bash +$ firewatch -t 1w +``` + +... three days on some high profile anaconda.org channels? + +```bash +$ firewatch -t 3d -c conda-forge -c intel +``` + +... the last month on AstroConda? + +```bash +$ firewatch -t 1M -c http://ssb.stsci.edu/astroconda +``` + + -- cgit