From 464f8ad2da15290b5e52e0ce0c8e1880b0857e71 Mon Sep 17 00:00:00 2001 From: Kumi Date: Tue, 19 Jul 2022 11:39:39 +0200 Subject: [PATCH] Restructuring for packaging --- .gitignore | 2 ++ LICENSE | 19 ++++++++++++++++ README.md | 3 +++ __init__.py | 0 pyproject.toml | 22 +++++++++++++++++++ src/reportmonster_client/__init__.py | 1 + .../reportmonster_client/client.py | 0 test.py => src/reportmonster_client/test.py | 2 +- 8 files changed, 48 insertions(+), 1 deletion(-) create mode 100644 LICENSE create mode 100644 README.md delete mode 100644 __init__.py create mode 100644 pyproject.toml create mode 100644 src/reportmonster_client/__init__.py rename client.py => src/reportmonster_client/client.py (100%) rename test.py => src/reportmonster_client/test.py (60%) diff --git a/.gitignore b/.gitignore index 531ddf6..83670f7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,4 @@ *.pyc pycache/ +venv/ +dist/ \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..82e7b10 --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2022 Kumi Systems e.U. + +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 new file mode 100644 index 0000000..603ab9c --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# ReportMonster Client + +This package contains a simple client class for connections to the ReportMonster server. \ No newline at end of file diff --git a/__init__.py b/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..0435dc9 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,22 @@ +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[project] +name = "reportmonster_client" +version = "0.0.1" +authors = [ + { name="Kumi Systems e.U.", email="office@kumi.systems" }, +] +description = "A simple client for the ReportMonster server" +readme = "README.md" +license = { file="LICENSE" } +requires-python = ">=3.8" +classifiers = [ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: MIT License", + "Operating System :: OS Independent", +] + +[project.urls] +"Homepage" = "https://kumig.it/kumisystems/reportmonster-client" \ No newline at end of file diff --git a/src/reportmonster_client/__init__.py b/src/reportmonster_client/__init__.py new file mode 100644 index 0000000..4c28d3d --- /dev/null +++ b/src/reportmonster_client/__init__.py @@ -0,0 +1 @@ +from reportmonster_client.client import ReportMonsterClient, ReportMonsterResponse \ No newline at end of file diff --git a/client.py b/src/reportmonster_client/client.py similarity index 100% rename from client.py rename to src/reportmonster_client/client.py diff --git a/test.py b/src/reportmonster_client/test.py similarity index 60% rename from test.py rename to src/reportmonster_client/test.py index fdd6015..2943594 100644 --- a/test.py +++ b/src/reportmonster_client/test.py @@ -1,4 +1,4 @@ -from client import ReportMonsterClient +from reportmonster_client import ReportMonsterClient import asyncio