Preparation for open sourcing: Added License, Changelog and reverted version to 0.1.0

Author: Thomas Schmidt

CHANGELOG.md

@@ -0,0 +1,17 @@
+Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
+
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [0.1.0] - 2023-10-26
+Initial version.
+
+
+[0.1.0]: https://github.com/DeepLcom/sql-mock/releases/tag/v0.1.0

LICENCE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright 2023 DeepL SE (https://www.deepl.com)
+
+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.

README.md

@@ -1,11 +1,37 @@
 # SQL Mock: Python Library for Mocking SQL Queries with Dictionary Inputs
 
+[![License: MIT](https://img.shields.io/badge/license-MIT-blueviolet.svg)](https://github.com/DeepLcom/sql-mock/blob/main/LICENSE)
+
 The primary purpose of this library is to simplify the testing of SQL data models and queries by allowing users to mock input data and create tests for various scenarios. It provides a consistent and convenient way to test the execution of your query without the need to process a massive amount of data.
 
 The library currently supports the following databases. Database specific documentations are provided in the links:
 * [BigQuery](src/sql_mock/bigquery/README.md)
 * [Clickhouse](src/sql_mock/clickhouse/README.md)
 
+## Installation
+
+The library can be installed from [PyPI][pypi-project] using pip:
+
+```shell
+pip install --upgrade sql-mock
+```
+
+To install database specific versions, you can use the following:
+```shell
+# BigQuery
+pip install --upgrade sql-mock[bigquery]
+
+# Clickhouse
+pip install --upgrade sql-mock[clickhouse]
+```
+
+If you need to modify this source code, install the dependencies using poetry:
+
+```shell
+poetry install --all-extras
+```
+
+
 ## Usage
 
 ### How it works

pyproject.toml

@@ -1,10 +1,12 @@
 
 [tool.poetry]
 name = "sql_mock"
-version = "0.2.0"
+version = "0.1.0"
 description = "Simplify the testing of SQL data models and queries by allowing users to mock input data and create tests for various scenarios. It provides a consistent and convenient way to test the execution of your query without the need to process a massive amount of data."
+repository = "https://github.com/DeepLcom/sql-mock"
 readme = "README.md"
-authors = ["Thomas Schmidt <[email protected]>"]
+authors = ["DeepL SE", "Thomas Schmidt <[email protected]>"]
+license = "MIT"
 
 classifiers = [
     "Development Status :: 4 - Beta",
@@ -30,6 +32,9 @@ packages = [
     { include = "sql_mock", from = "src" },
 ]
 
+[tool.poetry.urls]
+"Bug Tracker" = "https://github.com/DeepLcom/sql-mock/issues"
+
 [tool.poetry.dependencies]
 python = "^3.9"
 jinja2 = "^3.1.2"