Merge pull request #256 from wasi0013/v0.0.14

V0.0.14

Author: wasi0013

HISTORY.rst

@@ -86,4 +86,13 @@ History
 0.0.13 (2023-11-07)
 -------------------
 
-* Made the init command optional.
+* Made the init command optional.
+
+0.0.14 (2023-11-07)
+-------------------
+
+* config invoice command bug fix.
+* copy logo instead of moving it permanently when configuring invoice.
+* fixed f strings quote issue.
+* made init command hidden.
+* improved doc strings and help texts.

PyTM/__init__.py

@@ -1,3 +1,3 @@
 __author__ = "Wasi"
 __email__ = "wasi0013@gmail.com"
-__version__ = "0.0.13"
+__version__ = "0.0.14"

PyTM/cli.py

@@ -1,106 +1,132 @@
-import click
-from PyTM.core.project_handler import create_project, pause_project, finish_project, project_summary, project_status, remove_project, abort_project
 from functools import partial
-from PyTM.core.data_handler import update, load_data, save_data
-import PyTM.core.task_handler as task_handler 
-import PyTM.settings as settings
-from PyTM.console import console
-from rich.tree import Tree
+
+import click
 from rich.panel import Panel
-import json
+from rich.tree import Tree
+
+from PyTM import settings
+from PyTM.console import console
+from PyTM.core import task_handler
+from PyTM.core import data_handler
+from PyTM.core import project_handler
 
 
 def _get_duration_str(sum_of_durations):
     m, s = divmod(sum_of_durations, 60)
-    duration = ''
+    duration = ""
     if m > 60:
         h, m = divmod(m, 60)
         if h > 24:
             d, h = divmod(h, 24)
-            duration = f'{d:d} days {h:d} hours {m:02d} mins {s:02d} secs'
+            duration = f"{d:d} days {h:d} hours {m:02d} mins {s:02d} secs"
         else:
-            duration = f'{h:d} hours {m:02d} mins {s:02d} secs'
+            duration = f"{h:d} hours {m:02d} mins {s:02d} secs"
     elif m < 1:
-        duration = f'{s:02d} seconds'
+        duration = f"{s:02d} seconds"
     else:
-        duration = f'{m:02d} mins {s:02d} secs'
+        duration = f"{m:02d} mins {s:02d} secs"
     return duration
 
+
 @click.group()
 def project():
     """
     pytm sub-command for managing projects.
     """
     pass
 
+
 @project.command()
 def abort():
     """
     - aborts the current project and task.
     """
-    state = load_data(settings.state_filepath)
+    state = data_handler.load_data(settings.state_filepath)
     project_name = state.get(settings.CURRENT_PROJECT)
     if project_name:
-        update(partial(abort_project, project_name=project_name))
+        data_handler.update(partial(project_handler.abort, project_name=project_name))
         state[settings.CURRENT_PROJECT] = ""
         if state[settings.CURRENT_TASK]:
-            update(partial(task_handler.abort, project_name=project_name, task_name=state[settings.CURRENT_TASK])) 
+            data_handler.update(
+                partial(
+                    task_handler.abort,
+                    project_name=project_name,
+                    task_name=state[settings.CURRENT_TASK],
+                )
+            )
             state[settings.CURRENT_TASK] = ""
-        save_data(state, settings.state_filepath)
+        data_handler.save_data(state, settings.state_filepath)
         console.print(f"[bold blue]{project_name}[/bold blue] aborted.")
     else:
         console.print("[bold red]No active project.")
 
+
 @project.command()
 def finish():
     """
     - marks the current project as finished.
     """
-    state = load_data(settings.state_filepath)
+    state = data_handler.load_data(settings.state_filepath)
     project_name = state.get(settings.CURRENT_PROJECT)
     if project_name:
-        update(partial(finish_project, project_name=project_name))
+        data_handler.update(partial(project_handler.finish, project_name=project_name))
         state[settings.CURRENT_PROJECT] = ""
         if state[settings.CURRENT_TASK]:
-            update(partial(task_handler.finish, project_name=project_name, task_name=state[settings.CURRENT_TASK])) 
+            data_handler.update(
+                partial(
+                    task_handler.finish,
+                    project_name=project_name,
+                    task_name=state[settings.CURRENT_TASK],
+                )
+            )
             state[settings.CURRENT_TASK] = ""
-        save_data(state, settings.state_filepath)
+        data_handler.save_data(state, settings.state_filepath)
         console.print(f"[bold blue]{project_name}[/bold blue] finished.")
     else:
         console.print("[bold red]No active project.")
 
+
 @project.command()
 def pause():
     """
-     - pauses the current project, so new tasks can't be started.
+    - pauses the current project, so new tasks can't be started.
     """
