Merge pull request #32 from pennmem/pre_release_updates

Pre release updates

CHANGELOG.rst

@@ -1,6 +1,16 @@
 Changes
 =======
 
+
+Version 0.3.0
+-------------
+**5-24-2018**
+
+* Updated API to use .load() and .get_reader()
+* Added Json, Montage, Localization, Event, Classifier, ReportData, and
+  ElectrodeCateogry readers
+* Refactored base reader class to use a metaclass for registering new readers
+
 Version 0.2.0
 -------------
 **5-15-2018**

cmlreaders/__init__.py

@@ -3,5 +3,5 @@
 from .readers import * # noqa
 from .cmlreader import CMLReader # noqa
 
-__version__ = '0.2.0'
+__version__ = '0.3.0'
 version_info = namedtuple("VersionInfo", "major,minor,patch")(*__version__.split('.'))

docs/api.rst

@@ -10,7 +10,7 @@ Readers
 .. autoclass:: cmlreaders.CMLReader
     :members:
 
-.. automodule:: cmlreaders.readers
+.. automodule:: cmlreaders.readers.readers
     :members:
 
 PathFinder

docs/html/_modules/cmlreaders/cmlreader.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>cmlreaders.cmlreader &mdash; CML Data Readers 0.2.0 documentation</title>
+  <title>cmlreaders.cmlreader &mdash; CML Data Readers 0.3.0 documentation</title>
 
 
 
@@ -57,7 +57,7 @@
 
 
               <div class="version">
-                0.2
+                0.3
               </div>
 
 
@@ -256,7 +256,7 @@ <h1>Source code for cmlreaders.cmlreader</h1><div class="highlight"><pre>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../../',
-            VERSION:'0.2.0',
+            VERSION:'0.3.0',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

docs/html/_modules/cmlreaders/path_finder.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>cmlreaders.path_finder &mdash; CML Data Readers 0.2.0 documentation</title>
+  <title>cmlreaders.path_finder &mdash; CML Data Readers 0.3.0 documentation</title>
 
 
 
@@ -57,7 +57,7 @@
 
 
               <div class="version">
-                0.2
+                0.3
               </div>
 
 
@@ -392,7 +392,7 @@ <h1>Source code for cmlreaders.path_finder</h1><div class="highlight"><pre>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../../',
-            VERSION:'0.2.0',
+            VERSION:'0.3.0',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

docs/html/_modules/index.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Overview: module code &mdash; CML Data Readers 0.2.0 documentation</title>
+  <title>Overview: module code &mdash; CML Data Readers 0.3.0 documentation</title>
 
 
 
@@ -57,7 +57,7 @@
 
 
               <div class="version">
-                0.2
+                0.3
               </div>
 
 
@@ -150,6 +150,7 @@
   <h1>All modules for which code is available</h1>
 <ul><li><a href="cmlreaders/cmlreader.html">cmlreaders.cmlreader</a></li>
 <li><a href="cmlreaders/path_finder.html">cmlreaders.path_finder</a></li>
+<li><a href="cmlreaders/readers/readers.html">cmlreaders.readers.readers</a></li>
 </ul>
 
            </div>
@@ -184,7 +185,7 @@ <h1>All modules for which code is available</h1>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../',
-            VERSION:'0.2.0',
+            VERSION:'0.3.0',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

docs/html/_sources/api.rst.txt

@@ -10,7 +10,7 @@ Readers
 .. autoclass:: cmlreaders.CMLReader
     :members:
 
-.. automodule:: cmlreaders.readers
+.. automodule:: cmlreaders.readers.readers
     :members:
 
 PathFinder

docs/html/_static/documentation_options.js

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: '',
-    VERSION: '0.2.0',
+    VERSION: '0.3.0',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     FILE_SUFFIX: '.html',

docs/html/dev.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Developer’s Guide &mdash; CML Data Readers 0.2.0 documentation</title>
+  <title>Developer’s Guide &mdash; CML Data Readers 0.3.0 documentation</title>
 
 
 
@@ -58,7 +58,7 @@
 
 
               <div class="version">
