svn commit: r1683031 - in /comdev/tools: events_list/ events_list/Dockerfile events_list/get_meetups events_list/readme.md get_meetups

[rg...@apache.org]

Author: rgardler
Date: Tue Jun  2 02:45:21 2015
New Revision: 1683031

URL: http://svn.apache.org/r1683031
Log:
Move the meetups script into its own directory and provide a Dockerfile for those who like containerized development. Add a readme.

Added:
    comdev/tools/events_list/
    comdev/tools/events_list/Dockerfile
    comdev/tools/events_list/get_meetups
      - copied unchanged from r1683027, comdev/tools/get_meetups
    comdev/tools/events_list/readme.md
Removed:
    comdev/tools/get_meetups

Added: comdev/tools/events_list/Dockerfile
URL: http://svn.apache.org/viewvc/comdev/tools/events_list/Dockerfile?rev=1683031&view=auto
==============================================================================
--- comdev/tools/events_list/Dockerfile (added)
+++ comdev/tools/events_list/Dockerfile Tue Jun  2 02:45:21 2015
@@ -0,0 +1,6 @@
+FROM python:2.7
+
+COPY . /project
+WORKDIR /project
+
+CMD ["python", "./get_meetups"]
\ No newline at end of file

Added: comdev/tools/events_list/readme.md
URL: http://svn.apache.org/viewvc/comdev/tools/events_list/readme.md?rev=1683031&view=auto
==============================================================================
--- comdev/tools/events_list/readme.md (added)
+++ comdev/tools/events_list/readme.md Tue Jun  2 02:45:21 2015
@@ -0,0 +1,56 @@
+This directory contains tools that are useful for creating and
+managing a list of events related to the ASF.
+
+# Docker Container #
+
+A Docker container is provided to make it as easy as possible to work
+with these scripts.
+
+To build the container:
+
+    $ docker build -t events .
+
+To run the container:
+
+    $ docker run events
+
+By default this runs the get_meetups script (which at the time of
+writing is the only script availble).
+
+# get_meetups #
+
+Produces three files containing possible Apache-related meetups. One
+is formatted to paste onto a mailing list. One is suggested tweets.
+One is for pasting into apache.org/events/meetups.mdtext
+
+Note that these are POSSIBLY Apache-related. Typically, there's around
+a 50% false positive rate, what with hiking trails, native American
+dance enthusiasts, and heilcopter fans. These lists MUST be manually
+filtered before they are used anywhere publicly.
+
+If you use this script be respectful of the included API key.
+
+## Working with the results ##
+
+At the time of writing get_meetups script writes results to the file
+system. Since a container is immutable this means that you never
+actually get to see the results. There are two workarounds for this,
+depending on your preference. You can work in a shell in the container
+or you can mount your client directory in the container
+
+### Working in a shell ###
+
+    $ docker run -it events bash
+
+Will put you in a bash shell in the container, from there you can run:
+
+    $ python getmeetups
+
+and view the files before exiting the container.
+
+### Mounting a host directory ###
+
+    $ docker run -v /path/to/host/directory:/project events
+
+This will run the script as normal but since you have mounted your host
+directory the files will be accessible from the host.