changeset 3:9e4da7517815

make a README file and include it in the setup.py
author k0s <k0scist@gmail.com>
date Tue, 02 Mar 2010 20:18:15 -0500
parents d172c078f4a2
children f7f335561ceb
files README.txt setup.py
diffstat 2 files changed, 41 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.txt	Tue Mar 02 20:18:15 2010 -0500
@@ -0,0 +1,34 @@
+martINI
+=======
+        
+martINI is an extended facility for utilizing
+`ini files <http://en.wikipedia.org/wiki/INI_file>`_ in python.
+martINI includes API, command-line, and web interfaces.
+martINI is built on the
+`ConfigParser <http://docs.python.org/library/configparser.html>`_ module,
+which is part of python's standard library.
+
+
+Command Line Tools
+------------------
+
+martINI comes with several command line tools for manipulating .ini
+files:
+
+ * ini-get: get key or section values from a .ini files
+ * ini-set: set .ini file values 
+ * ini-delete: delete .ini key-value pairs from a .ini files
+ * ini-munge: combine several .ini files 
+
+Running the commands will display usage information.
+
+
+TODO
+----
+
+Consider refactoring to use 
+`INITools <http://pythonpaste.org/initools/>`_ instead of ``ConfigParser``.
+
+--
+
+http://k0s.org/portfolio/software.html#martini
--- a/setup.py	Tue Dec 08 16:23:50 2009 -0500
+++ b/setup.py	Tue Mar 02 20:18:15 2010 -0500
@@ -1,13 +1,17 @@
 from setuptools import setup, find_packages
 import sys, os
 
-version = '0.3.1'
+try:
+    description = file('README.txt').read()
+except:
+    description = ''
+
+version = '0.3.2'
 
 setup(name='martINI',
       version=version,
       description="edit .ini files from the command line",
-      long_description="""\
-""",
+      long_description=description,
       classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
       keywords='ini cli',
       author='Jeff Hammel',