Prep for 0.8b1 release.

douglatornell · douglatornell · commit 35cb48307bba · 2012-10-08T15:59:34.000-07:00
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -1,5 +1,8 @@
-Next release
-============
+0.8b1
+=====
+
+If you've been using the ``plugins`` branch from GitHub but haven't updated
+in a while you should take note of the following.
 
 Bug Fixes
 ---------
@@ -27,15 +30,15 @@ Features
   the readthedocs.org service.
 
 - The init sub-command syntax and functionality has changed; see
-  blogofile help init.
+  ``blogofile help init``.
 
 - The configuration system has been refactored.
-  The default configuration settings are now in the default_config.py
+  The default configuration settings are now in the ``default_config.py``
   module.
 
 - As a result of the refactoring of the initialization function,
   and the configuration system,
-  the site_init directory has been eliminated.
+  the ``site_init`` directory has been eliminated.
 
 - Improved Unicode handling in slugs.
   See https://github.com/EnigmaCurry/blogofile/issues/124
@@ -44,7 +47,7 @@ Features
   (no 2to3 or 3to2 conversion required).
 
 - The command line completion feature has been removed so as to avoid
-  maintaining a bundled version of the argparse library.
-  argparse is included in the standard library for Python 2.7 and
+  maintaining a bundled version of the ``argparse`` library.
+  ``argparse`` is included in the standard library for Python 2.7 and
   3.2+.
