From 5c31590145c298c624917f85a1a3ee232b591866 Mon Sep 17 00:00:00 2001 From: takunomi-build-bot Date: Fri, 14 Mar 2025 00:00:15 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=96=20Repository=20layout=20updated=20?= =?UTF-8?q?to=20latest=20version?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This commit was automatically generated by a script: https://gitfub.space/Jmaa/repo-manager --- .gitea/workflows/python-package.yml | 2 +- .gitea/workflows/python-ruff.yml | 2 +- .gitea/workflows/python-test.yml | 2 +- .gitea/workflows/python-version-check.yml | 2 +- CONVENTIONS.md | 8 ++++++++ LICENSE | 2 +- README.md | 10 ++++++++-- 7 files changed, 21 insertions(+), 7 deletions(-) create mode 100644 CONVENTIONS.md diff --git a/.gitea/workflows/python-package.yml b/.gitea/workflows/python-package.yml index 09275ea..bca3388 100644 --- a/.gitea/workflows/python-package.yml +++ b/.gitea/workflows/python-package.yml @@ -3,7 +3,7 @@ on: push: tags: - 'v[0-9]+.[0-9]+.[0-9]+' - paths-ignore: ["README.md", ".gitignore", "LICENSE", "ruff.toml"] + paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md'] jobs: Package: diff --git a/.gitea/workflows/python-ruff.yml b/.gitea/workflows/python-ruff.yml index b1be7a3..7d0737a 100644 --- a/.gitea/workflows/python-ruff.yml +++ b/.gitea/workflows/python-ruff.yml @@ -1,7 +1,7 @@ name: Python Ruff Code Quality on: push: - paths-ignore: ["README.md", ".gitignore", "LICENSE"] + paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md'] jobs: ruff: diff --git a/.gitea/workflows/python-test.yml b/.gitea/workflows/python-test.yml index fe892b7..020efd5 100644 --- a/.gitea/workflows/python-test.yml +++ b/.gitea/workflows/python-test.yml @@ -2,7 +2,7 @@ name: Run Python tests (through Pytest) on: push: - paths-ignore: ["README.md", ".gitignore", "LICENSE", "ruff.toml"] + paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md'] jobs: Test: diff --git a/.gitea/workflows/python-version-check.yml b/.gitea/workflows/python-version-check.yml index d92a710..7369090 100644 --- a/.gitea/workflows/python-version-check.yml +++ b/.gitea/workflows/python-version-check.yml @@ -2,7 +2,7 @@ name: Verify Python project can be installed, loaded and have version checked on: push: - paths-ignore: ["README.md", ".gitignore", "LICENSE", "ruff.toml"] + paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md'] jobs: Test: diff --git a/CONVENTIONS.md b/CONVENTIONS.md new file mode 100644 index 0000000..bf8acd8 --- /dev/null +++ b/CONVENTIONS.md @@ -0,0 +1,8 @@ +When writing code, you MUST follow these principles: + +- No trailing whitespace. +- Use types everywhere possible. +- Only use comments when necessary, as they can become outdated. Instead, strive to make the code self-explanatory. +- When comments are used, they should add useful information that is not readily apparent from the code itself. +- Dictionaries that do not change during the runtime of the program must be + placed in top-level scope. diff --git a/LICENSE b/LICENSE index 67061b0..991257a 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2024 Jon Michael Aanes +Copyright (c) 2024-2025 Jon Michael Aanes Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index ad7e208..8510571 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,9 @@ Defined hierarchy: ## Dependencies -All requirements can be installed easily using: +This project requires [Python](https://www.python.org/) 3.8 or newer. + +All required libraries can be installed easily using: ```bash pip install -r requirements.txt @@ -35,12 +37,16 @@ Full list of requirements: - [enforce-typing](https://pypi.org/project/enforce-typing/) +## Contributing + +Feel free to submit pull requests. Please follow the [Code Conventions](CONVENTIONS.md) when doing so. + ## License ``` MIT License -Copyright (c) 2024 Jon Michael Aanes +Copyright (c) 2024-2025 Jon Michael Aanes Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal