Permalink
Browse files

Cleanup for 0.3 release

This release covers everything we've done so far before we start making
some bigger changes.

I also changed the author information to me representing that Dave has
passed the torch for project maintenance to me.

Also included some of jezdez's changes to project scaffolding files. Thank
you!
  • Loading branch information...
1 parent 4ee61ef commit 6d7f4bf266abc50b787b55cf3d008dd536a0618f @willkg willkg committed Jun 1, 2012
Showing with 83 additions and 202 deletions.
  1. +13 −0 CHANGELOG
  2. +14 −0 CONTRIBUTORS
  3. +2 −2 LICENSE
  4. +4 −6 MANIFEST.in
  5. +11 −7 docs/conf.py
  6. +0 −170 docs/make.bat
  7. +3 −0 elasticutils/_version.py
  8. +36 −17 setup.py
View
@@ -0,0 +1,13 @@
+===========
+ CHANGELOG
+===========
+
+Version 0.3: Released June 1st, 2012
+====================================
+
+* Add documentation for debugging, project details and other things.
+
+* Minor project cleanup to make it easier to maintain and use
+
+* Make ``get_es()`` more useful. It now takes overrides that allow you to
+ configure multiple kinds of ES objects for different purposes.
View
@@ -0,0 +1,14 @@
+==============
+ CONTRIBUTORS
+==============
+
+* Andy McKay
+* Dave Dash
+* Erik Rose
+* Jannis Leidel
+* Jeff Balogh
+* Rob Hudson
+* Ryan Freebern
+* Sean McArthur
+* Steve Ivy
+* Will Kahn-Greene
View
@@ -1,4 +1,4 @@
-Copyright (c) 2011, 2012 Mozilla Corporation
+Copyright (c) 2011, 2012 Mozilla Foundation
All rights reserved.
Redistribution and use in source and binary forms, with or without
@@ -27,4 +27,4 @@ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
View
@@ -1,6 +1,4 @@
-include README
-include docs/*.rst
-include docs/Makefile
-include docs/make.bat
-include docs/conf.py
-include settings.py
+include README.rst CHANGELOG LICENSE CONTRIBUTORS
+include requirements.txt requirements-extra.txt
+include docs/Makefile docs/conf.py
+recursive-include docs *.rst *.py
View
@@ -30,16 +30,20 @@
# General information about the project.
project = u'ElasticUtils'
-copyright = u'2011, Dave Dash'
+copyright = u'2011, 2012 Mozilla Foundation'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
-#
-# The short X.Y version.
-version = '0.2'
-# The full version, including alpha/beta/rc tags.
-release = version
+
+try:
+ from elasticutils._version import __version__
+ # The short X.Y version.
+ version = '.'.join(__version__.split('.')[:2])
+ # The full version, including alpha/beta/rc tags.
+ release = __version__
+except ImportError:
+ version = release = 'dev'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -168,7 +172,7 @@
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'ElasticUtils.tex', u'ElasticUtils Documentation',
- u'Dave Dash', 'manual'),
+ u'Mozilla Foundation', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
View
@@ -1,170 +0,0 @@
-@ECHO OFF
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
- set SPHINXBUILD=sphinx-build
-)
-set BUILDDIR=_build
-set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
-if NOT "%PAPER%" == "" (
- set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
-)
-
-if "%1" == "" goto help
-
-if "%1" == "help" (
- :help
- echo.Please use `make ^<target^>` where ^<target^> is one of
- echo. html to make standalone HTML files
- echo. dirhtml to make HTML files named index.html in directories
- echo. singlehtml to make a single large HTML file
- echo. pickle to make pickle files
- echo. json to make JSON files
- echo. htmlhelp to make HTML files and a HTML help project
- echo. qthelp to make HTML files and a qthelp project
- echo. devhelp to make HTML files and a Devhelp project
- echo. epub to make an epub
- echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
- echo. text to make text files
- echo. man to make manual pages
- echo. changes to make an overview over all changed/added/deprecated items
- echo. linkcheck to check all external links for integrity
- echo. doctest to run all doctests embedded in the documentation if enabled
- goto end
-)
-
-if "%1" == "clean" (
- for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
- del /q /s %BUILDDIR%\*
- goto end
-)
-
-if "%1" == "html" (
- %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The HTML pages are in %BUILDDIR%/html.
- goto end
-)
-
-if "%1" == "dirhtml" (
- %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
- goto end
-)
-
-if "%1" == "singlehtml" (
- %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
- goto end
-)
-
-if "%1" == "pickle" (
- %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; now you can process the pickle files.
- goto end
-)
-
-if "%1" == "json" (
- %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; now you can process the JSON files.
- goto end
-)
-
-if "%1" == "htmlhelp" (
- %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; now you can run HTML Help Workshop with the ^
-.hhp project file in %BUILDDIR%/htmlhelp.
- goto end
-)
-
-if "%1" == "qthelp" (
- %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; now you can run "qcollectiongenerator" with the ^
-.qhcp project file in %BUILDDIR%/qthelp, like this:
- echo.^> qcollectiongenerator %BUILDDIR%\qthelp\ElasticUtils.qhcp
- echo.To view the help file:
- echo.^> assistant -collectionFile %BUILDDIR%\qthelp\ElasticUtils.ghc
- goto end
-)
-
-if "%1" == "devhelp" (
- %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished.
- goto end
-)
-
-if "%1" == "epub" (
- %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The epub file is in %BUILDDIR%/epub.
- goto end
-)
-
-if "%1" == "latex" (
- %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
- goto end
-)
-
-if "%1" == "text" (
- %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The text files are in %BUILDDIR%/text.
- goto end
-)
-
-if "%1" == "man" (
- %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The manual pages are in %BUILDDIR%/man.
- goto end
-)
-
-if "%1" == "changes" (
- %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
- if errorlevel 1 exit /b 1
- echo.
- echo.The overview file is in %BUILDDIR%/changes.
- goto end
-)
-
-if "%1" == "linkcheck" (
- %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
- if errorlevel 1 exit /b 1
- echo.
- echo.Link check complete; look for any errors in the above output ^
-or in %BUILDDIR%/linkcheck/output.txt.
- goto end
-)
-
-if "%1" == "doctest" (
- %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
- if errorlevel 1 exit /b 1
- echo.
- echo.Testing of doctests in the sources finished, look at the ^
-results in %BUILDDIR%/doctest/output.txt.
- goto end
-)
-
-:end
View
@@ -0,0 +1,3 @@
+# follow pep-386
+__version__ = '0.3'
+__releasedate__ = ''
View
@@ -1,25 +1,44 @@
-from setuptools import setup, find_packages
+import os
+import re
+from setuptools import find_packages, setup
+
+
+READMEFILE = "README.rst"
+VERSIONFILE = os.path.join("elasticutils", "_version.py")
+VSRE = r"^__version__ = ['\"]([^'\"]*)['\"]"
+
+
+def get_version():
+ verstrline = open(VERSIONFILE, "rt").read()
+ mo = re.search(VSRE, verstrline, re.M)
+ if mo:
+ return mo.group(1)
+ else:
+ raise RuntimeError(
+ "Unable to find version string in %s." % VERSIONFILE)
+
setup(
name='elasticutils',
- version='0.2',
+ version=get_version(),
description='Chainable interface to querying ElasticSearch',
- long_description=open('README.rst').read(),
- author='Dave Dash',
- author_email='dd+pypi@davedash.com',
+ long_description=open(READMEFILE).read(),
+ url='https://github.com/mozilla/elasticutils',
+ # Current "project maintainer"
+ author='Will Kahn-Greene',
+ author_email='willkg@mozilla.com',
license='BSD',
packages=find_packages(),
- install_requires=['Nose', 'pyes'],
+ install_requires=['Nose', 'pyes>=0.15,<0.17'],
include_package_data=True,
- classifiers = [
- 'Development Status :: 4 - Beta',
- 'Environment :: Web Environment',
- 'Intended Audience :: Developers',
- 'License :: OSI Approved :: BSD License',
- 'Operating System :: OS Independent',
- 'Programming Language :: Python',
- 'Topic :: Software Development :: Libraries :: Python Modules',
- 'Natural Language :: English',
- ]
+ classifiers=[
+ 'Development Status :: 4 - Beta',
+ 'Environment :: Web Environment',
+ 'Intended Audience :: Developers',
+ 'License :: OSI Approved :: BSD License',
+ 'Operating System :: OS Independent',
+ 'Programming Language :: Python',
+ 'Topic :: Software Development :: Libraries :: Python Modules',
+ 'Natural Language :: English',
+ ],
)
-

0 comments on commit 6d7f4bf

Please sign in to comment.