Update documentation for 0.6.0 cycle.

HISTORY.rst

@@ -9,7 +9,19 @@ History
 0.6.0.dev0
 ---------------------
 
-    
+* Pulsar now depends on the new ``galaxy-lib`` Python package instead of
+  manually synchronizing Python files across Pulsar and Galaxy.
+* Numerous build and testing improvements.
+* Fixed a documentation bug in the code (thanks to @erasche). e8814ae_
+* Remove galaxy.eggs stuff from Pulsar client (thanks to @natefoo). 00197f2_
+* Add new logo to README (thanks to @martenson). abbba40_
+* Implement an optional awknowledgement system on top of the message queue
+  system (thanks to @natefoo). `Pull Request 82`_ 431088c_
+* Documentation fixes thanks to @remimarenco. `Pull Request 78`_, `Pull Request 80`_
+* Fix project script bug introduced this cycle (thanks to @nsoranzo). 140a069_
+* Fix config.py on Windows (thanks to @ssorgatem). `Pull Request 84`_
+* Add a job manager for XSEDE jobs (thanks to @natefoo). 1017bc5_
+* Fix pip dependency installation (thanks to @afgane) `Pull Request 73`_
 
 ------------------------
 0.5.0 (2015-05-08)
@@ -72,6 +84,17 @@ History
 
 
 .. github_links
+.. _Pull Request 73: https://github.com/galaxyproject/pulsar/pull/73
+.. _1017bc5: https://github.com/galaxyproject/pulsar/commit/1017bc5
+.. _Pull Request 84: https://github.com/galaxyproject/pulsar/pull/84
+.. _140a069: https://github.com/galaxyproject/pulsar/commit/140a069
+.. _Pull Request 78: https://github.com/galaxyproject/pulsar/pull/78
+.. _Pull Request 80: https://github.com/galaxyproject/pulsar/pull/80
+.. _Pull Request 82: https://github.com/galaxyproject/pulsar/pull/82
+.. _abbba40: https://github.com/galaxyproject/pulsar/commit/abbba40
+.. _00197f2: https://github.com/galaxyproject/pulsar/commit/00197f2
+.. _431088c: https://github.com/galaxyproject/pulsar/commit/431088c
+.. _e8814ae: https://github.com/galaxyproject/pulsar/commit/e8814ae
 .. _fe3e919: https://github.com/galaxyproject/pulsar/commit/fe3e919
 .. _2b3942d: https://github.com/galaxyproject/pulsar/commit/2b3942d
 .. _fa2b6dc: https://github.com/galaxyproject/pulsar/commit/fa2b6dc

pulsar/__init__.py

 # -*- coding: utf-8 -*-
 
 __version__ = '0.6.0.dev0'
+
+PROJECT_NAME = "pulsar"
+PROJECT_OWNER = PROJECT_USERAME = "galaxyproject"
+PROJECT_AUTHOR = 'Galaxy Project and Community'
+PROJECT_EMAIL = 'jmchilton@gmail.com'
+
+PROJECT_URL = "https://github.com/%s/%s" % (PROJECT_OWNER, PROJECT_NAME)
+RAW_CONTENT_URL = "https://raw.github.com/%s/%s/master/" % (
+    PROJECT_USERAME, PROJECT_NAME
+)

tools/bootstrap_history.py

@@ -3,24 +3,59 @@
 # pull message down and embed, use arg parse, handle multiple, etc...
 import os
 import sys
+try:
+    import requests
+except ImportError:
+    requests = None
+import urlparse
+import textwrap
 
+PROJECT_DIRECTORY = os.path.join(os.path.dirname(__file__), "..")
+new_path = [PROJECT_DIRECTORY]
+new_path.extend( sys.path[1:] )  # remove scripts/ from the path
+sys.path = new_path
+
+import pulsar as project
+
+PROJECT_OWNER = project.PROJECT_OWNER
+PROJECT_NAME = project.PROJECT_NAME
+PROJECT_URL = "https://github.com/%s/%s" % (PROJECT_OWNER, PROJECT_NAME)
+PROJECT_API = "https://api.github.com/repos/%s/%s/" % (PROJECT_OWNER, PROJECT_NAME)
 
-PROJECT_DIRECTORY = os.path.join(os.path.dirname(__file__))
-PROJECT_URL="https://github.com/galaxyproject/pulsar"
 
 def main(argv):
     history_path = os.path.join(PROJECT_DIRECTORY, "HISTORY.rst")
-    history = open(history_path, "r").read()
+    history = open(history_path, "r").read().decode("utf-8")
 
     def extend(from_str, line):
         from_str += "\n"
         return history.replace(from_str, from_str + line + "\n" )
 
     ident = argv[1]
-    to_doc = "* "
+
+    message = ""
     if len(argv) > 2:
         message = argv[2]
-        to_doc += message + " "
+    elif not (ident.startswith("pr") or ident.startswith("issue")):
+        api_url = urlparse.urljoin(PROJECT_API, "commits/%s" % ident)
+        req = requests.get(api_url).json()
+        commit = req["commit"]
+        message = commit["message"]
+        message = get_first_sentence(message)
+    elif requests is not None and ident.startswith("pr"):
+        pull_request = ident[len("pr"):]
+        api_url = urlparse.urljoin(PROJECT_API, "pulls/%s" % pull_request)
+        req = requests.get(api_url).json()
+        message = req["title"]
+    elif requests is not None and ident.startswith("issue"):
+        issue = ident[len("issue"):]
+        api_url = urlparse.urljoin(PROJECT_API, "issues/%s" % issue)
+        req = requests.get(api_url).json()
+        message = req["title"]
+    else:
+        message = ""
+
+    to_doc = message + " "
 
     if ident.startswith("pr"):
         pull_request = ident[len("pr"):]
@@ -38,8 +73,21 @@ def main(argv):
         history = extend(".. github_links", text)
         to_doc += "{0}_".format(short_rev)
 
+    to_doc = wrap(to_doc)
     history = extend(".. to_doc", to_doc)
-    open(history_path, "w").write(history)
+    open(history_path, "w").write(history.encode("utf-8"))
+
+
+def get_first_sentence(message):
+    first_line = message.split("\n")[0]
+    return first_line
+
+
+def wrap(message):
+    wrapper = textwrap.TextWrapper(initial_indent="* ")
+    wrapper.subsequent_indent = '  '
+    wrapper.width = 78
+    return "\n".join(wrapper.wrap(message))
 
 if __name__ == "__main__":
     main(sys.argv)