-                0.2
+                0.3
               </div>
 
 
@@ -252,7 +252,7 @@ <h2>Adding new readers<a class="headerlink" href="#adding-new-readers" title="Pe
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'0.2.0',
+            VERSION:'0.3.0',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

docs/html/genindex.html

@@ -9,7 +9,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Index &mdash; CML Data Readers 0.2.0 documentation</title>
+  <title>Index &mdash; CML Data Readers 0.3.0 documentation</title>
 
 
 
@@ -58,7 +58,7 @@
 
 
               <div class="version">
-                0.2
+                0.3
               </div>
 
 
@@ -154,24 +154,98 @@
 <h1 id="index">Index</h1>
 
 <div class="genindex-jumpbox">
- <a href="#C"><strong>C</strong></a>
+ <a href="#A"><strong>A</strong></a>
+ | <a href="#B"><strong>B</strong></a>
+ | <a href="#C"><strong>C</strong></a>
+ | <a href="#E"><strong>E</strong></a>
  | <a href="#F"><strong>F</strong></a>
  | <a href="#G"><strong>G</strong></a>
  | <a href="#L"><strong>L</strong></a>
  | <a href="#M"><strong>M</strong></a>
  | <a href="#P"><strong>P</strong></a>
  | <a href="#R"><strong>R</strong></a>
  | <a href="#S"><strong>S</strong></a>
+ | <a href="#T"><strong>T</strong></a>
 
 </div>
+<h2 id="A">A</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#cmlreaders.readers.readers.BaseReportDataReader.as_dataframe">as_dataframe() (cmlreaders.readers.readers.BaseReportDataReader method)</a>
+
+      <ul>
+        <li><a href="api.html#cmlreaders.readers.readers.BasicJSONReader.as_dataframe">(cmlreaders.readers.readers.BasicJSONReader method)</a>
+</li>
+        <li><a href="api.html#cmlreaders.readers.readers.CSVReader.as_dataframe">(cmlreaders.readers.readers.CSVReader method)</a>
+</li>
+        <li><a href="api.html#cmlreaders.readers.readers.ClassifierContainerReader.as_dataframe">(cmlreaders.readers.readers.ClassifierContainerReader method)</a>
+</li>
+        <li><a href="api.html#cmlreaders.readers.readers.EventReader.as_dataframe">(cmlreaders.readers.readers.EventReader method)</a>
+</li>
+        <li><a href="api.html#cmlreaders.readers.readers.LocalizationReader.as_dataframe">(cmlreaders.readers.readers.LocalizationReader method)</a>
+</li>
+        <li><a href="api.html#cmlreaders.readers.readers.MontageReader.as_dataframe">(cmlreaders.readers.readers.MontageReader method)</a>
+</li>
+        <li><a href="api.html#cmlreaders.readers.readers.RamulatorEventLogReader.as_dataframe">(cmlreaders.readers.readers.RamulatorEventLogReader method)</a>
+</li>
+        <li><a href="api.html#cmlreaders.readers.readers.ReportSummaryDataReader.as_dataframe">(cmlreaders.readers.readers.ReportSummaryDataReader method)</a>
+</li>
+        <li><a href="api.html#cmlreaders.readers.readers.TextReader.as_dataframe">(cmlreaders.readers.readers.TextReader method)</a>
+</li>
+      </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#cmlreaders.readers.readers.ElectrodeCategoriesReader.as_dict">as_dict() (cmlreaders.readers.readers.ElectrodeCategoriesReader method)</a>
+
+      <ul>
+        <li><a href="api.html#cmlreaders.readers.readers.RamulatorEventLogReader.as_dict">(cmlreaders.readers.readers.RamulatorEventLogReader method)</a>
+</li>
+      </ul></li>
+      <li><a href="api.html#cmlreaders.readers.readers.BaseReportDataReader.as_pyobject">as_pyobject() (cmlreaders.readers.readers.BaseReportDataReader method)</a>
+
+      <ul>
+        <li><a href="api.html#cmlreaders.readers.readers.ReportSummaryDataReader.as_pyobject">(cmlreaders.readers.readers.ReportSummaryDataReader method)</a>
+</li>
+      </ul></li>
+  </ul></td>
+</tr></table>
+
+<h2 id="B">B</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#cmlreaders.readers.readers.BaseReportDataReader">BaseReportDataReader (class in cmlreaders.readers.readers)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#cmlreaders.readers.readers.BasicJSONReader">BasicJSONReader (class in cmlreaders.readers.readers)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#cmlreaders.readers.readers.ClassifierContainerReader">ClassifierContainerReader (class in cmlreaders.readers.readers)</a>
+</li>
       <li><a href="api.html#cmlreaders.CMLReader">CMLReader (class in cmlreaders)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api.html#module-cmlreaders.readers">cmlreaders.readers (module)</a>
