From 15d239cf2a433ac60bf343869cd4ddc67fcda2b5 Mon Sep 17 00:00:00 2001 From: missytake Date: Wed, 13 Mar 2024 16:29:29 +0100 Subject: [PATCH] initial commit: basic project structure --- LICENSE | 13 +++++++++++++ README.md | 21 +++++++++++++++++++++ pyproject.toml | 6 ++++++ setup.cfg | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 86 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 pyproject.toml create mode 100644 setup.cfg diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9815883 --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ +Copyright (c) 2024 missytake + +Permission to use, copy, modify, and distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..cee1ef4 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# ADHD Reminder Bot + +This Delta Chat bot looks if https://www.terminland.de/noris-psychotherapie/ +offers new appointments, and sends a reminder to a specified delta contact if the current error message changes. + +## Setup + +``` +git clone https://git.0x90.space/missytake/adhd-reminder +cd adhd-reminder +python3 -m venv venv +. venv/bin/activate +pip install . +``` + +## Usage + +``` +adhd-reminder --email noreply@example.org --password p4$$w0rd /tmp/noreplydb +``` + diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..374b58c --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,6 @@ +[build-system] +requires = [ + "setuptools>=42", + "wheel" +] +build-backend = "setuptools.build_meta" diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..2cd8843 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,46 @@ +[metadata] +name = adhd-reminder +version = 0.0.1 +author = missytake +author_email = missytake@systemli.org +description = Reminder which polls new ADHD appointments regularly +long_description = file: README.md +long_description_content_type = text/markdown +url = https://github.com/missytake/adhd-reminder +project_urls = + Bug Tracker = https://git.0x90.space/missytake/adhd-reminder/issues +classifiers = + Programming Language :: Python :: 3 + License :: OSI Approved :: ISC License (ISCL) + Operating System :: OS Independent + +[options] +package_dir = + = src +packages = find: +include_package_data = True +python_requires = >=3.8 +install_requires = + deltachat + ConfigArgParse + +[options.packages.find] +where = src + +[options.entry_points] +console_scripts = + adhd-reminder = adhd_reminder.__main__:main + +[tox:tox] +envlist = lint, py310 +isolated_build = True + +[testenv:lint] +skip_install = True +deps = + black +commands = + black --check --diff --line-length 120 src + +[flake8] +max_line_length = 88