Moved README to rst, improved setup.py file, and added MANIFEST.in

Author: aluttik

MANIFEST.in

@@ -0,0 +1 @@
+include README.rst LICENSE

README.md

@@ -0,0 +1,80 @@
+pizzapi
+=======
+
+This is a Python wrapper for the Dominos Pizza API.
+
+It's a port of `the pizzapi node.js module <https://github.com/RIAEvangelist/node-dominos-pizza-api>`_ written by `RIAEvangelist <https://github.com/RIAEvangelist>`_.
+
+Quick Start
+-----------
+
+First construct a ``Customer`` object and set the customer's address:
+
+.. code-block:: python
+
+    customer = Customer('Barack', 'Obama', '[email protected]', '2024561111', '700 Pennsylvania Avenue NW, Washington, DC, 20408')
+    address = Address('700 Pennsylvania Avenue NW', 'Washington', 'DC', '20408')
+    # or Address(*customer.address.split(',')) if you're lazy
+
+Then, find a store that will deliver to the address.
+
+.. code-block:: python
+
+    store = address.closest_store()
+
+In order to add items to your order, you'll need the items' product codes.
+To find the codes, get the menu from the store, then search for items you want to add.
+You can do this by asking your ``Store`` object for its ``Menu``.
+
+.. code-block:: python
+
+    menu = store.get_menu()
+
+Then search ``menu`` with ``menu.search``. For example, running this command:
+
+.. code-block:: python
+
+    menu.search(Name='Coke')
+
+Should print this to the console:
+
+.. code-block:: text
+
+    20BCOKE    20oz Bottle Coke®        $1.89
+    20BDCOKE   20oz Bottle Diet Coke®   $1.89
+    D20BZRO    20oz Bottle Coke Zero™   $1.89
+    2LDCOKE    2-Liter Diet Coke®       $2.99
+    2LCOKE     2-Liter Coke®            $2.99
+
+After you've found your items' product codes, you can create an ``Order`` object add add your items:
+
+.. code-block:: python
+
+    order = Order(store, customer, address)
+    order.add_item('P12IPAZA') # add a 12-inch pan pizza
+    order.add_item('MARINARA') # with an extra marinara cup
+    order.add_item('20BCOKE')  # and a 20oz bottle of coke
+
+You can remove items as well!
+
+.. code-block:: python
+
+    order.remove_item('20BCOKE')
+
+Wrap your credit card information in a ``PaymentObject``:
+
+.. code-block:: python
+
+    card = PaymentObject('4100123422343234', '0115', '777', '90210')
+
+And that's it! Now you can place your order.
+
+.. code-block:: python
+
+    order.place(card)
+
+Or if you're just testing and don't want to actually order something, use ``.pay_with``.
+
+.. code-block:: python
+
+    order.pay_with(card)

README.rst

@@ -1,12 +1,66 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
 """
+A setuptools based setup module.
+
 See:
 https://packaging.python.org/en/latest/distributing.html
 https://github.com/pypa/sampleproject
+https://github.com/kennethreitz/setup.py
+
+Note: To use the 'upload' functionality of this file, you must:
+  $ pip install twine
 """
+from __future__ import print_function
+import io
+import sys
+from os import path, system
+from shutil import rmtree
 
 # Always prefer setuptools over distutils
-from setuptools import find_packages, setup
+from setuptools import find_packages, setup, Command
+
+here = path.abspath(path.dirname(__file__))
+
+# Import the README.rst and use it as the long-description.
+with io.open(path.join(here, 'README.rst'), encoding='utf-8') as f:
+    long_description = '\n' + f.read()
+
+
+class PublishCommand(Command):
+    """Support setup.py publish."""
+
+    description = 'Build and publish the package.'
+    user_options = []
+
+    @staticmethod
+    def status(s):
+        """Prints things in bold."""
+        print('\033[1m{0}\033[0m'.format(s))
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        try:
+            self.status('Removing previous builds…')
+            rmtree(path.join(here, 'dist'))
+        except OSError:
+            pass
 
+        self.status('Building Source and Wheel (universal) distribution…')
+        system('{0} setup.py sdist bdist_wheel --universal'.format(sys.executable))
+
+        self.status('Uploading the package to PyPi via Twine…')
+        system('twine upload dist/*')
+
+        sys.exit()
+
+
+# Where the magic happens:
 setup(
     name='pizzapi',
 
@@ -16,27 +70,70 @@
     version='0.0.1',
 
     description='A Python wrapper for the Dominos Pizza API',
+    long_description=long_description,
 
     # The project's main homepage.
     url='https://github.com/aluttik/pizzapi',
 
     # Author details
     author='aluttik',
-    author_email='',
+    author_email='[email protected]',
 
     # What does your project relate to?
     keywords='dominos pizza api',
 
+    # Choose your license
+    license='MIT',
+
+    # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
+    classifiers=[
+        # How mature is this project? Common values are
+        #   3 - Alpha
+        #   4 - Beta
+        #   5 - Production/Stable
+        'Development Status :: 3 - Alpha',
+
+        # Pick your license as you wish (should match "license" above)
+        'License :: OSI Approved :: MIT License',
+
+        # TODO: Add testing/support for more python versions
+        # Specify the Python versions you support here. In particular, ensure
+        # that you indicate whether you support Python 2, Python 3 or both.
+        'Programming Language :: Python',
+        # 'Programming Language :: Python :: 2.6',
+        'Programming Language :: Python :: 2.7',
+        # 'Programming Language :: Python :: 3',
+        # 'Programming Language :: Python :: 3.3',
+        # 'Programming Language :: Python :: 3.4',
+        # 'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: Implementation :: CPython',
+        'Programming Language :: Python :: Implementation :: PyPy'
+    ],
+
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().
     packages=find_packages(exclude=['tests']),
 
+    # TODO: Add a command line tool
+    # To provide executable scripts, use entry points in preference to the
+    # "scripts" keyword. Entry points provide cross-platform support and allow
+    # pip to create the appropriate form of executable for the target platform.
+    # entry_points={
+    #     'console_scripts': [
+    #         'pizzapi=pizzapi:main'
+    #     ],
+    # },
+
     # List run-time dependencies here.  These will be installed by pip when
     # your project is installed. For an analysis of "install_requires" vs pip's
     # requirements files see:
     # https://packaging.python.org/en/latest/requirements.html
     install_requires=['requests', 'xmltodict'],
-    extras_require={
-        'test': ['mock', 'PyHamcrest', 'pytest'],
+    include_package_data=True,
+
+    # setup.py publish support.
+    cmdclass={
+        'publish': PublishCommand,
     },
-)
+)