+      <li><a href="api.html#module-cmlreaders.readers.readers">cmlreaders.readers.readers (module)</a>
+</li>
+      <li><a href="api.html#cmlreaders.readers.readers.CSVReader">CSVReader (class in cmlreaders.readers.readers)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="E">E</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#cmlreaders.readers.readers.ElectrodeCategoriesReader">ElectrodeCategoriesReader (class in cmlreaders.readers.readers)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#cmlreaders.readers.readers.EventReader">EventReader (class in cmlreaders.readers.readers)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -200,6 +274,8 @@ <h2 id="L">L</h2>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#cmlreaders.PathFinder.localization_files">localization_files (cmlreaders.PathFinder attribute)</a>
+</li>
+      <li><a href="api.html#cmlreaders.readers.readers.LocalizationReader">LocalizationReader (class in cmlreaders.readers.readers)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -208,6 +284,10 @@ <h2 id="M">M</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#cmlreaders.PathFinder.montage_files">montage_files (cmlreaders.PathFinder attribute)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#cmlreaders.readers.readers.MontageReader">MontageReader (class in cmlreaders.readers.readers)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -223,6 +303,12 @@ <h2 id="P">P</h2>
 <h2 id="R">R</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#cmlreaders.readers.readers.RamulatorEventLogReader">RamulatorEventLogReader (class in cmlreaders.readers.readers)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#cmlreaders.readers.readers.ReportSummaryDataReader">ReportSummaryDataReader (class in cmlreaders.readers.readers)</a>
+</li>
       <li><a href="api.html#cmlreaders.PathFinder.requestable_files">requestable_files (cmlreaders.PathFinder attribute)</a>
 </li>
   </ul></td>
@@ -240,6 +326,18 @@ <h2 id="S">S</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="T">T</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#cmlreaders.readers.readers.TextReader">TextReader (class in cmlreaders.readers.readers)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#cmlreaders.readers.readers.ClassifierContainerReader.to_binary">to_binary() (cmlreaders.readers.readers.ClassifierContainerReader method)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 
 
            </div>
@@ -274,7 +372,7 @@ <h2 id="S">S</h2>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'0.2.0',
+            VERSION:'0.3.0',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

docs/html/getting_started.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Getting Started with CML Readers &mdash; CML Data Readers 0.2.0 documentation</title>
+  <title>Getting Started with CML Readers &mdash; CML Data Readers 0.3.0 documentation</title>
 
 
 
@@ -59,7 +59,7 @@
 
 
               <div class="version">
-                0.2
+                0.3
               </div>
 
 
@@ -955,7 +955,7 @@ <h2>Saving Data<a class="headerlink" href="#Saving-Data" title="Permalink to thi
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'0.2.0',
+            VERSION:'0.3.0',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

docs/html/index.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Computational Memory Lab Data Readers &mdash; CML Data Readers 0.2.0 documentation</title>
+  <title>Computational Memory Lab Data Readers &mdash; CML Data Readers 0.3.0 documentation</title>
 
 
 
@@ -58,7 +58,7 @@
 
 
               <div class="version">
-                0.2
+                0.3
               </div>
 
 
@@ -242,7 +242,7 @@ <h1>Computational Memory Lab Data Readers<a class="headerlink" href="#computatio
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'0.2.0',
+            VERSION:'0.3.0',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',