From 718627ad2eac0e3831770d28f9fc505d6d8ccd6f Mon Sep 17 00:00:00 2001 From: array-in-a-matrix Date: Mon, 12 Jun 2023 10:20:48 -0400 Subject: [PATCH 1/5] error if no config file found --- main.py | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/main.py b/main.py index 13417c0..9ea5080 100644 --- a/main.py +++ b/main.py @@ -48,14 +48,12 @@ async def main() -> None: global client config = {} - with open('texlily.yaml', 'r') as conf: - config = yaml.safe_load(conf) - if config == None: - print("No config file found. ") - print("") - print("Please create a file named texlily.yaml and read the") - print("README.") - return + try: + with open('texlily.yaml', 'r') as conf: + config = yaml.safe_load(conf) + except FileNotFoundError: + print("No config file found.\nPlease create a file named `texlily.yaml` and read the README file.") + quit() # Retrieve our configuration. homeserver = str(config["homeserver"]) user = str(config["user"]) From a3720ce3bfe92a7cc380d6491138b73ee4ac8819 Mon Sep 17 00:00:00 2001 From: array-in-a-matrix Date: Mon, 12 Jun 2023 10:33:48 -0400 Subject: [PATCH 2/5] fix no config file handling --- main.py | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/main.py b/main.py index 9ea5080..883cd9b 100644 --- a/main.py +++ b/main.py @@ -51,14 +51,19 @@ async def main() -> None: try: with open('texlily.yaml', 'r') as conf: config = yaml.safe_load(conf) + # if config file does not exist, quit except FileNotFoundError: print("No config file found.\nPlease create a file named `texlily.yaml` and read the README file.") quit() - # Retrieve our configuration. - homeserver = str(config["homeserver"]) - user = str(config["user"]) - token = str(config["token"]) - path = str(config["path"]) + try: + # Retrieve our configuration + homeserver = str(config["homeserver"]) + user = str(config["user"]) + token = str(config["token"]) + # path = str(config["path"]) # not used + except TypeError: + print("Invalid configuration file.") + quit() client = AsyncClient(homeserver) client.access_token = token From f8934853c682c690e63fd8d19182cbf2f38a9c24 Mon Sep 17 00:00:00 2001 From: array-in-a-matrix Date: Mon, 12 Jun 2023 10:34:45 -0400 Subject: [PATCH 3/5] git ignore config file --- .gitignore | 163 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 163 insertions(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b351f82 --- /dev/null +++ b/.gitignore @@ -0,0 +1,163 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + +# config file +texlily.yaml From 263002bc45f201fc5a1c38d75031a85ace152772 Mon Sep 17 00:00:00 2001 From: array-in-a-matrix Date: Mon, 12 Jun 2023 10:42:20 -0400 Subject: [PATCH 4/5] cleaned up try..except --- main.py | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/main.py b/main.py index 883cd9b..8c7ff5e 100644 --- a/main.py +++ b/main.py @@ -51,16 +51,15 @@ async def main() -> None: try: with open('texlily.yaml', 'r') as conf: config = yaml.safe_load(conf) - # if config file does not exist, quit - except FileNotFoundError: - print("No config file found.\nPlease create a file named `texlily.yaml` and read the README file.") - quit() - try: # Retrieve our configuration homeserver = str(config["homeserver"]) user = str(config["user"]) token = str(config["token"]) # path = str(config["path"]) # not used + # if config file does not exist, quit + except FileNotFoundError: + print("No config file found.\nPlease create a file named `texlily.yaml` and read the README file.") + quit() except TypeError: print("Invalid configuration file.") quit() From 066d97970b26e989b708205086e21c81b564ef17 Mon Sep 17 00:00:00 2001 From: array-in-a-matrix Date: Mon, 12 Jun 2023 11:05:10 -0400 Subject: [PATCH 5/5] md linting and simplifing wording --- README.MD | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.MD b/README.MD index e8f24ac..83d91be 100644 --- a/README.MD +++ b/README.MD @@ -1,25 +1,32 @@ # TeXLily: A LaTeX and Lilypond bot for [matrix] -TeXlily is a TeX and Lilypond bot designed for [matrix]. It is made for -clients who does not support LaTeX, but also for people willing to share + +TeXlily is a TeX and Lilypond bot designed for [matrix]. It is made for +clients who does not support LaTeX, but also for people willing to share sheet music to their friends using Lilypond. ## Dependencies + TeXily only has a few dependencies: - - Python 3(tested on 3.11). + - Python 3 (tested on 3.11) + `matrix-nio` + `pyaml` + `imagesize` - - A modern version of Lilypond - - A distribution of LaTeX. Only really tested on TeXlive though. - Your distribution should have the `latex` and `dvipng` programs. + - Lilypond + - A distribution of TeX for `latex` and `dvipng` programs. + +Python: `pip install -r requirements.txt` + +Arch Linux: `sudo pacman -S lilypond texlive` ## Contributing + You can contribute directly using PRs, or you can just mail me patches to: `lda@freetards.xyz` with a title starting with `PATCH FOR TEXLILY:` To contribute, use PEP8 with 4 spaces. ## License -TeXlily's is under the AGPLv3. Check COPYING.AGPL for more information on the + +TeXlily's is under the AGPLv3. Check COPYING.AGPL for more information on the license.