[Checkins] SVN: z3c.autoinclude/trunk/ Preparing for initial release.

[Martijn Faassen]

Log message for revision 84227:
  Preparing for initial release.
  

Changed:
  A   z3c.autoinclude/trunk/CHANGES.txt
  U   z3c.autoinclude/trunk/README.txt
  U   z3c.autoinclude/trunk/setup.py

-=-
Added: z3c.autoinclude/trunk/CHANGES.txt
===================================================================
--- z3c.autoinclude/trunk/CHANGES.txt	                        (rev 0)
+++ z3c.autoinclude/trunk/CHANGES.txt	2008-02-25 18:08:52 UTC (rev 84227)
@@ -0,0 +1,7 @@
+Changes
+=======
+
+0.1 (unreleased)
+----------------
+
+* Initial public release.

Modified: z3c.autoinclude/trunk/README.txt
===================================================================
--- z3c.autoinclude/trunk/README.txt	2008-02-25 17:46:53 UTC (rev 84226)
+++ z3c.autoinclude/trunk/README.txt	2008-02-25 18:08:52 UTC (rev 84227)
@@ -1,20 +1,45 @@
-z3c.autoinclude
-===============
-
-This package adds a new directive: "autoinclude". This directive
+This package adds a new ZCML directive: "autoinclude". This directive
 searches through the dependencies in your setup.py file
 (install_requires), and includes the meta.zcml and configure.zcml
 files in those packages that it finds. Inclusion order matches the
 order in the setup.py file. You can pass a path for the package you
 want to autoinclude for, but typically you pass in the current
-package, as follows: <autoinclude package="." />
+package, as follows::
 
+  <autoinclude package="." />
+
 The motivation behind this is to prevent having to repeat yourself in
-2 places, the setup.py file, and including the zcml. Common errors,
-especially for beginners, is to add a new dependency, but to forget to
-include the zcml as well. With the autoinclude directive, adding the
-includes for the zcml is no longer necessary.
+two places when you want to depend on a Zope 3 or Grok-based
+dependency: in the ``setup.py`` (in ``install_requires``) to make the
+dependency known, and again in ``configure.zcml`` with an ``include``
+statement to make sure the dependency's ZCML file are
+included. Because you have to repeat yourself, you can easily make an
+error where you add a new dependency in ``setup.py``, but forget to
+include the ZCML as well. If your package uses the ``autoinclude``
+directive, adding the includes for the ZCML configuration of
+individual dependencies is no longer necessary.
 
-This can eventually be used with grok, and grokproject. Creating a new
-grokproject can add this directive in the zcml, and then you no longer
-have to worry about including the zcml manually.
+The next versions of Grok_ and grokproject_ will use this functionality
+out of the box. The grokproject command will automatically add the
+``autoinclude`` directive in the ZCML of the project it generates. You
+can then stop worrying about manual ZCML inclusion in the vast
+majority of cases.
+
+The ``autoinclude`` directive automatically includes
+``configure.zcml`` and ``meta.zcml`` files that in the main package
+directories. In some cases, a package may use unusual names or
+locations for its ZCML files. In that case you will need to modify
+your package's ``configure.zcml`` and ``meta.zcml`` yourself to
+include the ZCML using the manual ``include`` directive.
+
+To make the ``autoinclude`` directive available for use in your
+application or framework, you need to include it (in your
+``meta.zcml`` for instance), like this::
+
+  <include package="z3c.autoinclude" file="meta.zcml" />
+
+Grok already does this for you automatically.
+
+.. _Grok: http://grok.zope.org
+
+.. _grokproject: http://pypi.python.org/pypi/grokproject

Modified: z3c.autoinclude/trunk/setup.py
===================================================================
--- z3c.autoinclude/trunk/setup.py	2008-02-25 17:46:53 UTC (rev 84226)
+++ z3c.autoinclude/trunk/setup.py	2008-02-25 18:08:52 UTC (rev 84227)
@@ -1,9 +1,11 @@
 from setuptools import setup, find_packages
 
-version = '0.1'
+long_description = (open('README.txt').read()
+                    + '\n\n' +
+                    open('CHANGES.txt').read())
 
 setup(name='z3c.autoinclude',
-      version=version,
+      version='0.1dev',
       description="",
       long_description="""\
 """,
@@ -14,8 +16,8 @@
         "Topic :: Software Development :: Libraries :: Python Modules",
         ],
       keywords='',
-      author='',
-      author_email='',
+      author='Ethan Jucovy, Robert Marianski, Martijn Faassen',
+      author_email='zope-dev at zope.org',
       url='',
       license='Public Domain',
       packages=find_packages('src'),