[med-svn] [python-mne] 10/376: adding packaging info

[Yaroslav Halchenko]

This is an automated email from the git hooks/post-receive script.

yoh pushed a commit to annotated tag v0.1
in repository python-mne.

commit b91920ba477a7a9603200284391ceb17459ca657
Author: Alexandre Gramfort <alexandre.gramfort at inria.fr>
Date:   Tue Dec 28 15:50:10 2010 -0500

    adding packaging info
---
 AUTHORS.rst |  6 ++++++
 MANIFEST.in |  5 +++++
 README.rst  | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 setup.cfg   | 10 ++++++++++
 setup.py    | 51 ++++++++++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 134 insertions(+)

diff --git a/AUTHORS.rst b/AUTHORS.rst
new file mode 100644
index 0000000..b4742d5
--- /dev/null
+++ b/AUTHORS.rst
@@ -0,0 +1,6 @@
+.. -*- mode: rst -*-
+
+Authors
+=======
+
+  * Alexandre Gramfort <gramfort at nmr.mgh.harvard.edu> 2010
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..4d6d738
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,5 @@
+include *.rst
+include fiff/__init__.py
+recursive-include doc *
+recursive-include examples *
+recursive-include fiff *.py
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..eec0a48
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,62 @@
+.. -*- mode: rst -*-
+
+About
+=====
+
+pyfiff is a python module for reading and writing the fif files
+produced by Neuromag MEG systems.
+
+Download
+========
+
+TODO
+
+Dependencies
+============
+
+The required dependencies to build the software are python >= 2.5,
+NumPy >= 1.1, SciPy >= 0.6.
+
+To run the tests you will also need nose >= 0.10.
+
+Install
+=======
+
+This packages uses distutils, which is the default way of installing
+python modules. The install command is::
+
+  python setup.py install
+
+
+Mailing list
+============
+
+None
+
+Development
+===========
+
+Code
+----
+
+GIT
+~~~
+
+You can check the latest sources with the command::
+
+    git clone git://github.com/agramfort/pyfiff.git
+
+or if you have write privileges::
+
+    git clone git at github.com/agramfort/pyfiff.git
+
+Bugs
+----
+
+Please report bugs you might encounter to:
+gramfort at nmr.mgh.harvard.edu
+
+Testing
+-------
+
+You can launch the test suite using nosetest from the source folder.
\ No newline at end of file
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..6cec9dd
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,10 @@
+[aliases]
+# python2.7 has upgraded unittest and it is no longer compatible with some
+# of our tests, so we run all through nose
+test = nosetests
+
+[nosetests]
+detailed-errors = 1
+with-doctest = 1
+cover-package = fiff
+
diff --git a/setup.py b/setup.py
index e69de29..b9b78b1 100644
--- a/setup.py
+++ b/setup.py
@@ -0,0 +1,51 @@
+#! /usr/bin/env python
+#
+# Copyright (C) 2010 Alexandre Gramfort <gramfort at nmr.mgh.harvard.edu>
+
+descr   = """A set of python functions to read and write Neuromag FIF files."""
+
+import os
+
+
+DISTNAME            = 'pyfiff'
+DESCRIPTION         = 'Functions to read and write Neuromag FIF files.'
+LONG_DESCRIPTION    = descr
+MAINTAINER          = 'Alexandre Gramfort'
+MAINTAINER_EMAIL    = 'gramfort at nmr.mgh.harvard.edu'
+URL                 = 'http://github.com/agramfort/pyfiff'
+LICENSE             = 'To be determined' # XXX
+DOWNLOAD_URL        = 'http://github.com/agramfort/pyfiff'
+VERSION             = '0.1.git'
+
+import setuptools # we are using a setuptools namespace
+from numpy.distutils.core import setup
+
+
+if __name__ == "__main__":
+    if os.path.exists('MANIFEST'): os.remove('MANIFEST')
+
+    setup(name = DISTNAME,
+        maintainer  = MAINTAINER,
+        include_package_data = True,
+        maintainer_email = MAINTAINER_EMAIL,
+        description = DESCRIPTION,
+        license = LICENSE,
+        url = URL,
+        version = VERSION,
+        download_url = DOWNLOAD_URL,
+        long_description = LONG_DESCRIPTION,
+        zip_safe=False, # the package can run out of an .egg file
+        classifiers =
+            ['Intended Audience :: Science/Research',
+             'Intended Audience :: Developers',
+             'License :: OSI Approved',
+             'Programming Language :: C',
+             'Programming Language :: Python',
+             'Topic :: Software Development',
+             'Topic :: Scientific/Engineering',
+             'Operating System :: Microsoft :: Windows',
+             'Operating System :: POSIX',
+             'Operating System :: Unix',
+             'Operating System :: MacOS'
+             ]
+    )

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-med/python-mne.git