MAINT v0.1

CONTRIBUTING.md

@@ -0,0 +1,38 @@
+Contributions
+-------------
+
+Contributions are welcome in the form of pull requests.
+
+Once the implementation of a piece of functionality is considered to be bug
+free and properly documented (both API docs and an example script),
+it can be incorporated into the master branch.
+
+To help developing `mne-bids`, you will need a few adjustments to your
+installation as shown below.
+
+##### Running tests
+
+To run the tests using `pytest`, you need to have the git cloned mne-python
+repository with a local pip-install instead of the mne-python package from
+pypi. Update your installation as follows.
+
+    $ git clone https://github.com/mne-tools/mne-python --depth 1
+    $ cd mne-python
+    $ pip uninstall mne  # uninstall pypi mne
+    $ pip install -e .  # use the cloned repo for a local install of mne
+
+Then, install the following python packages:
+
+    $ pip install flake8 pytest pytest-cov
+
+Finally, it is necessary to install the
+[BIDS validator](https://github.com/bids-standard/bids-validator). The outputs
+of MNE-BIDS are run through the BIDS validator to check if the conversion
+worked.
+
+##### Building the documentation
+
+The documentation can be built using sphinx. For that, please additionally
+install the following:
+
+    $ pip install sphinx numpydoc sphinx-gallery sphinx_bootstrap_theme pillow

README.md

@@ -23,7 +23,7 @@ to be able to use `mne_bids`:
 
 Then install `mne_bids`:
 
-    $ pip install git+https://github.com/mne-tools/mne-bids.git#egg=mne-bids
+    $ pip install -U mne-bids
 
 If you do not have administrator privileges on the computer, use the `--user`
 flag with `pip`. To upgrade, use the `--upgrade` flag provided by `pip`.
@@ -46,46 +46,6 @@ Example :
 $ mne_bids raw_to_bids --subject_id sub01 --task rest --raw_file data.edf --output_path new_path
 ```
 
-Contributions
--------------
-
-Contributions are welcome in the form of pull requests.
-
-Once the implementation of a piece of functionality is considered to be bug
-free and properly documented (both API docs and an example script),
-it can be incorporated into the master branch.
-
-To help developing `mne-bids`, you will need a few adjustments to your
-installation as shown below.
-
-##### Running tests
-
-To run the tests using `pytest`, you need to have the git cloned mne-python
-repository with a local pip-install instead of the mne-python package from
-pypi. Update your installation as follows.
-
-    $ git clone https://github.com/mne-tools/mne-python --depth 1
-    $ cd mne-python
-    $ pip uninstall mne  # uninstall pypi mne
-    $ pip install -e .  # use the cloned repo for a local install of mne
-
-Then, install the following python packages:
-
-    $ pip install flake8 pytest pytest-cov
-
-Finally, it is necessary to install the
-[BIDS validator](https://github.com/bids-standard/bids-validator). The outputs
-of MNE-BIDS are run through the BIDS validator to check if the conversion
-worked.
-
-##### Building the documentation
-
-The documentation can be built using sphinx. For that, please additionally
-install the following:
-
-    $ pip install sphinx numpydoc sphinx-gallery sphinx_bootstrap_theme pillow
-
-
 Cite
 ----
 

doc/conf.py

@@ -71,9 +71,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'0.1.dev0'
+version = u'0.1'
 # The full version, including alpha/beta/rc tags.
-release = u'0.1.dev0'
+release = u'0.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

doc/index.rst

@@ -18,7 +18,7 @@ We recommend the `Anaconda Python distribution <https://www.continuum.io/downloa
 
 Then install mne_bids::
 
-    $ pip install git+https://github.com/mne-tools/mne-bids.git#egg=mne-bids
+    $ pip install -U mne-bids
 
 If you do not have admin privileges on the computer, use the ``--user`` flag
 with `pip`. To upgrade, use the ``--upgrade`` flag provided by `pip`.

doc/whats_new.rst

@@ -9,8 +9,8 @@ What's new?
 
 .. _current:
 
-Current
--------
+Version 0.1
+-----------
 
 Changelog
 ~~~~~~~~~
@@ -38,6 +38,20 @@ Bug
 - Fix the way FIF files are named to satisfy the BIDS part parameters of the filename construction, `Teon Brooks`_ (`#102 <https://github.com/mne-tools/mne-bids/pull/102>`_)
 - Fix how overwriting of data is handled, by `Matt Sanderson`_ (`#99 <https://github.com/mne-tools/mne-bids/pull/99>`_)
 
+Authors
+~~~~~~~
+
+People who contributed to this release  (in alphabetical order):
+
+* Alexandre Gramfort
+* Chris Holdgraf
+* Kambiz Tavabi
+* Mainak Jas
+* Matt Sanderson
+* Romain Quentin
+* Stefan Appel
+* Teon Brooks
+
 .. _Mainak Jas: https://perso.telecom-paristech.fr/mjas/
 .. _Teon Brooks: https://teonbrooks.github.io/
 .. _Chris Holdgraf: https://bids.berkeley.edu/people/chris-holdgraf

mne_bids/__init__.py

@@ -1,6 +1,6 @@
 """MNE software for making MEG BIDS compatible datasets easily."""
 
-__version__ = '0.1.dev0'
+__version__ = '0.1'
 
 
 from .mne_bids import write_raw_bids  # noqa

setup.py

@@ -10,7 +10,7 @@
 URL = 'https://mne-tools.github.io/mne-bids/'
 LICENSE = 'BSD (3-clause)'
 DOWNLOAD_URL = 'http://github.com/mne-tools/mne-bids'
-VERSION = '0.1.dev0'
+VERSION = '0.1'
 
 if __name__ == "__main__":
     setup(name=DISTNAME,
@@ -22,6 +22,7 @@
           version=VERSION,
           download_url=DOWNLOAD_URL,
           long_description=open('README.md').read(),
+          long_description_content_type='text/markdown',
           classifiers=[
               'Intended Audience :: Science/Research',
               'Intended Audience :: Developers',