diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a82a97c --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Michael Haussmann + +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. \ No newline at end of file diff --git a/README.md b/README.md index bfd6730..9b347e3 100644 --- a/README.md +++ b/README.md @@ -111,6 +111,14 @@ The result is a fast and very simple toolset. If you need one of these, go for the original :) +## Installation + +**resolva** works in Python >=3.7. +It is available on pypi and can be installed using `pip install resolva`, +or from github `pip install git+https://github.com/MichaelHaussmann/resolva.git` + +**resolva** is open source, License: MIT. + ### TODO: - docstrings (+doctests) diff --git a/pyproject.toml b/pyproject.toml index daee6dd..ea01956 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -10,7 +10,7 @@ exclude = [".gitignore"] [project] name = "resolva" -version = "0.1.0" +version = "0.0.1" description = "Simple and fast path template resolver." readme = "README.md" authors = [{ name = "Michael Haussmann", email = "spil@xeo.info" }] @@ -35,11 +35,10 @@ requires-python = ">=3.7" [project.optional-dependencies] dev = ["pytest"] # "Faker" -qc = ["mypy", "black", "flake8", "isort", "refurb"] # Code Quality +# qc = ["mypy", "black", "flake8", "isort", "refurb"] # Code Quality [project.urls] "Homepage" = "https://github.com/MichaelHaussmann/resolva" -# "Documentation" = "https://resolva.readthedocs.io" [tool.isort] profile = "black" diff --git a/resolva/resolver.py b/resolva/resolver.py index 9d16627..5a07eac 100644 --- a/resolva/resolver.py +++ b/resolva/resolver.py @@ -1,3 +1,8 @@ +""" +This file is part of resolva. +(C) copyright 2024 Michael Haussmann, spil@xeo.info +resolva is free software and is distributed under the MIT License. See LICENSE file. +""" from __future__ import annotations from typing import Any import functools diff --git a/resolva/template.py b/resolva/template.py index 9ecf34a..40a30a9 100644 --- a/resolva/template.py +++ b/resolva/template.py @@ -1,4 +1,6 @@ """ +This file is part of resolva. + This code is taken and derived from Lucidity. https://gitlab.com/4degrees/lucidity/ @@ -6,7 +8,6 @@ copyright: Copyright (c) 2013 Martin Pengelly-Phillips licence: Apache License, Version 2.0, January 2004, http://www.apache.org/licenses - """ import functools from collections import defaultdict diff --git a/resolva/utils.py b/resolva/utils.py index f8d2ea9..708ce04 100644 --- a/resolva/utils.py +++ b/resolva/utils.py @@ -1,3 +1,8 @@ +""" +This file is part of resolva. +(C) copyright 2024 Michael Haussmann, spil@xeo.info +resolva is free software and is distributed under the MIT License. See LICENSE file. +""" import logging import sys