Skip to content

Commit

Permalink
Add MIT License, prepare for build, version 0.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelHaussmann committed Feb 11, 2024
1 parent 8c43136 commit fb01201
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 4 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
5 changes: 2 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 = "[email protected]" }]
Expand All @@ -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"
Expand Down
5 changes: 5 additions & 0 deletions resolva/resolver.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
"""
This file is part of resolva.
(C) copyright 2024 Michael Haussmann, [email protected]
resolva is free software and is distributed under the MIT License. See LICENSE file.
"""
from __future__ import annotations
from typing import Any
import functools
Expand Down
3 changes: 2 additions & 1 deletion resolva/template.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
"""
This file is part of resolva.
This code is taken and derived from Lucidity.
https://gitlab.com/4degrees/lucidity/
https://lucidity.readthedocs.io
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
Expand Down
5 changes: 5 additions & 0 deletions resolva/utils.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
"""
This file is part of resolva.
(C) copyright 2024 Michael Haussmann, [email protected]
resolva is free software and is distributed under the MIT License. See LICENSE file.
"""
import logging
import sys

Expand Down

0 comments on commit fb01201

Please sign in to comment.