Merge pull request #69 from dvklopfenstein/dev

Creating Microsoft Word docx files is now optional

Author: dvklopfenstein

.github/workflows/pylint.yml

@@ -2,7 +2,7 @@
 # https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token
 name: Pylint
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   build:
@@ -24,20 +24,21 @@ jobs:
       # statuses: none
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v3
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
+    # `pytest` is required for linting because it is imported by some tests
       run: |
         python -m pip install --upgrade pip
         pip install --upgrade build
         pip install --upgrade setuptools[core]
-        pip install pylint
-        pip install pytest
+        pip install --upgrade pylint
+        pip install --upgrade pytest
         pip install pytimeparse2
         pip install dateparser
         pip install python-docx

.timetracker/.gitignore

@@ -90,7 +90,7 @@ $ trk hours
 ## Installation
 Install with [timetracker-csv](https://pypi.org/project/timetracker-csv/) pip:
 ```
-$ pip install timetracker-csv
+$ pip install --upgrade timetracker-csv
 ```
 Or install from source:
 ```

.timetracker/config

@@ -35,8 +35,9 @@ keywords = [
 dependencies = [
   'tomlkit',
   'pytimeparse2',
-  'dateparser',
-  'python-docx',
+  # 'python-docx', # OPTIONAL; lxml (does not install in some systems)
+  #                  typing_extensions
+  'dateparser',    # python-dateutil, pytz, regex, tzlocal
 ]
 
 # https://pypi.org/classifiers/
@@ -46,6 +47,7 @@ classifiers=[
   'Intended Audience :: End Users/Desktop',
   'Topic :: Office/Business :: Financial :: Spreadsheet',
   'Topic :: Office/Business :: News/Diary',
+  'Topic :: Office/Business :: Scheduling',
   'Topic :: Scientific/Engineering',
   'Programming Language :: Python',
   'Environment :: Console',

README.md

@@ -1,53 +1,52 @@
 #!/usr/bin/env python3
-"""Test Timetracker use cases"""
+"""Test Timetracker use cases.
+
+NOTE: Package `lxml` did not load easily in cygwin, hanging in:
+      `Building wheel for lxml (pyproject.toml) ...`
+
+Therefore, `docx` (`pip install python-docx`), is optional.
+I successfully installed it in cygwin by:
+    $ git clone git@github.com:lxml/lxml.git
+    $ cd lxml
+    $ python setup.py build
+    $ python setup.py install
+
+"""
 
-#from os import environ
-#from datetime import timedelta
-#from timeit import default_timer
-#from timetracker.consts import DIRTRK
-#from timetracker.cli import Cli
 from datetime import datetime
 from datetime import timedelta
-from timetracker.docx import WordDoc
+
+from timetracker.docx import write_doc
+from timetracker.docx import write_invoice
+from timetracker.cmd.invoice import _get_billable_timeslots
+
 from timetracker.csvfile import CsvFile
 from timetracker.epoch.text import get_data_formatted
 from tests.pkgtttest.cmpstr import get_filename
 
-# pylint: disable=fixme
 
+def test_docx_report():
+    """Test Timetracker report writing"""
+    print('\nTEST REPORT WRITING...')
+    filename = get_filename('docxtest_report.docx')
+    ##doc = WordDoc(get_data_formatted(_get_datadt()))
+    ##doc.write_doc(filename)
+    time_formatted = get_data_formatted(_get_datadt())
+    exp = _get_exp_worddoc()
+    assert (act := write_doc(filename, time_formatted)) == exp, f'WordDoc: EXP({exp}) != ACT({act})'
 
-def test_docx():
+def test_docx_invoice():
     """Test Timetracker use cases"""
-    filename = get_filename('docxtest.docx')
-    doc = WordDoc(get_data_formatted(_get_datadt()))
-    doc.write_doc(filename)
-    # pylint: disable=line-too-long
-    # make clobber
-
-    # trk
-    # Run `trk init` to initialize time-tracking for the project in
-
-    # trk
-    # Run `trk init` to initialize time-tracking for the project in
+    print('\nTEST INVOICE WRITING...')
+    filename = get_filename('docxtest_invoice.docx')
+    ##doc = WordDoc(get_data_formatted(_get_datadt()))
+    ##doc.write_doc(filename)
+    ##time_formatted = get_data_formatted(_get_datadt())
+    nttimeslots = _get_datadt()
+    exp = _get_exp_worddoc()
+    billable = _get_billable_timeslots(nttimeslots, hourly_rate=350)
+    assert (act := write_invoice(filename, billable)) == exp, f'WordDoc: EXP({exp}) != ACT({act})'
 
-    # trk init
-    # Initialized timetracker directory:
-
-    # trk init
-    # Trk repository already initialized:
-
-    # trk start
-    # Timetracker started Wed 03:21 PM: 2025-02-05 15:21:36.452917 for project 'timetracker' ID=username
-
-    # trk start
-    # Do `trk stop -m "task description"` to stop tracking this time unit
-
-    # trk stop
-    # usage: timetracker stop [-h] -m MESSAGE [--activity ACTIVITY] [-t [TAGS ...]]
-    # timetracker stop: error: the following arguments are required: -m/--message
-
-    # trk stop -m 'test stopped'
-    # Timer stopped; Elapsed H:M:S=0:00:19.531226 appended to timetracker_timetracker_username.csv
 
 def _get_datadt():
     # pylint: disable=line-too-long
@@ -74,5 +73,16 @@ def _get_datadt():
     ]
 
 
+def _get_exp_worddoc():
+    try:
+        # pylint: disable=import-outside-toplevel
+        # pylint: disable=unused-import
+        import docx
+        return True
+    except ModuleNotFoundError:
+        return False
+
+
 if __name__ == '__main__':
-    test_docx()
+    test_docx_report()
+    test_docx_invoice()

pyproject.toml

@@ -11,7 +11,8 @@
 from timetracker.cmd.common import str_uninitialized
 from timetracker.epoch.calc import str_td
 from timetracker.csvfile import CsvFile
-from timetracker.docx import WordDoc
+#from timetracker.docx import WordDoc
+from timetracker.docx import write_invoice
 
 NtPaid = namedtuple('NtPaid', 'span cum_time due desc')
 
@@ -64,12 +65,13 @@ def run_invoice(fcsv, fout_docx='invoice.docx', hourly_rate=100):  #, report_all
         billable = _get_billable_timeslots(ntcsv.results, hourly_rate)
         num_billable = len(billable)
         if num_billable != 0:
-            doc = WordDoc()
-            ##doc.write_doc(fout_docx)
-            doc.write_invoice(fout_docx, billable)
+            ##doc = WordDoc()
+            ##doc.write_invoice(fout_docx, billable)
+            write_invoice(fout_docx, billable)
             print(f'WROTE: {num_billable} billable rows of {num_all} total rows: {fout_docx}')
         else:
-            print('Use `--bill-all` to get an invoice for all timeslots')
+            print('INFO: NO TIMESLOTS MARKED BILLABLE; '
+                  'Use `--bill-all` to get an invoice for all timeslots')
     return ntcsv
 
 def _get_billable_timeslots(nts, hourly_rate, currency_sym='$'):

tests/test_docx.py

@@ -32,10 +32,10 @@ def _show_projects(cfg_glb, show_exists=False):
         print(f'{len(proj_cfgs)} projects listed in global config: {cfg_glb.filename}')
         if not show_exists:
             for proj, pcfg in proj_cfgs:
-                print(f'    {proj:25} {dirname(pcfg)}')
+                print(f'    {proj:25} {dirname(dirname(pcfg))}')
         else:
             for proj, pcfg in proj_cfgs:
-                print(f'exists({int(exists(pcfg))})    {proj:25} {dirname(pcfg)}')
+                print(f'exists({int(exists(pcfg))})    {proj:25} {dirname(dirname(pcfg))}')
     else:
         print(f'There are no projects in {cfg_glb.filename}')
 

timetracker/cmd/invoice.py

@@ -8,10 +8,10 @@
 from timetracker.cmd.common import no_csv
 from timetracker.cmd.common import str_uninitialized
 from timetracker.csvfile import CsvFile
-from timetracker.docx import WordDoc
 from timetracker.epoch.text import get_data_formatted
 from timetracker.csvrun import chk_n_convert
 from timetracker.report import prt_basic
+from timetracker.docx import write_doc
 
 
 def cli_run_report(fcfgproj, args):
@@ -55,8 +55,9 @@ def run_report(fcsv, fout_docx):
         timefmtd = get_data_formatted(ntcsv.results)
         prt_basic(timefmtd)
         if fout_docx:
-            doc = WordDoc(timefmtd)
-            doc.write_doc(fout_docx)
+            ##doc = get_worddoc(timefmtd)
+            ##doc.write_doc(fout_docx)
+            write_doc(fout_docx, timefmtd)
     return ntcsv
 
 

timetracker/cmd/projects.py

@@ -70,7 +70,7 @@ def run_stop(cfgproj, uname, csvfields, stop_at=None, **kwargs):
 def _msg_stop_complete(fcsv, delta, stoptime, quiet):
     """Finish stopping"""
     if not quiet:
-        print(f'Timetracker stopped at: {stoptime.strftime(consts.FMTDT_H)}: {stoptime}\n'
+        print(f'Timetracker stopped at: {stoptime.strftime(consts.FMTDT_H)}\n'
               f'Elapsed H:M:S {delta} appended to {get_shortest_name(fcsv)}')