Merge pull request #18 from pitthsls/sushiclient

use single branch; having sushiclient branch is becoming annoying.

.travis.yml

@@ -13,7 +13,6 @@ python:
 
 install:
   - pip install .
-  - pip install git+https://github.com/PyCQA/pep8.git
   - pip install httmock
   - pip install coveralls
   - pip install flake8

README.rst

@@ -83,3 +83,7 @@ Fetching SUSHI data::
     Sqornshellous Swamptalk
     Acta Mattressica
 
+Output of report as TSV (currently only supports JR1)::
+
+    >>> report.write_tsv("/tmp/counterreport.tsv")
+

docs/source/conf.py

@@ -15,13 +15,14 @@
 import sys
 import os
 
-# noinspection PyProtectedMember
-from pycounter.version import __version__
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath('../../pycounter'))
+sys.path.append(os.path.join(os.path.dirname(__file__), '../..'))
+print(sys.path)
+# noinspection PyProtectedMember
+from pycounter.version import __version__
 
 # -- General configuration ------------------------------------------------
 

pycounter/report.py

@@ -238,12 +238,12 @@ def __iter__(self):
             for item in self._full_data:
                 yield (item[0], self.metric, item[1])
         else:
-            currmonth = self.period[0]
-            mondat = iter(self._monthdata)
-            while currmonth < self.period[1]:
-                currusage = next(mondat)
-                yield (currmonth, self.metric, currusage)
-                currmonth = next_month(currmonth)
+            current_month = self.period[0]
+            month_data_iter = iter(self._monthdata)
+            while current_month < self.period[1]:
+                current_usage = next(month_data_iter)
+                yield (current_month, self.metric, current_usage)
+                current_month = next_month(current_month)
 
 
 class CounterJournal(CounterEresource):
@@ -391,6 +391,8 @@ def __init__(self, line=None, period=None, metric=None, month_data=None,
 def format_stat(stat):
     """Turn string numbers that might have an embedded comma into
     integers
+
+    :param stat: numeric value, possibly with commas, to turn into int
     """
     stat = stat.replace(',', '')
     try:
@@ -419,12 +421,12 @@ def parse(filename, filetype=None):
         elif filename.endswith('.csv'):
             filetype = 'csv'
         else:
-            with open(filename, 'rb') as fobj:
-                firstbytes = fobj.read(2)
-                if firstbytes == b"PK":
+            with open(filename, 'rb') as file_obj:
+                first_bytes = file_obj.read(2)
+                if first_bytes == b"PK":
                     filetype = 'xlsx'
                 else:
-                    content = fobj.read()
+                    content = file_obj.read()
                     if b'\t' in content:
                         filetype = 'tsv'
                     else:
@@ -449,8 +451,8 @@ def parse_xlsx(filename):
 
     """
     from openpyxl import load_workbook
-    with open(filename, 'rb') as xlsxfile:
-        workbook = load_workbook(xlsxfile)
+    with open(filename, 'rb') as xlsx_file:
+        workbook = load_workbook(xlsx_file)
         worksheet = workbook.get_sheet_by_name(workbook.get_sheet_names()[0])
         row_it = worksheet.iter_rows()
         split_row_list = ([cell.value if cell.value is not None else ""
@@ -562,12 +564,12 @@ def parse_generic(report_reader):
             continue
         if report.report_version == 4:
             if report.report_type.startswith('JR1'):
-                oldline = line
+                old_line = line
                 line = line[0:3] + line[5:7] + line[10:last_col]
-                doi = oldline[3]
-                prop_id = oldline[4]
-                html_total = int(oldline[8])
-                pdf_total = int(oldline[9])
+                doi = old_line[3]
+                prop_id = old_line[4]
+                html_total = int(old_line[8])
+                pdf_total = int(old_line[9])
 
             elif report.report_type in ('BR1', 'BR2'):
                 line = line[0:3] + line[5:7] + line[8:last_col]

pycounter/sushiclient.py

@@ -0,0 +1,6 @@
+"""command line client to fetch statistics via SUSHI"""
+from __future__ import print_function
+
+
+def main():
+    print("pycounter SUSHI client.")

pycounter/version.py

@@ -1 +1,2 @@
-__version__ = "0.9.dev1"
+"""version information"""
+__version__ = "0.9.dev2"

setup.py

@@ -32,7 +32,10 @@
         'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
         ],
-    install_requires=['pyisbn', 'openpyxl<2.3', 'lxml', 'requests',
+    install_requires=['pyisbn', 'openpyxl<2.3', 'lxml<=3.4.4', 'requests',
                       'six', 'arrow'],
     tests_require=['httmock', 'mock'],
+    entry_points={
+        'console_scripts': ['sushiclient = pycounter.sushiclient:main']
+    }
     )