Merge pull request #11 from neogeographica/1.0

1.0

Author: neogeographica

.travis.yml

@@ -2,7 +2,7 @@ language: python
 python:
   - "2.7"
   - "2.6"
-# command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
-install: "pip install ."
-# command to run tests, e.g. python setup.py test
+install:
+  - python setup.py sdist --formats=zip -k -d dist
+  - find ./dist -iname "*.zip" -print0 | xargs -0 pip install
 script: python setup.py test

HISTORY.rst

@@ -1,5 +1,11 @@
 Changelog
-===================
+---------
+
+- **1.0** (2013-11-21)
+
+  - Minor improvements to setup script, comments, and docs.
+  - Support for "python -m expak".
+  - Removal of race in subdirectory creation in nop_converter.
 
 - **0.9** (2013-11-19)
 

Makefile

@@ -1,4 +1,4 @@
-.PHONY: test docs clean sdist infup publish winpublish
+.PHONY: test readme docs clean infup publish dist
 
 test:
 	tox
@@ -7,25 +7,29 @@ sphinxbox/expak.py:
 	-mkdir sphinxbox
 	cd sphinxbox; ln -s ../expak.py .
 
-docs: sphinxbox/expak.py
-	sphinx-apidoc -o docs sphinxbox
-	cd docs; make html
+readme:
 	python make_readme.py
 
-sdist:
-	python setup.py sdist
+docs: sphinxbox/expak.py readme
+	sphinx-apidoc -o docs sphinxbox
+	cd docs; make html
 
-infup:
+infup: readme
 	python setup.py register
 
-publish:
-	python setup.py sdist upload
+publish: infup
+	python setup.py sdist --formats=gztar,zip upload
 	python2.6 setup.py bdist_egg upload
 	python2.7 setup.py bdist_egg upload
+	python setup.py bdist_wininst -p win32 upload
+	python setup.py bdist_wininst -p win-amd64 upload
 
-winpublish:
-	C:\Python26\python.exe setup.py bdist_wininst --target-version=2.6 upload
-	C:\Python27\python.exe setup.py bdist_wininst --target-version=2.7 upload
+dist: readme
+	python setup.py sdist --formats=gztar,zip
+	python2.6 setup.py bdist_egg
+	python2.7 setup.py bdist_egg
+	python setup.py bdist_wininst -p win32
+	python setup.py bdist_wininst -p win-amd64
 
 clean:
 	python setup.py clean
@@ -34,8 +38,11 @@ clean:
 	-rm -rf htmlcov
 	-rm -rf expak.egg-info
 	-rm *.pyc
