Merge pull request #24 from vsoch/add/requests

Paper edits for JoSS, (add/requests, update docs, paper)

Author: vsoch

CHANGELOG.md

@@ -13,6 +13,7 @@ Critical items to know are:
  - changed behaviour
 
 ## [master](https://github.com/vsoch/watchme/tree/master)
+ - requests is missing from install dependencies (0.0.15)
  - small bug fixes (0.0.14)
  - added headers, params, and json args for post and get urls. (0.0.13)
  - added ability to specify URL params for Get and Get with selector functions (0.0.12)

docs/_docs/getting-started/index.md

@@ -16,6 +16,7 @@ watcher below:
  - [Background](#what-is-a-watcher): What is a watcher, exactly?
  - [Setup](#setup-watchme): Watchme on your computer, meaning setting a base with a default watcher
  - [Create a Watcher](#how-do-i-create-a-watcher): Create your first watcher to monitor one or more things
+ - [Rename a Watcher](#how-do-i-rename-a-watcher): Rename a watching by changing the folder name
 
 ## Tasks
 
@@ -114,16 +115,31 @@ Notice how the `--base` argument comes before init? That's because it's a global
 argument, meaning you can supply it to any command group (init, create, etc.). If 
 you don't want to set it and want to change the default, remember that you can
 export `WATCHME_BASE_DIR` in your bash profile for a permanent setting.
+For the reminder of this tutorial, we will assume that you ran init without
+`--empty`, and interact with a watcher named "watcher."
 
 ### How do I create a watcher?
 
-If you didn't create a watcher above, or want to create
+If you didn't create a watcher above (meaning you ran the init command with `--empty`)
+this is ok! You can create as many watchers as you like with the "create" command.
 
 ```bash
-$ watchme init
-Creating /home/vanessa/.watchme...
-Adding watcher /home/vanessa/.watchme/watcher...
-Generating watcher config /home/vanessa/.watchme/watcher/watchme.cfg
+$ watchme create --help
+usage: watchme create [-h] [watchers [watchers ...]]
+
+positional arguments:
+  watchers    watchers to create (default: single watcher)
+
+optional arguments:
+  -h, --help  show this help message and exit
+```
+
+As an example (after running watchme init) let's create a watcher called "weather"
+
+```bash
+$ watchme create weather
+Adding watcher /home/vanessa/.watchme/weather...
+Generating watcher config /home/vanessa/.watchme/weather/watchme.cfg
 ```
 
 You can then see an empty watcher directory is created with a configuration
@@ -132,13 +148,22 @@ file:
 ```bash
 $ tree /home/vanessa/.watchme/
 /home/vanessa/.watchme/
-└── watcher
+└── weather
     └── watchme.cfg
 ```
 
 and what you can't see is that there is a Git repo (a .git folder) in the 
 watcher directory too. Good job! The watcher is set up, and ready to add
-tasks to it.
+tasks to it. 
+
+### How do I rename a watcher?
+
+The watcher name coincides with the folder name. For example, if you created
+the "weather" watcher and want to change the name at a later point, just rename
+the folder. For the remainder of this getting started guide, we will be using
+a watcher named "watcher," so if you didn't create this watcher, you can 
+either create it or rename an existing folder.
+
 
 ### How do I add tasks?
 

docs/pages/changelog.html

@@ -4,7 +4,7 @@
 ---
 
 <p>Subscribe with <a href="{{ site.baseurl }}/feed.xml">RSS</a> to keep up with the latest changes.
-The most detailed and up to date changes are kept with the <a href="{{ site.repo }}/blob/master/CHANGELOG.md">CHANGELOG</a>
+The most detailed and up to date changes are kept with the <a href="https://github.com/vsoch/watchme/blob/master/CHANGELOG.md">CHANGELOG</a>
 with the code base.</p>
 
 <p class="editor-link"><a href="cloudcannon:collections/_posts" class="btn"><strong>&#9998;</strong> Update Change Log</a></p>

paper/paper.md

@@ -169,17 +169,17 @@ While only two commits are shown in the result above, an actual export for this
 The researcher could then perform an [analysis](https://github.com/vsoch/watchme-system/blob/master/data/watchme-task-analysis.ipynb) using the data collected. 
 As an example, here is a plot from such an analysis that tracks virtual memory usage of this author, recorded every hour, over two weekend days. 
 
-![img/virtual-memory-used.png](img/virtual-memory-used.png)
+![Virtual memory usage graph](img/virtual-memory-used.png)
 
 Interestingly, we can see a pattern that correlates with the activity of the author during the day. Virtual memory usage is low from the previous evening (1800 hours) through the early morning (0600 hours) and then rises sharply when the author starts to work. 
 It goes down briefly in the early afternoon when the author pauses for a break, and picks up afterward, stopping when it's time for dinner. 
 We see that the system's core temperature follows a similar trend:
 
-![img/core-temp.png](img/core-temp.png)
+![Core temperature graph](img/core-temp.png)
 
 We also see that the computer was briefly unplugged after the morning work session.
 
-![img/battery.png](img/battery.png)
+![Battery usage graph](img/battery.png)
 
 These kinds of metrics are interesting to answer research questions about system resources and behavior, and represent only the tip of the iceberg in terms of the scope of data that WatchMe could help collect. 
 For example, WatchMe would have interesting use cases for monitoring resources or jobs for HPC, or watching for changes in any kind of web resource (prices, climate data, API endpoints, etc.). 

requirements.txt

@@ -1 +1,3 @@
-python-crontab==2.3.6
+python-crontab>=2.3.6
+configparser>=3.5.3
+requests>=2.21.0

watchme/version.py

@@ -6,7 +6,7 @@
 # with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 
-__version__ = "0.0.14"
+__version__ = "0.0.15"
 AUTHOR = 'Vanessa Sochat'
 AUTHOR_EMAIL = '[email protected]'
 NAME = 'watchme'
@@ -18,6 +18,7 @@
 INSTALL_REQUIRES = (
     ('python-crontab', {"min_version": "2.3.6"}),
     ('configparser', {"min_version": "3.5.3"}),
+    ('requests', {"min_version": "2.21.0"})
 )
 
 ## beautiful soup selection task