Merge branch 'dev'

Author: clstaudt

notebooks/demo/demo-invoicing.ipynb

@@ -0,0 +1,275 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "34b777b3-2f88-4b67-ab04-eb8dc126975e",
+   "metadata": {
+    "tags": []
+   },
+   "source": [
+    "# Invoicing"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "3335c617-d50d-4e33-a5dc-b56f388081d2",
+   "metadata": {},
+   "source": [
+    "Now that we have set up our user info, clients, contracts and projects, as well as a source for time tracking data, we are ready to automatically generate invoices."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "1d98382c-6c1f-446f-97de-f5b19b97f582",
+   "metadata": {},
+   "source": [
+    "## Preamble"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "aa4ef82b-a4b1-4c07-a2fe-087be2c45bc4",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from pathlib import Path\n",
+    "import datetime\n",
+    "from IPython import display"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "50ec9b6a-ce3d-477c-a4d9-9b1c5db3b4ee",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import tuttle"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "d515270c-5a23-49ef-b8cf-dd3c34bdbc00",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "app = tuttle.app.App(verbose=False)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "8918a540-ef25-417a-9eae-310d9a63f578",
+   "metadata": {
+    "tags": []
+   },
+   "source": [
+    "## Workflow"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "0857141e-106f-4197-ac03-b985f218c20a",
+   "metadata": {},
+   "source": [
+    "_1. Select a project_"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "55f0bf60-d0ec-4b5d-a475-4b541d8799cd",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "/Users/cls/miniforge3/envs/tuttle/lib/python3.9/site-packages/sqlmodel/orm/session.py:60: SAWarning: Class SelectOfScalar will not make use of SQL compilation caching as it does not set the 'inherit_cache' attribute to ``True``.  This can have significant performance implications including some performance degradations in comparison to prior SQLAlchemy versions.  Set this attribute to True if this object can make use of the cache key generated by the superclass.  Alternatively, this attribute may be set to False which will disable this warning. (Background on this error at: https://sqlalche.me/e/14/cprf)\n",
+      "  results = super().execute(\n"
+     ]
+    }
+   ],
+   "source": [
+    "my_project = app.get_project(title=\"Heating Repair\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "c0b2e5f5-7890-46ca-a52f-c6d00197563d",
+   "metadata": {},
+   "source": [
+    "2. Select a time tracking data source."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "b5194e28-e05f-41f0-9f37-066e5c4a4d12",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from tuttle.calendar import FileCalendar\n",
+    "\n",
+    "timetracking_calendar_path = Path(\"../../tests/data/TuttleDemo-TimeTracking.ics\")\n",
+    "my_calendar = FileCalendar(\n",
+    "    path=timetracking_calendar_path, \n",
+    "    name=\"TimeTracking\"\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "0142e10a-ebd8-4f7e-84d2-2b8a5f9cd6e4",
+   "metadata": {},
+   "source": [
+    "3. Generate one or more timesheets"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "ecb0e9e5-63a0-4b48-a99d-2d6e2c0905d1",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "/Users/cls/miniforge3/envs/tuttle/lib/python3.9/site-packages/sqlmodel/orm/session.py:101: SAWarning: Dialect sqlite+pysqlite does *not* support Decimal objects natively, and SQLAlchemy must convert from floating point - rounding errors and other issues may occur. Please consider storing Decimal numbers as strings or integers on this platform for lossless storage.\n",
+      "  return super().execute(  # type: ignore\n"
+     ]
+    }
+   ],
+   "source": [
+    "my_timesheet = tuttle.timetracking.generate_timesheet(\n",
+    "    source=my_calendar,\n",
+    "    project=my_project,\n",
+    "    period=\"February 2022\",\n",
+    "    item_description=my_project.title,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "d9a64c75-554b-4e84-92a4-48c6783a1a5d",
+   "metadata": {},
+   "source": [
+    "4. Generate an invoice for the timesheet(s)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "8a097cc3-5aec-448d-9725-d8f588a02cd4",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "my_invoice = tuttle.invoicing.generate_invoice(\n",
+    "    timesheets=[\n",
+    "        my_timesheet,\n",
+    "    ],\n",
+    "    contract=my_project.contract,\n",
+    "    date=datetime.date.today(),\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "8f6b4806-a372-48f2-8b9b-0ddae21ce1db",
+   "metadata": {},
+   "source": [
+    "5. Render the invoice to a document template:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "id": "3da4513d-6523-4268-ab41-647049591267",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "invoice_dir = Path.home() / \"Downloads\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "id": "2a918ca1-9c15-4c56-82e2-396c88116b2d",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "tuttle.rendering.render_invoice(\n",
+    "    user=app.user, \n",
+    "    invoice=my_invoice,\n",
+    "    style=\"anvil\",\n",
+    "    out_dir=invoice_dir,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "id": "15041ce5-c6b9-4597-86b7-0a5cc5d51fc6",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "invoice_path = str(invoice_dir / f\"Invoice-{my_invoice.number}\" / f\"Invoice-{my_invoice.number}.html\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "id": "8793081f-1f50-4943-8449-cebad19689af",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Testing Quick Look preview with files:\n",
+      "\t/Users/cls/Downloads/Invoice-2022-02-21-01/Invoice-2022-02-21-01.html\n",
+      "2022-02-21 21:55:53.852 qlmanage[11525:332330] *** CFMessagePort: bootstrap_register(): failed 1100 (0x44c) 'Permission denied', port = 0x14003, name = 'com.apple.coredrag'\n",
+      "See /usr/include/servers/bootstrap_defs.h for the error codes.\n",
+      "2022-02-21 21:55:53.883 qlmanage[11525:332330] *** CFMessagePort: bootstrap_register(): failed 1100 (0x44c) 'Permission denied', port = 0xca03, name = 'com.apple.tsm.portname'\n",
+      "See /usr/include/servers/bootstrap_defs.h for the error codes.\n",
+      "2022-02-21 21:55:59.974 qlmanage[11525:332343] Persistent UI failed to open file file:///Users/cls/Library/Saved%20Application%20State/com.apple.quicklook.qlmanage.savedState/window_1.data: No such file or directory (2)\n"
+     ]
+    }
+   ],
+   "source": [
+    "!qlmanage -p {invoice_path}"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "40c8f4b4-2ddb-4d66-b6fa-eccd9ef7d70c",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "tuttle",
+   "language": "python",
+   "name": "ex"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.7"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}