From 95ece52457065eac0c3c4e6f6651fb9c1127b2b4 Mon Sep 17 00:00:00 2001 From: Mabe Date: Tue, 25 Aug 2026 20:39:58 +0200 Subject: [PATCH] Add LICENSE, README, and requirements files; update db.py for logging --- LICENSE | 18 ++++++++++++++++++ README.md | 39 +++++++++++++++++++++++++++++++++++++++ db.py | 1 - requirements.txt | 1 + 4 files changed, 58 insertions(+), 1 deletion(-) create mode 100644 requirements.txt diff --git a/LICENSE b/LICENSE index e69de29..b13d60d 100644 --- a/LICENSE +++ b/LICENSE @@ -0,0 +1,18 @@ +MIT License + +Copyright (c) 2026 AdmMabe + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and +associated documentation files (the "Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the +following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial +portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT +LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO +EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE +USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index e69de29..9e1a20e 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,39 @@ +# Luggage + +Python utility for tracking your luggage-related data in a database. + +## Requirements + +- Python 3.10 or newer + +## Installation + +Clone the repository and install the project dependencies: + +```bash +git clone https://git.mabeservices.de/AdmMabe/py_luggage.git +cd luggage +``` + +Install dependencies if a dependency file is present: + +```bash +pip install -r requirements.txt +``` + +## Usage + +Run the application from the project directory: + +```bash +python main.py +``` + +## Development + +Keep changes focused and run the application locally before submitting a +change. Add tests alongside new functionality when applicable. + +## License + +See the license file included in the repository. diff --git a/db.py b/db.py index a0a9783..fab2211 100644 --- a/db.py +++ b/db.py @@ -1,5 +1,4 @@ import mariadb -import os import logging diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..d4af85e --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +mariadb == 1.1.14