pre-commit hooks with black formatter

clstaudt · clstaudt · commit 0239bbb0789f · 2022-01-04T20:15:26.000Z
diff --git a/.gitignore b/.gitignore
@@ -130,4 +130,4 @@ dmypy.json
 
 
 # macOS
-.DS_Store
+.DS_Store
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,11 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/psf/black
+    rev: 19.3b0
+    hooks:
+    -   id: black
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,4 +1,4 @@
 {
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true
-}
+}
diff --git a/README.md b/README.md
@@ -1,18 +1,18 @@
 # tuttle - painless business planning for freelancers
 
 > HARRY TUTTLE: Bloody paperwork. Huh!
-> 
+>
 > SAM LOWRY: I suppose one has to expect a certain amount.
 >
-> HARRY TUTTLE: Why? I came into this game for the action, the excitement. Go anywhere, travel light, get in, get out, wherever there's trouble, a man alone. 
+> HARRY TUTTLE: Why? I came into this game for the action, the excitement. Go anywhere, travel light, get in, get out, wherever there's trouble, a man alone.
 
 
-**Tuttle is an open-source software project supported by the [Prototype Fund](https://prototypefund.de/en/about-2/). We develop a finance and business planning tool tailored for the requirements of freelancers.** 
+**Tuttle is an open-source software project supported by the [Prototype Fund](https://prototypefund.de/en/about-2/). We develop a finance and business planning tool tailored for the requirements of freelancers.**
 
 
 ## Which challenges does the project address?
 
-The working world is changing, the trend is towards freelancing: software developers, designers and journalists appreciate the freedom and creative possibilities of solo self-employment. More and more professionals are choosing it for themselves. It allows them to specialize and gain experience with many projects and clients. 
+The working world is changing, the trend is towards freelancing: software developers, designers and journalists appreciate the freedom and creative possibilities of solo self-employment. More and more professionals are choosing it for themselves. It allows them to specialize and gain experience with many projects and clients.
 
 With freelancing, there are many side activities: Marketing, client communication, legal and financial planning - although the latter probably appeals to few solo self-employed people. But neglected financial planning carries the risk of insolvency, debt, precarious self-employment, or poverty in old age. This also creates burdens for the social systems.
 
@@ -23,10 +23,9 @@ But what if software could make financial planning in freelancing almost as easy
 With Tuttle, we are developing a financial planning tool that is tailored to the needs of solo freelancers. We automate and give freelancers more time to do the work they love.
 The application provides analysis and forecasting functions on income, expenses, disposable income, uncertainty management or explainability of the forecast and convinces with portability, among other things.
 
-We develop the solution as a GUI application based on web technologies. Sensitive financial data is processed locally on the end device without central data collection. For data analysis, we rely on open source tools from the Python ecosystem. 
+We develop the solution as a GUI application based on web technologies. Sensitive financial data is processed locally on the end device without central data collection. For data analysis, we rely on open source tools from the Python ecosystem.
 
 
 ## Acknowledgements
 
 This project is funded by the [Prototype Fund](https://prototypefund.de).
-
diff --git a/_config.yml b/_config.yml
@@ -1 +1 @@
-theme: jekyll-theme-minimal
+theme: jekyll-theme-minimal
diff --git a/docs/conf.py b/docs/conf.py
@@ -19,7 +19,8 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
+
+sys.path.insert(0, os.path.abspath(".."))
 
 import tuttle
 
@@ -31,22 +32,22 @@
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'tuttle'
+project = "tuttle"
 copyright = "2021, Christian Staudt"
 author = "Christian Staudt"
 
@@ -69,10 +70,10 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -83,7 +84,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = "alabaster"
 
 # Theme options are theme-specific and customize the look and feel of a
 # theme further.  For a list of options available for each theme, see the
@@ -94,13 +95,13 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 
 # -- Options for HTMLHelp output ---------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'tuttledoc'
+htmlhelp_basename = "tuttledoc"
 
 
 # -- Options for LaTeX output ------------------------------------------
@@ -109,15 +110,12 @@
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -127,21 +125,15 @@
 # (source start file, target name, title, author, documentclass
 # [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'tuttle.tex',
-     'tuttle Documentation',
-     'Christian Staudt', 'manual'),
+    (master_doc, "tuttle.tex", "tuttle Documentation", "Christian Staudt", "manual")
 ]
 
 
 # -- Options for manual page output ------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'tuttle',
-     'tuttle Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "tuttle", "tuttle Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------
@@ -150,13 +142,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'tuttle',
-     'tuttle Documentation',
-     author,
-     'tuttle',
-     'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "tuttle",
+        "tuttle Documentation",
+        author,
+        "tuttle",
+        "One line description of project.",
+        "Miscellaneous",
+    )
 ]
