Merge pull request bradbeattie#12 from robinharms/master

Setuptools information

Author: bradbeattie

.gitignore

@@ -1,3 +1,4 @@
 *.pyc
 *.py-e
 *.swp
+*.egg-info

CHANGES.rst

@@ -0,0 +1,4 @@
+0.0
+---
+
+-  Initial version

MANIFEST.in

@@ -0,0 +1 @@
+include *.txt *.rst *.markdown

README.rst

@@ -0,0 +1,35 @@
+Python Vote Core
+================
+
+python-vote-core implements various electoral methods, providing the results
+calculated off a provided set of ballots and options.
+
+* Project page: http://github.com/bradbeattie/python-vote-core
+* Issue tracker: http://github.com/bradbeattie/python-vote-core/issues
+* Example usage: http://vote.cognitivesandbox.com, http://modernballots.com
+
+Methods implemented
+-------------------
+
+* Single Winner Methods
+  * Plurality (aka first-past-the-post or fptp)
+  * Instant-Runoff Voting (aka IRV)
+  * Schulze Method (aka Beatpath)
+* Multiple Winner Methods
+  * Plurality at large (aka block voting)
+  * Single Transferable Vote (aka STV)
+  * Schulze STV
+* Ordering Methods
+  * Schulze Proportional Representation
+  * Schulze Nonproportional Representation
+
+Basic Usage
+-----------
+
+  print SchulzeMethod([
+      { "count":3, "ballot":[["A"], ["C"], ["D"], ["B"]] },
+      { "count":9, "ballot":[["B"], ["A"], ["C"], ["D"]] },
+      { "count":8, "ballot":[["C"], ["D"], ["A"], ["B"]] },
+      { "count":5, "ballot":[["D"], ["A"], ["B"], ["C"]] },
+      { "count":5, "ballot":[["D"], ["B"], ["C"], ["A"]] }
+  ], ballot_notation = "grouping").as_dict()

docs/LICENSE.txt

@@ -0,0 +1,17 @@
+License
+-------
+
+Copyright (C) 2009, Brad Beattie
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see http://www.gnu.org/licenses.

setup.py

@@ -0,0 +1,36 @@
+import os
+
+from setuptools import setup, find_packages
+
+here = os.path.abspath(os.path.dirname(__file__))
+README = open(os.path.join(here, 'README.rst')).read()
+CHANGES = open(os.path.join(here, 'CHANGES.rst')).read()
+LICENSE = open(os.path.join(here, 'docs', 'LICENSE.txt')).read()
+
+requires = [
+    'python-graph-core >= 1.8.0',
+    ]
+
+setup(name='python-vote-core',
+      version='0.0',
+      description="An implementation of various election methods, most notably the Schulze Method and Schulze STV.",
+      long_description=README + '\n\n' +  CHANGES + '\n\n' + LICENSE,
+      classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "License :: OSI Approved :: GNU General Public License (GPL)",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 2.7",
+        "Topic :: Scientific/Engineering :: Mathematics",
+        ],
+      author='Brad Beattie',
+      author_email='bradbeattie@gmail com',
+      url='https://github.com/bradbeattie/python-vote-core',
+      license='GPLv3',
+      keywords='library election',
+      packages=find_packages(),
+      include_package_data=True,
+      zip_safe=False,
+      install_requires = requires,
+      tests_require= requires,
+      test_suite="test_functionality",
+      )