tidy up, rename osx services, stub for changelog, remove homebrew, ad…

…d osx gthnk script

bin/gthnk

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+# Open Gthnk in the default web browser
+open "http://localhost:1620"

bin/integration.py

@@ -3,11 +3,7 @@
 # gthnk (c) Ian Dennis Miller
 
 import sys
-
 import click
-import os
-import random
-import string
 import warnings
 
 from flask.exthook import ExtDeprecationWarning
@@ -39,43 +35,19 @@ def cli():
 
 @cli.command('install', short_help='integrate Gthnk with the operating system')
 def do_install():
+    sys.path.insert(0, '.')
+    from gthnk.integration import make_config
     config = make_config()
     config["do_install"](config)
 
 
 @cli.command('uninstall', short_help='remove Gthnk installation')
 def do_uninstall():
+    sys.path.insert(0, '.')
+    from gthnk.integration import make_config
     config = make_config()
     config["do_uninstall"](config)
 
 
-def make_config():
-    sys.path.insert(0, '.')
-    from gthnk.integration.osx import install_osx, uninstall_osx
-    from gthnk.integration.windows import install_windows, uninstall_windows
-
-    chars = string.ascii_letters + string.digits + '^!$&=?+~#-_.:,;'
-
-    if os.name == 'nt':
-        config = {
-            'secret_key': repr(os.urandom(24)),
-            'hash_salt': "".join([random.choice(chars) for _ in range(24)]),
-            'home_directory': os.environ["USERPROFILE"],
-            "app_data": os.environ["APPDATA"],
-            'do_install': install_windows,
-            'do_uninstall': uninstall_windows,
-        }
-    else:
-        config = {
-            'secret_key': repr(os.urandom(24)),
-            'hash_salt': "".join([random.choice(chars) for _ in range(24)]),
-            'home_directory': os.path.expanduser("~"),
-            'do_install': install_osx,
-            'do_uninstall': uninstall_osx,
-        }
-
-    return(config)
-
-
 if __name__ == '__main__':
     cli()

docs/Todo.md

@@ -2,33 +2,34 @@
 
 ## Milestone 1
 
-- [ ] rename OS X integration services
 - [ ] bug: fix date picker
 - [ ] bug: image attachments not centering
 - [ ] improvement: narrow screen rendering
 - [ ] improvement: remove /admin prefix on URLs
 
 ## Milestone 2
 
+- [ ] powerpoint presentation
 - [ ] produce installation videos
 - [ ] produce overview video
 - [ ] produce usage video
-- [ ] overview powerpoint presentation
 - [ ] more robust testing of journal_explorer attachments
-- [ ] installers - windows setup.exe and osx .pkg for Python/virtualenv
 - [ ] enable flake8 Dxxx checks
-- [ ] testing for integration, somehow
+- [ ] testing for integration.py
+- [ ] fill out changelog
 
 ## Milestone 3
 
+- [ ] installers - windows setup.exe and osx .pkg for Python/virtualenv
 - [ ] integration for Debian/Ubuntu-flavored Linux
 - [ ] integration for Redhat/Fedora-flavored Linux
 
-## Done
+## Ready for Upcoming Release
 
 - [x] integration for Windows
 - [x] refresh documentation with new installation procedures
 - [x] testing for View components
 - [x] code coverage
 - [x] basic testing for Model components
 - [x] testing for Librarian
+- [x] rename OS X integration services

docs/about/history.rst

@@ -1,8 +1,15 @@
 History of gthnk
 ================
 
-I began documenting my work-related thoughts in a *work journal* circa 2006.  Initially, I used Open Office templates.  I chose to separate journal entries with a timestamp because I could type it pretty quickly on a numeric keypad.  I iterated through quite a few methods for keeping a chronological sequence of entries until I ended up with **gthnk**.
+I began documenting my work-related thoughts in a *work journal* circa 2006.
+Initially, I used Open Office templates.
+I chose to separate journal entries with a timestamp because I could type it pretty quickly on a numeric keypad.
+I iterated through quite a few methods for keeping a chronological sequence of entries until I ended up with **gthnk**.
 
-This work was inspired by DevonThink, which I really tried to use.  For me, I needed a less opaque container for my information.  I wanted my text files to stay text files, because my concern was that years or decades down the road, I would not be able to access text files stored in a DevonThink filesystem container.
+This work was inspired by DevonThink, which I really tried to use.
+For me, I needed a less opaque container for my information.
+I wanted my text files to stay text files, because my concern was that years or decades down the road, I would not be able to access text files stored in a DevonThink filesystem container.
 
-This work was also inspired by Vernor Vinge's *Marooned in Realtime*, which featured a companion-like computer called "Greenthink".  This computer presented an interface that was hight customized to the person who trained and used their Greenthink system.
+This work was also inspired by Vernor Vinge's *Marooned in Realtime*, which featured a companion-like computer called "GreenInc".
+This computer presented an interface that was hight customized to the person who trained and used their GreenInc system.
+Ironically enough, I misremembered the name of Vinge's system as "GreenThink" to the extent that I had used it as a name for an earlier prototype of the Gthnk system.

docs/changelog.rst

@@ -0,0 +1,32 @@
+Changelog
+=========
+
+0.5.0
+-----
+
+- 2017-11-XX
+- ...
+
+0.4.0
+-----
+
+- 2016-01-05
+- 20f71c7a773c2321b52b421b831d039ef23d6d01
+
+0.3.0
+-----
+
+- 2015-01-31
+- 70efeefdfb4d5e54bb8713d94301375b68db8c08
+
+0.2.0
+-----
+
+- 2014-11-15
+- b8793334ccd918a3ca5f0739ca668527e08de1b4
+
+0.1.0
+-----
+
+- 2013-12-09
+- 90fd96647ca24d568d16779420029c8fbb2d41b6

docs/index.rst

@@ -34,6 +34,7 @@ About
 
     about/history
     about/flask-diamond
+    changelog
     License
 
 ..     about/credits-and-attributions

gthnk/integration/__init__.py

@@ -2,6 +2,8 @@
 # gthnk (c) Ian Dennis Miller
 
 import os
+import random
+import string
 import subprocess
 from six.moves import input
 from getpass import getpass
@@ -68,3 +70,30 @@ def create_db(db_filename, conf_filename, python_path, manage_path):
         print("result:\t{0}".format(res))
     else:
         print("exists:\t{0}".format(db_filename))
+
+
+def make_config():
+    from .osx import install_osx, uninstall_osx
+    from .windows import install_windows, uninstall_windows
+
+    chars = string.ascii_letters + string.digits + '^!$&=?+~#-_.:,;'
+
+    if os.name == 'nt':
+        config = {
+            'secret_key': repr(os.urandom(24)),
+            'hash_salt': "".join([random.choice(chars) for _ in range(24)]),
+            'home_directory': os.environ["USERPROFILE"],
+            "app_data": os.environ["APPDATA"],
+            'do_install': install_windows,
+            'do_uninstall': uninstall_windows,
+        }
+    else:
+        config = {
+            'secret_key': repr(os.urandom(24)),
+            'hash_salt': "".join([random.choice(chars) for _ in range(24)]),
+            'home_directory': os.path.expanduser("~"),
+            'do_install': install_osx,
+            'do_uninstall': uninstall_osx,
+        }
+
+    return(config)