-    state = load_data(settings.state_filepath)
+    state = data_handler.load_data(settings.state_filepath)
     project_name = state.get(settings.CURRENT_PROJECT)
     if project_name:
-        update(partial(pause_project, project_name=project_name))
+        data_handler.update(partial(project_handler.pause, project_name=project_name))
         state[settings.CURRENT_PROJECT] = ""
         if state[settings.CURRENT_TASK]:
-            update(partial(task_handler.pause, project_name=project_name, task_name=state[settings.CURRENT_TASK])) 
+            data_handler.update(
+                partial(
+                    task_handler.pause,
+                    project_name=project_name,
+                    task_name=state[settings.CURRENT_TASK],
+                )
+            )
             state[settings.CURRENT_TASK] = ""
-        save_data(state, settings.state_filepath)
+        data_handler.save_data(state, settings.state_filepath)
         console.print(f"[bold blue]{project_name}[/bold blue] paused.")
     else:
         console.print("[bold red]No active project.")
 
+
 @project.command()
 @click.argument("project_name")
 def start(project_name):
     """
     - starts an existing project or creates a new project.
     """
-    data = load_data()
-    update(partial(create_project, project_name=project_name))
-    state = load_data(settings.state_filepath)
+    data = data_handler.load_data()
+    data_handler.update(partial(project_handler.create, project_name=project_name))
+    state = data_handler.load_data(settings.state_filepath)
     state[settings.CURRENT_PROJECT] = project_name
-    save_data(state, settings.state_filepath)
+    data_handler.save_data(state, settings.state_filepath)
     console.print(f"[bold blue]{project_name}[/bold blue] started.")
     if project_name not in data.keys():
-        console.print(f"\n[bold blue i on white]You also might want to run: `pytm config project {project_name}` to configure project meta data.[/bold blue i on white]")
+        console.print(
+            f"\n[bold blue i on white]You also might want to run: `pytm config project {project_name}` to configure project meta data.[/bold blue i on white]"
+        )
 
 
 @project.command()
@@ -109,42 +135,51 @@ def remove(project_name):
     """
     - deletes a project and related tasks.
     """
-    state = load_data(settings.state_filepath)
-    update(partial(remove_project, project_name=project_name))
+    state = data_handler.load_data(settings.state_filepath)
+    data_handler.update(partial(project_handler.remove, project_name=project_name))
     if state[settings.CURRENT_PROJECT] == project_name:
         state[settings.CURRENT_PROJECT] = ""
-        save_data(state, settings.state_filepath)
+        data_handler.save_data(state, settings.state_filepath)
     console.print(f"[bold blue]{project_name}[/bold blue] removed.")
 
+
 @project.command()
 @click.argument("project_name")
 def status(project_name):
     """
-    - of the project (running, paused, finished, etc). 
+    - of the project (running, paused, finished, etc).
     """
-    console.print(f"[bold blue]{project_name}[/bold blue] status: {project_status(load_data(), project_name)}")
+    console.print(
+        f"[bold blue]{project_name}[/bold blue] status: {project_handler.status(data_handler.load_data(), project_name)}"
+    )
+
 
 @project.command()
 @click.argument("project_name")
 def summary(project_name):
     """
     - shows total time of the project with task and duration.
     """
-    project = project_summary(load_data(), project_name)
-    project_data = project['tasks']
-    tree = Tree(f"[bold blue]{project_name}[/bold blue] ([i]{project["status"]}[/i])")
+    project = project_handler.summary(data_handler.load_data(), project_name)
+    project_data = project["tasks"]
+    tree = Tree(f'[bold blue]{project_name}[/bold blue] ([i]{project["status"]}[/i])')
     duration = 0
     for task, t in project_data.items():
-        task_duration = int(round(t['duration']))
+        task_duration = int(round(t["duration"]))
         duration += task_duration
-        tree.add(f"[green]{task}[/green]: {_get_duration_str(task_duration)} ([i]{t['status']}[/i])")
+        tree.add(
+            f"[green]{task}[/green]: {_get_duration_str(task_duration)} ([i]{t['status']}[/i])"
+        )
     console.print(Panel.fit(tree))
     console.print(f"[blue bold]Total time[/blue bold]: {_get_duration_str(duration)}")
 
+
 @project.command()
 @click.argument("project_name")
 def json(project_name):
     """
     - shows project data in json format.
     """
-    console.print_json(data=project_summary(load_data(), project_name))
+    console.print_json(
+        data=project_handler.summary(data_handler.load_data(), project_name)
+    )

PyTM/commands/project.py

@@ -1,8 +1,8 @@
 import click
 from functools import partial
