Spring Cleaning for New Development

Author: mmellison

AUTHORS

@@ -0,0 +1,25 @@
+The PRIMARY AUTHORS are (or have previously been):
+
+* Stanislav Heller <[email protected]>
+* Matthew Ellison <[email protected]>
+
+
+CONTRIBUTORS under the BSD-2 License prior to
+version 0.1:
+
+* Manfred Touron
+* Kelly Caylor
+* Dmitry / [email protected]
+
+
+CONTRIBUTORS
+
+The below list is not authoratative nor considered
+a complete and comprehensive list. The git logs
+are considered the authoratative list of contributors.
+
+Below is a list of individuals whom have submitted
+patches, reported bugs, and helped to improve the
+project:
+
+

LICENSE

@@ -1,27 +1,27 @@
-Copyright (c) 2013, Stanislav Heller
-All rights reserved.
+Copyright (c) 2015 See AUTHORS
 
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
+Versions and contributions released prior to v0.1 were
+released under the BSD-2 license.
+Please download a previous version of the project to
+view the BSD-2 license used.
 
-  Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
 
-  Redistributions in binary form must reproduce the above copyright notice, this
-  list of conditions and the following disclaimer in the documentation and/or
-  other materials provided with the distribution.
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
 
-  Neither the name of the {organization} nor the names of its
-  contributors may be used to endorse or promote products derived from
-  this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
-ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT 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.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

README.rst

@@ -4,12 +4,31 @@ Eve-MongoEngine
 :Info: Eve-MongoEngine provides MongoEngine integration with `Eve <http://python-eve.org/>`_.
 :Repository: https://github.com/hellerstanislav/eve-mongoengine
 :Author: Stanislav Heller (https://github.com/hellerstanislav)
+:Maintainer: Matthew Ellison (https://github.com/seglberg)
+
+----
+
+.. |travis-master| image:: https://api.travis-ci.org/seglberg/eve-mongoengine.png?branch=master
+  :target: https://travis-ci.org/seglberg/eve-mongoengine
+
+.. |travis-develop| image:: https://api.travis-ci.org/seglberg/eve-mongoengine.png?branch=develop
+  :target: https://travis-ci.org/seglberg/eve-mongoengine/branches
+
+.. list-table::
+   :widths: 50 50
+   :header-rows: 1
+
+   * - Production
+     - Development
+   * - |travis-master|
+     - |travis-develop|
+
+**THE DEVELOP BRANCH CONTAINS POST-LEGACY WORK**
+
+See the `legacy` tag for the last legacy release (0.0.10).
+
+Do not use `develop` in production code. Instead, the `master` branch always points to the latest production release, and should be used instead.
 
-.. image:: https://api.travis-ci.org/hellerstanislav/eve-mongoengine.png?branch=master
-  :target: https://travis-ci.org/hellerstanislav/eve-mongoengine/
-  
-.. image:: https://requires.io/github/hellerstanislav/eve-mongoengine/requirements.png?branch=master
-  :target: https://requires.io/github/hellerstanislav/eve-mongoengine/requirements/?branch=master
 
 About
 =====
@@ -40,53 +59,8 @@ Optional Dependencies
 
 - *None*
 
-Examples
-========
-
-A simple example of what Eve-MongoEngine code looks like:
-
-.. code:: python
-
-  import mongoengine
-  from eve import Eve
-  from eve_mongoengine import EveMongoengine
-
-  # Example MongoEngine ODM Model
-  class Person(mongoengine.Document):
-      name = mongoengine.StringField()
-      age = mongoengine.IntField()
-
-  # Set up Eve Settings
-  my_settings = {
-      'MONGO_HOST': 'localhost',
-      'MONGO_PORT': 27017,
-      'MONGO_DBNAME': 'eve_mongoengine_test'
-      'DOMAIN': {'eve-mongoengine': {}} # Must add a "Dummy" Domain for Eve
-  }
-
-  # Eve Initialization
-  app = Eve(settings=my_settings)
-  ext = EveMongoengine(app)
-  # Register Models with Eve
-  ext.add_model([Person,])
-  
-  # Start Eve
-  app.run()
-
-
-Validation
-----------
-
-By default, Eve validates against the Cerberus schema. With the Eve-MongoEngine extension, all validation is processed by Eve first (if possible) and then processed by the corresponding MongoEngine validation layer. If the MongoEngine validation layer throws an exception, it is caught and returned in the Cerberus error format.
-
-
-Fields
-------
-
-Eve automatically maintains fields in the database named ``_updated`` and ``_created``. To maintain compatibility with Eve, Eve-MongoEngine automatically inserts MongoEngine fields called ``updated`` and ``created`` (with database names of ``_updated`` and ``_created`` respectively) into any registered models.
-
-
-Options and Limitations
------------------------
+Legacy Release
+==============
 
-See more tuning options and current limitations on `Read the Docs`_.
+The legacy version of the extension can be found under the 'legacy' tag. 
+The legacy version of the extension was released under the BSD-2 license and originally authored by Stanislav Heller. See AUTHORS for more information about the legacy authors and ownership.

eve_mongoengine/__init__.py

@@ -24,7 +24,8 @@
 from ._compat import itervalues, iteritems
 
 
-__version__ = "0.0.10"
+from .__version__ import get_version
+__version__ = get_version()
 
 
 def get_utc_time():

eve_mongoengine/__version__.py

@@ -0,0 +1,8 @@
+# Project Version
+
+VERSION = (0, 1, 0)     # 0.1.0
+
+def get_version():
+    if isinstance(VERSION[-1], basestring):
+        return '.'.join(map(str, VERSION[:-1])) + VERSION[-1]
+    return '.'.join(map(str, VERSION))

release.sh

@@ -1,4 +1,3 @@
 eve>=0.5.3
 blinker
 mongoengine>=0.8.7,<=0.9
-pymongo>=2.7.1,<3.0

requirements.txt

@@ -2,22 +2,38 @@
 
 from setuptools import setup, find_packages
 
+LONG_DESCRIPTION = None
+try:
+    LONG_DESCRIPTION = open('README.rst').read()
+except:
+    pass
+
+# Version Information
+execfile('eve_mongoengine/__version__.py')
+VERSION = get_version()
+
+extra_opts = dict()
+
+# Project Setup
 setup(
-    name='Eve-Mongoengine',
-    version='0.0.10',
-    url='https://github.com/hellerstanislav/eve-mongoengine',
+    name='eve-mongoengine',
+    version=VERSION,
+    url='https://github.com/seglberg/eve-mongoengine',
     author='Stanislav Heller',
-    author_email='[email protected]',
+    author_email='heller.stanislav@{nospam}gmail.com',
+    maintainer="Matthew Ellison",
+    maintainer_email="[email protected]",
     description='An Eve extension for Mongoengine ODM support',
-    packages=['eve_mongoengine'],
-    zip_safe=False,
+    long_description=LONG_DESCRIPTION,
+    platforms=['any'],
+    packages=find_packages(exclude=["test*"]),
     test_suite="tests",
+    license='MIT',
     include_package_data=True,
-    platforms='any',
     install_requires=[
         'Eve>=0.5.3',
         'Blinker',
         'Mongoengine>=0.8.7,<=0.9',
-        'pymongo>=2.7.1,<3.0'
-    ]
+    ],
+    **extra_opts
 )