Merge branch 'dev'

Author: clstaudt

notebooks/walkthrough/00-introduction.ipynb

@@ -101,10 +101,26 @@
     "Furthermore, whenever Tuttle asks you to enter a password (e.g. for a cloud account), it will be processed securely and not stored."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "bce5e1c0-9609-423e-8f8f-6d55d1b17453",
+   "metadata": {},
+   "source": [
+    "## Feature Preview"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "6e3e8e94-d7f8-4235-b5ad-5a9ecd4f819d",
+   "metadata": {},
+   "source": [
+    "![](https://media.gettyimages.com/vectors/under-construction-sign-in-white-background-vector-id536013219?b=1&k=6&m=536013219&s=170x170&h=_-DZGgLDo-84eyZSJZmgwlekma7FYt3LdOdLIC7qktw=)"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "8d3ae2ea-86e9-4b9e-919f-56ccb1c0cf39",
+   "id": "f2809b5c-795e-4ef6-94df-08aa6981c62c",
    "metadata": {},
    "outputs": [],
    "source": []

notebooks/walkthrough/01-user-setup.ipynb

@@ -5,7 +5,33 @@
    "id": "0025a9fb-f7bf-4151-a059-058401a9341c",
    "metadata": {},
    "source": [
-    "# Setup"
+    "# User Setup"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "c2268ff6-e356-4ca7-af88-291acd08061e",
+   "metadata": {},
+   "source": [
+    "## Preamble"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "97e897a7-21ad-41ec-b695-e07fa5fc864e",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from pathlib import Path"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "d24e3bb0-1116-4e97-8265-c5d347334c5c",
+   "metadata": {},
+   "source": [
+    "## Setup"
    ]
   },
   {
@@ -375,20 +401,20 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 2,
    "id": "ce5aac90-3726-423c-bdfa-0a4b57a977cf",
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "tuttle.db\n"
+      "tuttle.db         tuttle.db-journal\n"
      ]
     }
    ],
    "source": [
-    "!ls /Users/cls/.tuttle/"
+    "!ls {Path.home()}/.tuttle/"
    ]
   },
   {

notebooks/walkthrough/02-projects-setup.ipynb

@@ -103,6 +103,14 @@
     "### Setup: Clients"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "adcd2838-2571-4857-bc4e-26bc53ff641b",
+   "metadata": {},
+   "source": [
+    "The `Client` is the person or business you are working for in the course of a project."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 4,
@@ -175,7 +183,7 @@
    "id": "886cba6c-d1e0-408b-a4e9-8fc9521788db",
    "metadata": {},
    "source": [
-    "When you agree with a client on the terms of a project, you record them in a contract signed by both parties. In `tuttle`, this is what the `Contract` object is for."
+    "When you agree with a client on the business terms of a project, you record them in a contract signed by both parties. In `tuttle`, this is what the `Contract` object is for."
    ]
   },
   {
@@ -387,6 +395,16 @@
     "## Setup: Projects"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "12401626-75f5-4525-9792-9901c1528ba8",
+   "metadata": {},
+   "source": [
+    "A `Project` is a large, logical unit of work. Tuttle's automatic invoice generation feature assumes that every invoice is related to one project. You may have several projects with the same client. And since the terms of business can change or get extended, you may have several contracts attached to a project. However, only one contract can be active at a time.\n",
+    "\n",
+    "Let's start with the simplest case: One client, one project, one contract."
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "06df9747-c306-4716-97e9-e7a76cdbed25",

requirements.txt

@@ -1,5 +1,4 @@
 pip
-bump2version
 wheel
 watchdog
 flake8
@@ -8,7 +7,7 @@ Sphinx
 #twine
 pytest
 pandas
-pandera[mypy]
+pandera
 altair
 sqlmodel
 pyicloud

requirements_dev.txt

@@ -1,12 +1,5 @@
-pip
-bump2version==0.5.11
-wheel==0.33.6
-watchdog==0.9.0
-flake8==3.7.8
-tox==3.14.0
-coverage==4.5.4
-Sphinx==1.8.5
-twine==1.14.0
-
-pytest==6.2.4
-black==21.7b0
+jupyterlab
+ipywidgets
+bump2version
+black
+nbdime

setup.py

@@ -13,14 +13,8 @@
 with open("requirements.txt") as requirements_file:
     requirements = requirements_file.readlines()
 
-
-dev_requirements = [
-    "jupyterlab",
-    "ipywidgets",
-]
-
-test_requirements = []
-
+with open("requirements_dev.txt") as dev_requirements_file:
+    dev_requirements = dev_requirements_file.readlines()
 
 setup(
     author="Christian Staudt",
@@ -36,15 +30,14 @@
         "Programming Language :: Python :: 3.9",
     ],
     description="Painless business planning for freelancers.",
-    install_requires=requirements + test_requirements,
+    install_requires=requirements + dev_requirements,
     license="GNU General Public License v3",
     long_description=readme + "\n\n" + history,
     include_package_data=True,
     keywords="tuttle",
     name="tuttle",
     packages=find_packages(include=["tuttle", "tuttle.*"]),
     test_suite="tests",
-    tests_require=test_requirements,
     url="https://github.com/tuttle-dev/tuttle",
     version="0.0.4",
     zip_safe=False,