+	-rm test/*.pyc
+	-rm -rf test/__pycache__
 	cd docs; make clean
 
 superclean: clean
 	-rm -rf *.egg
 	-rm -rf sphinxbox
+	-rm -rf .tox

README.rst

@@ -1,3 +1,5 @@
+.. _header_section:
+
 expak: Extract and process resources from Quake-style pak files
 ===============================================================
 
@@ -9,6 +11,8 @@ expak: Extract and process resources from Quake-style pak files
     :target: http://travis-ci.org/neogeographica/expak
     :alt: build status of the master branch
 
+.. _blurb_section:
+
 *expak* is a GPLv3_-licensed tool to extract and optionally process resources
 from one or more `Quake-style pak files`_.
 
@@ -23,8 +27,10 @@ outside of the standard Python modules.
 .. _Quake-style pak files: http://quakewiki.org/wiki/.pak
 
 
+.. _prerequisites_section:
+
 Prerequisites
-=============
+-------------
 
 It's a Python module and utility, so you need Python! If you don't have Python
 installed, `go get it`_. Note that while both Python 2 and Python 3 are
@@ -46,8 +52,10 @@ but you can ignore all of its complexity for the purposes of installing expak.
 .. _pip: http://www.pip-installer.org/en/latest
 .. _instructions for installing pip: http://www.pip-installer.org/en/latest/installing.html
 
+.. _installation_section:
+
 Installation
-============
+------------
 
 The latest version of expak can always be installed or updated to via the `pip`_
 package manager, and this is the preferred method:
@@ -66,18 +74,21 @@ installed but can't or don't want to use pip:
 Finally, if you are on Windows, you could also choose to use an installer
 program, although the methods above work fine on Windows. Custom expak
 installers are included in the downloads list for expak
-`at the Python Package Index`_ (PyPI).
+`at the Python Package Index`_ (PyPI), and also `at Crate.io`_ or other PyPI
+mirrors.
 
-If PyPI is down, the Windows installers and all the other distribution files
-are mirrored `at Crate.io`_ and other PyPI mirrors, and here at GitHub in the
-`releases for this repo`_.
+If PyPI and its mirrors are down, the Windows installers and other forms of
+distribution files (including source distribution) are mirrored
+`in the releases for the GitHub repo`_.
 
 .. _at the Python Package Index: https://pypi.python.org/pypi/expak
 .. _at Crate.io: https://crate.io/packages/expak
-.. _releases for this repo: https://github.com/neogeographica/expak/releases
+.. _in the releases for the GitHub repo: https://github.com/neogeographica/expak/releases
+
+.. _documentation_section:
 
 Documentation
-=============
+-------------
 
 - `expak module`_
 - `simple expak utility`_

README.rst.in

@@ -1,3 +1,5 @@
+.. _header_section:
+
 expak: Extract and process resources from Quake-style pak files
 ===============================================================
 
@@ -9,10 +11,14 @@ expak: Extract and process resources from Quake-style pak files
     :target: http://travis-ci.org/neogeographica/expak
     :alt: build status of the master branch
 
+.. _blurb_section:
+
 .. include:: docs/blurb.txt
 
+.. _prerequisites_section:
+
 Prerequisites
-=============
+-------------
 
 It's a Python module and utility, so you need Python! If you don't have Python
 installed, `go get it`_. Note that while both Python 2 and Python 3 are
@@ -34,8 +40,10 @@ but you can ignore all of its complexity for the purposes of installing expak.
 .. _pip: http://www.pip-installer.org/en/latest
 .. _instructions for installing pip: http://www.pip-installer.org/en/latest/installing.html
 
+.. _installation_section:
+
 Installation
-============
+------------
 
 The latest version of expak can always be installed or updated to via the `pip`_
 package manager, and this is the preferred method:
@@ -54,15 +62,18 @@ installed but can't or don't want to use pip:
 Finally, if you are on Windows, you could also choose to use an installer
 program, although the methods above work fine on Windows. Custom expak
 installers are included in the downloads list for expak
-`at the Python Package Index`_ (PyPI).
+`at the Python Package Index`_ (PyPI), and also `at Crate.io`_ or other PyPI
+mirrors.
 
-If PyPI is down, the Windows installers and all the other distribution files
-are mirrored `at Crate.io`_ and other PyPI mirrors, and here at GitHub in the
-`releases for this repo`_.
+If PyPI and its mirrors are down, the Windows installers and other forms of
+distribution files (including source distribution) are mirrored
+`in the releases for the GitHub repo`_.
 
 .. _at the Python Package Index: https://pypi.python.org/pypi/expak
 .. _at Crate.io: https://crate.io/packages/expak
-.. _releases for this repo: https://github.com/neogeographica/expak/releases
+.. _in the releases for the GitHub repo: https://github.com/neogeographica/expak/releases
+
+.. _documentation_section:
 
 .. include:: docs/rtdlinks.txt
 

docs/rtdlinks.txt

@@ -1,5 +1,5 @@
 Documentation
-=============
+-------------
 
 - `expak module`_
 - `simple expak utility`_

expak.py

@@ -93,12 +93,13 @@ def ogg_converter(orig_data, name):
            'nop_converter',
            'print_err']
 
-__version__ = "0.9"
+__version__ = "1.0"
 
 
 import struct
 import sys
 import os
+import errno
 
 PAK_FILE_SIGNATURE = "PACK"
 RESOURCE_NAME_LEN = 56
@@ -147,6 +148,8 @@ def read_header(instream):
     """
     instream.seek(0)
     file_id = instream.read(len(PAK_FILE_SIGNATURE))
+    # We don't raise IOError on a short read here... IOError is for use after
+    # we've determined it's actually a pak file.
     if file_id != PAK_FILE_SIGNATURE:
         return None
     ftable_off = read_uint(instream)
@@ -377,8 +380,12 @@ def nop_converter(orig_data, name):
     """
     real_path = os.path.join(*name.split("/"))
     out_dir = os.path.dirname(real_path)
-    if out_dir and not os.path.exists(out_dir):
-        os.makedirs(out_dir)
+    if out_dir:
+        try:
+            os.makedirs(out_dir)
+        except OSError, e:
+            if e.errno != errno.EEXIST:
+                raise
     with open(real_path, 'wb') as outstream:
         outstream.write(orig_data)
     return True
@@ -523,6 +530,11 @@ def simple_expak(argv=None):
     paks/resources as possible, it will exit with a status of 0 if no such
     exceptions were encountered, or 1 otherwise.
 
+    .. note::
+
+         :program:`python -m expak` behaves identically to
+         :program:`simple_expak`.
+
     """
     # Normal use (when invoked from the utility) passes in None for argv, and
     # arguments are then taken from the command line. For testing however, other
@@ -554,3 +566,6 @@ def simple_expak(argv=None):
         return 0
     else:
         return 1
+
+if __name__ == "__main__":
+    sys.exit(simple_expak())

setup.py

@@ -6,12 +6,21 @@
 import sys
 import re
 
+ANCHOR_PATTERN = re.compile('^\.\. _([^:]+):$')
+
 # Work around 2.6 error when exiting tests:
 try:
     import multiprocessing
 except ImportError:
     pass
 
+# Force bdist_wininst to use the correct bundled installer, even when building
+# on non-Windows platforms.
+import distutils.msvccompiler
+def correct_build_version():
+    return 9.0
+distutils.msvccompiler.get_build_version = correct_build_version
+
 here = os.path.abspath(os.path.dirname(__file__))
 
 def read(*parts):
@@ -26,10 +35,6 @@ def find_version(*file_paths):
         return version_match.group(1)
     raise RuntimeError("Unable to find version string.")
 
-long_description = '\n\n'.join([read('docs', 'blurb.txt'),
-                                read('docs', 'rtdlinks.txt'),
-                                read('HISTORY.rst')])
-
 class PyTest(TestCommand):
     def finalize_options(self):
         TestCommand.finalize_options(self)
@@ -43,18 +48,45 @@ def run_tests(self):
         errno = pytest.main(self.test_args)
         sys.exit(errno)
 
+# Set a default description just in case we don't find it in the readme.
+description = 'Extract and process resources from Quake-style pak files'
+
+# Pick the desired sections out of the readme for use in the long description,
+# and also look for the short description in the readme header.
+readme_orig = read('README.rst')
+readme_sections = set(['blurb_section', 'documentation_section'])
+readme = ''
+section = None
+include_line = False
+for readme_line in readme_orig.splitlines(True):
+    is_anchor = ANCHOR_PATTERN.match(readme_line)
+    if is_anchor:
+        section = is_anchor.group(1)
+        include_line = False
+        continue
+    if section == 'header_section':
+        if readme_line.startswith('expak:'):
+            description = readme_line[6:].strip()
+    if include_line:
+        readme = readme + readme_line
+    elif section in readme_sections:
+        include_line = True
+
+# Form long description from select readme sections + history/changelog.
+long_description = readme + read('HISTORY.rst')
+
 setup(
     py_modules = ['expak'],
     name = 'expak',
     version = find_version('expak.py'),
     author = 'Joel Baxter',
     author_email = '[email protected]',
     url = 'http://github.com/neogeographica/expak',
-    description = 'Extract and process resources from Quake-style pak files',
+    description = description,
     long_description = long_description,
     classifiers = [
-        'Development Status :: 4 - Beta',
-#        'Development Status :: 5 - Production/Stable',
+#        'Development Status :: 4 - Beta',
+        'Development Status :: 5 - Production/Stable',
         'Environment :: Console',
         'Intended Audience :: Developers',
         'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
@@ -72,7 +104,7 @@ def run_tests(self):
     install_requires = [],
     entry_points={'console_scripts': ['simple_expak = expak:simple_expak']},
     test_suite = 'test.test_expak',
-        # disabling coverage in "setup.py test" for now (& see above)
+    # disabling coverage in "setup.py test" for now (& see above)
 #    tests_require = ['pytest-cov', 'pytest'],
     tests_require = ['pytest'],
     cmdclass = {'test': PyTest}