-
-
-
diff --git a/docs/index.md b/docs/index.md
@@ -3,24 +3,24 @@
 **painless business planning for freelancers**
 
 > HARRY TUTTLE:
-> 
+>
 > Bloody paperwork. Huh!
-> 
+>
 > SAM LOWRY:
-> 
+>
 > I suppose one has to expect a certain amount.
 >
 > HARRY TUTTLE:
-> 
-> Why? I came into this game for the action, the excitement. Go anywhere, travel light, get in, get out, wherever there's trouble, a man alone. 
+>
+> Why? I came into this game for the action, the excitement. Go anywhere, travel light, get in, get out, wherever there's trouble, a man alone.
 
 
-**Tuttle is an open-source software project supported by the [Prototype Fund](https://prototypefund.de/en/about-2/). We develop a finance and business planning tool tailored for the requirements of freelancers.** 
+**Tuttle is an open-source software project supported by the [Prototype Fund](https://prototypefund.de/en/about-2/). We develop a finance and business planning tool tailored for the requirements of freelancers.**
 
 
 ## Which challenges does the project address?
 
-The working world is changing, the trend is towards freelancing: software developers, designers and journalists appreciate the freedom and creative possibilities of solo self-employment. More and more professionals are choosing it for themselves. It allows them to specialize and gain experience with many projects and clients. 
+The working world is changing, the trend is towards freelancing: software developers, designers and journalists appreciate the freedom and creative possibilities of solo self-employment. More and more professionals are choosing it for themselves. It allows them to specialize and gain experience with many projects and clients.
 
 With freelancing, there are many side activities: Marketing, client communication, legal and financial planning - although the latter probably appeals to few solo self-employed people. But neglected financial planning carries the risk of insolvency, debt, precarious self-employment, or poverty in old age. This also creates burdens for the social systems.
 
@@ -31,6 +31,4 @@ But what if software could make financial planning in freelancing almost as easy
 With Tuttle, we are developing a financial planning tool that is tailored to the needs of solo freelancers. We automate and give freelancers more time to do the work they love.
 The application provides analysis and forecasting functions on income, expenses, disposable income, uncertainty management or explainability of the forecast and convinces with portability, among other things.
 
-We develop the solution as a GUI application based on web technologies. Sensitive financial data is processed locally on the end device without central data collection. For data analysis, we rely on open source tools from the Python ecosystem. 
-
-
+We develop the solution as a GUI application based on web technologies. Sensitive financial data is processed locally on the end device without central data collection. For data analysis, we rely on open source tools from the Python ecosystem.
diff --git a/scripts/test.py b/scripts/test.py
@@ -1 +1 @@
-from tuttle import model
+from tuttle import model
diff --git a/setup.py b/setup.py
@@ -4,41 +4,41 @@
 
 from setuptools import setup, find_packages
 
-with open('README.md') as readme_file:
+with open("README.md") as readme_file:
     readme = readme_file.read()
 
-with open('HISTORY.rst') as history_file:
+with open("HISTORY.rst") as history_file:
     history = history_file.read()
 
-requirements = [ ]
+requirements = []
 
-test_requirements = ['pytest>=3', ]
+test_requirements = ["pytest>=3"]
 
 setup(
     author="Christian Staudt",
-    author_email='mail@clstaudt.me',
-    python_requires='>=3.6',
+    author_email="mail@clstaudt.me",
+    python_requires=">=3.6",
     classifiers=[
-        'Development Status :: 2 - Pre-Alpha',
-        'Intended Audience :: Developers',
-        'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
-        'Natural Language :: English',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.6',
-        'Programming Language :: Python :: 3.7',
-        'Programming Language :: Python :: 3.8',
+        "Development Status :: 2 - Pre-Alpha",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+        "Natural Language :: English",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
     ],
     description="Less paperwork, more excitement.",
     install_requires=requirements,
     license="GNU General Public License v3",
-    long_description=readme + '\n\n' + history,
+    long_description=readme + "\n\n" + history,
     include_package_data=True,
-    keywords='tuttle',
-    name='tuttle',
-    packages=find_packages(include=['tuttle', 'tuttle.*']),
-    test_suite='tests',
+    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.1.0',
+    url="https://github.com/tuttle-dev/tuttle",
+    version="0.1.0",
     zip_safe=False,
 )
diff --git a/tests/test_calendar.py b/tests/test_calendar.py
@@ -4,7 +4,8 @@
 
 from tuttle.calendar import FileCalendar
 
+
 def test_file_calendar():
     """Test that the calendar object can be instantiated."""
     test_calendar_path = Path("tests/data/test_calendar.ics")
-    cal = FileCalendar(path=test_calendar_path, name="Test Calendar")
+    cal = FileCalendar(path=test_calendar_path, name="Test Calendar")
diff --git a/tox.ini b/tox.ini
@@ -23,4 +23,3 @@ deps =
 commands =
     pip install -U pip
     pytest --basetemp={envtmpdir}
-
diff --git a/tuttle/app.py b/tuttle/app.py
@@ -6,45 +6,24 @@
 
 import model
 
-from model import (
-    Timesheet, 
-    Project, 
-    Invoice
-)
+from model import Timesheet, Project, Invoice
 
 
 class App:
     """The main application class"""
 
-    def __init__(
-        self,
-    ):
+    def __init__(self,):
         self.home = Path.home() / ".tuttle"
         if not os.path.exists(self.home):
             os.mkdir(self.home)
         self.db_path = self.home / "tuttle.db"
         self.db_engine = sqlmodel.create_engine(f"sqlite:///{self.db_path}", echo=True)
         sqlmodel.SQLModel.metadata.create_all(self.db_engine)
 
-
-    def generate_timesheet(
-        self,
-        project: Project,
-        time_period
-    ) -> Timesheet:
+    def generate_timesheet(self, project: Project, time_period) -> Timesheet:
         """."""
         raise NotImplementedError("TODO")
 
-    def generate_invoice(
-        timesheet: Timesheet
-    ) -> Invoice:
+    def generate_invoice(timesheet: Timesheet) -> Invoice:
         """."""
         raise NotImplementedError("TODO")
-
-
-
-
-
-
-
-
diff --git a/tuttle/banking.py b/tuttle/banking.py
@@ -9,10 +9,7 @@
 
 
 class Banking:
-    def __init__(
-        self,
-        account: BankAccount,
-    ):
+    def __init__(self, account: BankAccount):
         self.account = account
         self.product_id = None  # TODO: register product ID before deployment
 
diff --git a/tuttle/calendar.py b/tuttle/calendar.py
diff --git a/tuttle/model.py b/tuttle/model.py
diff --git a/tuttle/timetracking.py b/tuttle/timetracking.py

Original file line number	Diff line number	Diff line change
`@@ -130,4 +130,4 @@ dmypy.json`
`130`	`130`
`131`	`131`
`132`	`132`	`# macOS`
`133`		`-.DS_Store`
	`133`	`+.DS_Store`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`	`2`	`"python.testing.unittestEnabled": false,`
`3`	`3`	`"python.testing.pytestEnabled": true`
`4`		`-}`
	`4`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-theme: jekyll-theme-minimal`
	`1`	`+theme: jekyll-theme-minimal`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-from tuttle import model`
	`1`	`+from tuttle import model`