Doug Hellmann avatar Doug Hellmann committed 18b8c6a

add setup.py and related pieces, including minimal docs

--HG--
extra : convert_revision : svn%3A98f53aa3-d424-0410-b225-a548b0275c4d/Projects/virtualenvwrapper/trunk%401724

Comments (0)

Files changed (4)

+include README.html
 	VERSION=$(VERSION)
 	RELEASE=$(RELEASE)
 
-package: dist export
-	(rm -f dist/$(RELEASE).zip)
-	(cd dist/; tar zcvf $(RELEASE).tar.gz $(RELEASE))
-	mv dist/*.tar.gz ~/Desktop/
+package:
+	rm -f setup.py
+	$(MAKE) setup.py README.html
+	python setup.py sdist --force-manifest
+	mv dist/*.gz ~/Desktop/
+
+register: setup.py
+	python setup.py register
+
+README.html: README
+	rst2html.py $< $@
+
+%: %.in
+	cat $< | sed 's/VERSION/$(VERSION)/g' > $@
+	chmod -w $@
+
 
 dist:
 	mkdir -p dist
+#################
+virtualenvwrapper
+#################
+
+===========
+Quick Setup
+===========
+
+1. Add a line like ``export WORKON_HOME=$HOME/.virtualenvs`` to your .bashrc.
+2. Add a line like ``source /path/to/this/file/virtualenvwrapper_bashrc`` to your .bashrc.
+3. Run: ``source ~/.bashrc``
+4. Run: ``workon``
+5. A list of environments, empty, is printed.
+6. Run: ``mkvirtualenv temp``
+7. Run: ``workon``
+8. This time, the ``temp`` environment is included.
+9. Run: ``workon temp``
+10. The virtual environment is activated.
+
+==========
+References
+==========
+
+For more details, refer to the column I wrote for the May 2008 issue of Python Magazine: `virtualenvwrapper | And Now For Something Completely Different <http://www.doughellmann.com/articles/CompletelyDifferent-2008-05-virtualenvwrapper/index.html>`_.
+#!/usr/bin/env python
+#
+# $Id: setup.py 120 2003-04-23 12:18:54Z doughellmann $
+#
+# Time-stamp: <06/12/31 12:03:26 dhellmann>
+#
+# Copyright 2001 Doug Hellmann.
+#
+#
+#                         All Rights Reserved
+#
+# Permission to use, copy, modify, and distribute this software and
+# its documentation for any purpose and without fee is hereby
+# granted, provided that the above copyright notice appear in all
+# copies and that both that copyright notice and this permission
+# notice appear in supporting documentation, and that the name of Doug
+# Hellmann not be used in advertising or publicity pertaining to
+# distribution of the software without specific, written prior
+# permission.
+#
+# DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
+# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
+# NO EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR
+# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+# OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+"""Distutils setup file for Proctor
+
+"""
+
+#
+# Import system modules
+#
+from distutils.core import setup
+import os
+
+#
+# Import Local modules
+#
+
+#
+# Module
+#
+
+long_description = open('README', 'rt').read()
+
+setup (
+    name = 'virtualenvwrapper',
+    version = 'VERSION',
+
+    description = 'Enhancements to virtualenv',
+    long_description = long_description,
+
+    author = 'Doug Hellmann',
+    author_email = 'doug.hellmann@gmail.com',
+
+    url = 'http://www.doughellmann.com/projects/virtualenvwrapper/',
+    download_url = 'http://www.doughellmann.com/downloads/Proctor-VERSION.tar.gz',
+
+    classifiers = [ 'Development Status :: 5 - Production/Stable',
+                    'License :: OSI Approved :: BSD License',
+                    'Programming Language :: Python',
+                    'Intended Audience :: Developers',
+                    'Environment :: Console',
+                    ],
+
+    platforms = ('Any',),
+
+    scripts = ['virtualenvwrapper_bashrc', 
+               ],
+
+    provides=['virtualenvwrapper',
+              ],
+    requires=['virtualenv'],
+    
+    data_files=[('docs', ['README.html']),
+                ],
+    )
+
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.