add version in modules main __init__

nipreps · Mar 11, 2016 · f73a71f · f73a71f
1 parent cb7c26a
commit f73a71f
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 5 deletions.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -2,6 +2,9 @@ Release 0.0.2
 =============
 
 * Completed migration from QAP
+* Integration with ReadTheDocs
+* Submission to PyPi
+
 
 Release 0.0.1
 =============

diff --git a/mriqc/__init__.py b/mriqc/__init__.py
@@ -2,6 +2,32 @@
 # -*- coding: utf-8 -*-
 # emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: nil -*-
 # vi: set ft=python sts=4 ts=4 sw=4 et:
+"""
+The mriqc package provides a series of :abbr:`NR (no-reference)`,
+:abbr:`IQMs (image quality metrics)` to used in :abbr:`QAPs (quality
+assessment protocols)` for :abbr:`MRI (magnetic resonance imaging)`.
 
-import workflows
-import interfaces
+Dependencies
+------------
+
+Make sure you have FSL and AFNI installed, and the binaries available in
+the system's $PATH.
+
+Installation
+------------
+
+Just issue:
+
+::
+
+    pip install mriqc
+
+Example command line:
+---------------------
+
+::
+
+    mriqc -i ~/Data/bids_dataset -o out/ -w work/
+"""
+
+__version__ = '0.0.2rc2'
diff --git a/setup.py b/setup.py
@@ -3,12 +3,11 @@
 # @Author: oesteban
 # @Date:   2015-11-19 16:44:27
 # @Last Modified by:   oesteban
-# @Last Modified time: 2016-03-11 13:49:49
+# @Last Modified time: 2016-03-11 13:55:09
 """ MRIQC setup script """
 import os
 import sys
-
-__version__ = '0.0.2rc1'
+from mriqc import __version__
 
 
 def main():