-import PyTM.core.task_handler as task_handler
-import PyTM.core.data_handler as data_handler
-import PyTM.settings as settings
+from PyTM.core import task_handler
+from PyTM.core import data_handler
+from PyTM import settings
 from PyTM.console import console
 import json
 

PyTM/commands/task.py

@@ -1,21 +1,28 @@
-import PyTM.settings as settings 
-import PyTM.core.data_handler as data_handler
+from PyTM import settings
+from PyTM.core import data_handler
 from PyTM.commands.project import _get_duration_str
 import datetime
 
+
 def generate(invoice_number, invoice_texts, user, project, discount=0):
-    title, logo, foot_note = invoice_texts['title'], invoice_texts['logo'], invoice_texts['foot_note']
-    tasks = project['tasks']
+    title, logo, foot_note = (
+        invoice_texts["title"],
+        invoice_texts["logo"],
+        invoice_texts["foot_note"],
+    )
+    tasks = project["tasks"]
     duration = 0
     sub_total = 0
-    
+
     for task, t in tasks.items():
-        if t['status'] != settings.ABORTED:
-            task_duration = int(round(t['duration']))
+        if t["status"] != settings.ABORTED:
+            task_duration = int(round(t["duration"]))
             duration += task_duration
-            sub_total += float(t['duration']/360) * float(user['hourly_rate'])
-    if discount == "": discount = 0
-    else: discount = float(discount)
+            sub_total += float(t["duration"] / 360) * float(user["hourly_rate"])
+    if discount == "":
+        discount = 0
+    else:
+        discount = float(discount)
     total = sub_total - discount
     return f"""<!DOCTYPE html>
 <html lang="en">
@@ -68,13 +75,13 @@ def generate(invoice_number, invoice_texts, user, project, discount=0):
                     </thead>
                     <tbody>
 
-                        {"\n".join(f"""<tr>
+                        {"\n".join(f'''<tr>
                             <td class="p-2 border border-gray-300">{task.replace("_", " ").replace("-", " ").title()}</td>
                             <td class="p-2 border border-gray-300">{t.get('description', '-')}</td>
                             <td class="p-2 border border-gray-300">{float(t['duration']/360):,.02f}</td>
                             <td class="p-2 border border-gray-300">{float(user['hourly_rate']):,.02f}$</td>
                             <td class="p-2 border border-gray-300">{float(t['duration']/360) * float(user['hourly_rate']):,.02f}</td>
-                        </tr>""" for task, t in tasks.items())}
+                        </tr>''' for task, t in tasks.items())}
                         
                     </tbody>
                 </table>
@@ -106,4 +113,4 @@ def generate(invoice_number, invoice_texts, user, project, discount=0):
     </div>
 </body>
 </html>
-"""
+"""

PyTM/core/invoice_handler.py

@@ -1,8 +1,9 @@
 from datetime import datetime
-import PyTM.settings as settings
 
+from PyTM import settings
 
-def create_project(data, project_name):
+
+def create(data, project_name):
     """Create & Start the project"""
     if data.get(project_name):
         data[project_name]["status"] = settings.STARTED
@@ -15,38 +16,38 @@ def create_project(data, project_name):
     return data
 
 
-def pause_project(data, project_name):
+def pause(data, project_name):
     """Pause the project"""
     if data.get(project_name):
         data[project_name]["status"] = settings.PAUSED
     return data
 
 
-def finish_project(data, project_name):
+def finish(data, project_name):
     """Finish the project"""
     if data.get(project_name):
         data[project_name]["status"] = settings.FINISHED
     return data
 
 
-def project_summary(data, project_name):
+def summary(data, project_name):
     """Summarize the project"""
     return data.get(project_name, {})
 
 
-def project_status(data, project_name):
+def status(data, project_name):
     """Status of the project"""
     return data.get(project_name, {}).get("status", "")
 
 
-def abort_project(data, project_name):
+def abort(data, project_name):
     """Abort the project"""
     if data.get(project_name):
         data.get(project_name)["status"] = settings.ABORTED
     return data
 
 
-def remove_project(data, project_name):
+def remove(data, project_name):
     """Remove the project"""
     if data.get(project_name):
         del data[project_name]

PyTM/core/project_handler.py

@@ -1,5 +1,6 @@
 from datetime import datetime
-import PyTM.settings as settings
+
+from PyTM import settings
 
 
 def _calc_duration(date1, date2):

PyTM/core/task_handler.py

@@ -23,7 +23,7 @@
 
 setup(
     name="python-pytm",
-    version="0.0.13",
+    version="0.0.14",
     description="PyTM - an Open Source Python Time Management Tool for Mankind",
     long_description=readme + "\n\n" + doclink + "\n\n" + history,
     long_description_content_type="text/x-rst",