[Checkins] SVN: Sandbox/pcardune/z3c.recipe.tag/ add README.txt and generally make this package more publishable.

[Paul Carduner]

Log message for revision 84716:
  add README.txt and generally make this package more publishable.

Changed:
  U   Sandbox/pcardune/z3c.recipe.tag/README.txt
  U   Sandbox/pcardune/z3c.recipe.tag/setup.py
  U   Sandbox/pcardune/z3c.recipe.tag/src/z3c/recipe/tag/__init__.py

-=-
Modified: Sandbox/pcardune/z3c.recipe.tag/README.txt
===================================================================
--- Sandbox/pcardune/z3c.recipe.tag/README.txt	2008-03-16 18:59:39 UTC (rev 84715)
+++ Sandbox/pcardune/z3c.recipe.tag/README.txt	2008-03-16 21:07:27 UTC (rev 84716)
@@ -1 +1,37 @@
-TODO
+z3c.recipe.tag
+==============
+
+Introduction
+------------
+
+This recipe generates a TAGS database file that can be used with a
+number of different editors to quickly lookup class and function
+definitions in your package's source files and egg dependencies.
+
+Dependencies
+------------
+
+Before running a tags enabled buildout, you must install the
+appropriate command line tag generation tools: exuberant-ctags and
+id-utils.  In Ubuntu, you can install these with apt-get::
+
+  $ sudo apt-get install exuberant-ctags id-utils
+
+How to use this recipe
+----------------------
+
+Suppose you have an egg called ``MyApplication``.  To use this recipe with
+buildout, you would add the following to the ``buildout.cfg`` file::
+
+  [tags]
+  recipe = z3c.recipe.tag:tags
+  eggs = MyApplication
+
+This produces a script file in the ``bin/`` directory which you can
+then run like this::
+
+  $ ./bin/tags
+
+This script produces a file called ``TAGS`` in the directory from
+which you ran the script.  You can then use this file in your editor
+of choice (e.g. emacs).
\ No newline at end of file

Modified: Sandbox/pcardune/z3c.recipe.tag/setup.py
===================================================================
--- Sandbox/pcardune/z3c.recipe.tag/setup.py	2008-03-16 18:59:39 UTC (rev 84715)
+++ Sandbox/pcardune/z3c.recipe.tag/setup.py	2008-03-16 21:07:27 UTC (rev 84716)
@@ -1,6 +1,24 @@
 #!/usr/bin/env python
+# -*- Encoding: utf-8 -*-
+##############################################################################
+#
+# Copyright (c) 2007 Zope Corporation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Setup for z3c.recipe.tag package
+
+$Id$
+"""
+
 # Check python version
-
 import sys
 if sys.version_info < (2, 4):
     print >> sys.stderr, '%s: need Python 2.4 or later.' % sys.argv[0]
@@ -10,27 +28,33 @@
 import os
 from setuptools import setup, find_packages
 
+def read(*rnames):
+    return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
+
 setup(
     name="z3c.recipe.tag",
-    author="Ignas",
+    version='0.1.0-dev',
+    author="Ignas Mikalajūnas",
     description="Generate ctags from eggs for development.",
-    version='0.1.0-dev',
-    url='http://svn.zope.org/Sanbox/pcardune/z3c.recipe.tag/',
-    license="ZPL",
+    long_description=read('README.txt')
+    license="ZPL 2.1",
     maintainer="Paul Carduner",
     maintainer_email="zope-dev at zope.org",
-    platforms=["any"],
-    classifiers=["Development Status :: 4 - Beta",
-    "Intended Audience :: Developers",
-    "License :: OSI Approved :: GNU General Public License (GPL)",
-    "Operating System :: OS Independent",
-    "Programming Language :: Python",
-    "Programming Language :: Zope"],
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: Zope Public License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python"],
+    url='http://svn.zope.org/Sanbox/pcardune/z3c.recipe.tag/',
+    packages=find_packages('src'),
     package_dir={'': 'src'},
-    packages=find_packages('src'),
     namespace_packages=['z3c','z3c.recipe'],
     install_requires=['setuptools',
                       'zc.buildout',
+                      #these two come from apt-get!
+                      #'id-utils',
+                      #'ctags-exuberant'
                       'zc.recipe.egg'],
     entry_points="""
     [zc.buildout]

Modified: Sandbox/pcardune/z3c.recipe.tag/src/z3c/recipe/tag/__init__.py
===================================================================
--- Sandbox/pcardune/z3c.recipe.tag/src/z3c/recipe/tag/__init__.py	2008-03-16 18:59:39 UTC (rev 84715)
+++ Sandbox/pcardune/z3c.recipe.tag/src/z3c/recipe/tag/__init__.py	2008-03-16 21:07:27 UTC (rev 84716)
@@ -1,3 +1,16 @@
+##############################################################################
+#
+# Copyright (c) 2007 Zope Corporation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
 import os, sys
 import pkg_resources
 
@@ -4,8 +17,6 @@
 import zc.buildout.easy_install
 import zc.recipe.egg
 
-
-
 class TagsMaker(object):
 
     def __init__(self, buildout, name, options):