-  setup.py will install it from PyPI for Python 2.6.
+  ``setup.py`` will install it from PyPI for Python 2.6.
diff --git a/README.rst b/README.rst
@@ -1,13 +1,35 @@
-Blogofile is a simple blog engine that requires no database and no
-special hosting environment.
-You customize a set of templates with Mako,
-create posts in a markup language like
-reStructuredText, Markdown, or Textile, (or even plain HTML)
-and Blogofile generates your entire blog as
+Blogofile is a static website compiler that lets you use various template
+libraries (Mako, Jinja2),
+and various markup languages (reStructuredText, Markdown, Textile)
+to create sites that can be served from any web server you like.
+
+Version 0.8 of Blogofile breaks out the core static site compiler
+and gives it a plugin interface.
+That allows features like the blog engine that was Blogofile's
+original raison d`être to be built on top of the core.
+
+`blogofile_blog`_ is a blog engine plugin created by the Blogofile developers.
+With it installed you get a simple blog engine that requires no
+database and no special hosting environment.
+You customize a set of Mako templates,
+create posts in reStructuredText, Markdown, or Textile, (or even plain HTML)
+and blogofile generates your entire blog as
 plain HTML, CSS, images, and Atom/RSS feeds
 which you can then upload to any old web server you like.
 No CGI or scripting environment is needed on the server.
 
-See the `main blogofile website`_ for usage instructions.
+See the `Blogofile website`_ for an example of a Blogofile-generated
+site that includes a blog,
+and check out the `project docs`_ for a quick-start guide,
+and detailed usage instructions.
+
+Or, if you're the "just get it done sort",
+create a virtualenv,
+and dive in with::
+
+  pip install -U Blogofile
+  pip install -U blogofile_blog
 
-.. _main blogofile website: http://www.blogofile.com
+.. _blogofile_blog: http://pypi.python.org/pypi/blogofile_blog/
+.. _Blogofile website: http://www.blogofile.com/
+.. _project docs: http://blogofile.readthedocs.org/en/latest/
diff --git a/RELEASING.rst b/RELEASING.rst
@@ -0,0 +1,65 @@
+Releasing Blogofile
+*******************
+
+Checklist for doing a release of Blogofile and the blogifile_blog plugin.
+
+* Do a platform test via tox:
+
+  $ tox -r
+
+* Ensure that all features of the release are documented (audit CHANGES.txt).
+
+* Ensure that the docs build:
+
+  $ cd docs
+  $ make clean html
+
+* Write a release post for blogofile.com.
+
+* Change version number in:
+
+  * Blogofile:
+
+    * blogofile/__init__.py
+    * blogofile/docs/conf.py
+    * CHANGES.txt
+
+  * blogofile_blog:
+
+    * blogofile_blog/__init__.py
+
+  * blogofile.com:
+
+    * _config.py
+
+* Test upload to PyPI:
+
+  $ python setup.py sdist register -r testpypi upload -r testpypi
+
+  for both Blogofile and blogofile_blog.
+
+* Test installation in a pristine virtualenv:
+
+  $ pip install --extra-index-url http://testpypi.python.org/pypi \
+        "Blogofile==<version>"
+  $ pip install --extra-index-url http://testpypi.python.org/pypi \
+        "blogofile_blog==<version>"
+
+  and then test building a site, even if it's the sample blog via:
+
+  $ blogofile init test_blog blog
+  $ blogofile build -s test_blog
+
+* Release to PyPI:
+
+  $ python setup.py sdist register upload
+
+  for both Blogofile and blogofile_blog.
+
+* Publish the release post for blogofile.com.
+
+* Announce to blogofile-discuss group/maillist.
+
+* Annouce to Google+.
+
+* Announce to Twitter.
diff --git a/blogofile/__init__.py b/blogofile/__init__.py
@@ -6,5 +6,5 @@
 Please take a moment to read LICENSE.txt. It's short.
 """
 
-__author__ = "Ryan McGuire (ryan@enigmacurry.com)"
-__version__ = '0.8-DEV'
+__author__ = "Ryan McGuire, Doug Latornell, and the Blogofile Contributors"
+__version__ = '0.8b1'
diff --git a/docs/conf.py b/docs/conf.py
@@ -50,7 +50,7 @@
 # The short X.Y version.
 version = '0.8'
 # The full version, including alpha/beta/rc tags.
-release = '0.8.dev'
+release = '0.8b1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
diff --git a/docs/intro.rst b/docs/intro.rst
@@ -68,24 +68,15 @@ installation.
 Install the Stable Release
 --------------------------
 
-Download and install Blogofile with::
+Download and install Blogofile and the blogofile_blog plugin with::
 
   easy_install Blogofile
-
-then go to the documentation for `docs for 0.7.1`_, the current stable release.
-
-.. _docs for 0.7.1: http://blogofile.readthedocs.org/en/0.7.1docs/
+  easy_install blogofile_blog
 
 
 Install the Latest Development Version
 --------------------------------------
 
-These docs are for the latest development version, 0.8.dev, also known
-as the *plugins* branch.
-0.8.dev is not backward compatible with 0.7.x at this time,
-and it probably never will be,
-but migration docs and perhaps tools will be created.
-
 Grab the Blogofile core source code from github::
 
   git clone git://github.com/EnigmaCurry/blogofile.git
@@ -97,6 +88,6 @@ and then grab the blogofile_blog reference plugin source code::
 Install Blogofile and the blogofile_blog plugin from the cloned sources::
 
   cd blogofile
-  python setup.py install
+  python setup.py develop
   cd ../blogofile_blog
-  python setup.py install
+  python setup.py develop
diff --git a/setup.py b/setup.py
@@ -44,22 +44,23 @@
     'License :: OSI Approved :: MIT License',
     'Programming Language :: Python :: Implementation :: CPython',
     'Environment :: Console',
-    'Natural Language ::  English',
+    'Natural Language :: English',
 ])
 
 setup(
     name="Blogofile",
     version=blogofile.__version__,
     description="A static website compiler and blog engine",
     long_description=long_description,
-    author="Ryan McGuire",
+    author=blogofile.__author__,
     author_email="blogofile-discuss@googlegroups.com",
     url="http://www.blogofile.com",
     license="MIT",
     classifiers=classifiers,
     packages=["blogofile"],
     install_requires=install_requires,
     dependency_links=dependency_links,
+    zip_safe=False,
     entry_points={
         'console_scripts': ['blogofile = blogofile.main:main']},
 )
