Initial bootstrap of modern package template

.gitignore

@@ -1,27 +1,11 @@
-*.py[co]
-
-# Packages
-*.egg
-*.egg-info
-dist
-build
-eggs
-parts
-bin
-var
-sdist
-develop-eggs
-.installed.cfg
-
-# Installer logs
-pip-log.txt
-
-# Unit test / coverage reports
-.coverage
-.tox
-
-#Translations
-*.mo
-
-#Mr Developer
-.mr.developer.cfg
+*.pyc
+
+.installed.cfg
+bin
+develop-eggs
+
+*.egg-info
+
+tmp
+build
+dist

HACKING.txt

@@ -0,0 +1,19 @@
+Development setup
+=================
+
+To create a buildout,
+
+  $ python bootstrap.py
+  $ bin/buildout
+
+Release HOWTO
+=============
+
+To make a release, 
+
+  1) Update release date/version in NEWS.txt and setup.py
+  2) Run 'python setup.py sdist'
+  3) Test the generated source distribution in dist/
+  4) Upload to PyPI: 'python setup.py sdist register upload'
+  5) Increase version in setup.py (for next release)
+

MANIFEST.in

@@ -0,0 +1,2 @@
+include README.rst
+include NEWS.txt

NEWS.txt

@@ -0,0 +1,23 @@
+.. This is your project NEWS file which will contain the release notes.
+.. Example: http://www.python.org/download/releases/2.6/NEWS.txt
+.. The content of this file, along with README.rst, will appear in your
+.. project's PyPI page.
+
+News
+====
+
+0.2a1
+-----
+
+*Release date: UNRELEASED*
+
+* Example news entry for the in-development version
+
+
+0.1
+---
+
+*Release date: 15-Mar-2010*
+
+* Example news entry for a released version
+

README.md

@@ -1,4 +0,0 @@
-breadability
-============
-
-Reworked Python Readability parsing library. 

README.rst

@@ -0,0 +1,23 @@
+This file requires editing
+==========================
+
+Note to the author: Please add something informative to this README *before*
+releasing your software, as `a little documentation goes a long way`_.  Both
+README.rst (this file) and NEWS.txt (release notes) will be included in your
+package metadata which gets displayed in the PyPI page for your project.
+
+You can take a look at the README.txt of other projects, such as repoze.bfg
+(http://bfg.repoze.org/trac/browser/trunk/README.txt) for some ideas.
+
+.. _`a little documentation goes a long way`: http://www.martinaspeli.net/articles/a-little-documentation-goes-a-long-way
+
+Credits
+-------
+
+- `Distribute`_
+- `Buildout`_
+- `modern-package-template`_
+
+.. _Buildout: http://www.buildout.org/
+.. _Distribute: http://pypi.python.org/pypi/distribute
+.. _`modern-package-template`: http://pypi.python.org/pypi/modern-package-template

setup.py

@@ -0,0 +1,38 @@
+from setuptools import setup, find_packages
+import sys, os
+
+here = os.path.abspath(os.path.dirname(__file__))
+README = open(os.path.join(here, 'README.rst')).read()
+NEWS = open(os.path.join(here, 'NEWS.txt')).read()
+
+
+version = '0.1'
+
+install_requires = [
+    # List your project dependencies here.
+    # For more details, see:
+    # http://packages.python.org/distribute/setuptools.html#declaring-dependencies
+]
+
+
+setup(name='breadability',
+    version=version,
+    description="Redone port of Readability API in Python",
+    long_description=README + '\n\n' + NEWS,
+    classifiers=[
+      # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
+    ],
+    keywords='readable parsing html content bookie',
+    author='Rick Harding',
+    author_email='rharding@mitechie.com',
+    url='http://docs.bmark.us',
+    license='BSD',
+    packages=find_packages('src'),
+    package_dir = {'': 'src'},include_package_data=True,
+    zip_safe=False,
+    install_requires=install_requires,
+    entry_points={
+        'console_scripts':
+            ['breadability=breadability:main']
+    }
+)

src/breadability/__init__.py

@@ -0,0 +1,4 @@
+# Example package with a console entry point
+
+def main():
+    print "Hello World"