[META] Preparing for beta release

README.rst

@@ -0,0 +1,41 @@
+.. image:: https://arvoelke.github.io/nengolib-docs/_static/logo.png
+   :width: 64
+   :height: 64
+   :target: https://github.com/arvoelke/nengolib
+   :alt: Nengolib Logo
+
+.. image:: https://travis-ci.org/arvoelke/nengolib.svg?branch=master
+   :target: https://travis-ci.org/arvoelke/nengolib
+   :alt: Build Status
+
+.. image:: https://codecov.io/github/arvoelke/nengolib/coverage.svg?branch=master
+   :target: https://codecov.io/github/arvoelke/nengolib?branch=master
+   :alt: Code Coverage
+
+import nengolib
+===============
+
+Additional extensions and tools for modelling dynamical systems in
+`Nengo <https://github.com/nengo/nengo>`__.
+
+
+`Documentation <https://arvoelke.github.io/nengolib-docs/>`__
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This project's documentation is hosted on GitHub.IO:
+https://arvoelke.github.io/nengolib-docs/.
+
+
+Development
+~~~~~~~~~~~
+
+To install the development version of nengolib::
+
+    git clone https://github.com/arvoelke/nengolib
+    cd nengolib
+    python setup.py develop
+
+Notebooks can be run manually in ``docs/notebooks`` by running::
+
+    pip install jupyter
+    jupyter notebook

docs/conf.py

@@ -94,7 +94,8 @@ def new_show(tight=True, *args, **kwargs):
 # The full version, including alpha/beta/rc tags.
 release = nengolib.__version__
 
-github_url = "https://github.com/arvoelke/nengolib/tree/documenting/nengolib"
+github_url = "https://github.com/arvoelke/nengolib/tree/v%s/nengolib" % (
+    release)
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/index.rst

@@ -19,10 +19,9 @@ Installation
 
 `Nengolib <https://github.com/arvoelke/nengolib/>`_
 is tested against Python 2.7, 3.4, 3.5, and 3.6, and `Nengo`_
-2.1.0, 2.2.0, 2.3.0, 2.4.0, and its development branch.
+2.1.0, 2.2.0, 2.3.0, and 2.4.0.
 The `Nengo GUI <https://github.com/nengo/nengo_gui>`_ is not officially
 supported.
-
 To install::
 
     pip install nengolib

nengolib/version.py

@@ -1,6 +1,6 @@
 """Nengo Library version information."""
 
 version_info = (0, 4, 0)  # (major, minor, patch)
-dev = False
+release_type = "-beta"  # or "-dev" or ""
 
-version = "%s%s" % (".".join(map(str, version_info)), "-dev" if dev else "")
+version = "%s%s" % (".".join(map(str, version_info)), release_type)

setup.cfg

@@ -1,3 +1,6 @@
+[metadata]
+description-file = README.rst
+
 [flake8]
 exclude = _*.py,docs/*.py,build/*.py
 

setup.py

@@ -1,23 +1,52 @@
 #!/usr/bin/env python
 
-import os
 import imp
-from setuptools import setup
+import os
+from setuptools import setup, find_packages
 
 name = 'nengolib'
 root = os.path.dirname(os.path.realpath(__file__))
 version_module = imp.load_source(
     'version', os.path.join(root, name, 'version.py'))
 
-submodules = ['networks', 'signal', 'stats', 'synapses']
-packages = [name] + ['%s/%s' % (name, d) for d in submodules]
+deps = [  # https://github.com/nengo/nengo/issues/508
+    "nengo>=2.1.0",
+    "numpy>=1.10",
+    "scipy>=0.17.0",
+]
+
+download_url = (
+    'https://github.com/arvoelke/nengolib/archive/v%s.tar.gz' % (
+        version_module.version))
 
 setup(
     name=name,
-    description="Nengo Library",
     version=version_module.version,
-    author="Aaron Voelker",
+    author="Aaron R. Voelker",
     author_email="arvoelke@gmail.com",
-    url="https://github.com/arvoelke/%s" % name,
-    packages=packages,
+    description="Tools for robust dynamics in Nengo",
+    url="https://github.com/arvoelke/nengolib/",
+    download_url=download_url,
+    license="Free for non-commercial use (see Nengo license)",
+    packages=find_packages(),
+    setup_requires=deps,
+    install_requires=deps,
+    keywords=[
+        'Neural Engineering Framework',
+        'Nengo',
+        'Dynamical Spiking Networks',
+        'Neural Dynamics',
+        'Reservoir Computing',
+    ],
+    classifiers=[  # https://pypi.python.org/pypi?%3Aaction=list_classifiers
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Science/Research',
+        'Topic :: Scientific/Engineering :: Artificial Intelligence',
+        'License :: Free for non-commercial use',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+    ]
 )