Merge pull request #9 from DeepLcom/adjust-readme

Improved readme and separated contribution guidelines

CONTRIBUTION.md

@@ -0,0 +1,82 @@
+# Contributing Code
+
+If you're interested in contributing code, follow these steps:
+
+1. **Fork the Repository**: Fork the project's repository to your GitHub account.
+
+2. **Create a Branch**: Create a new branch for your contribution, preferably with a name that describes the feature or fix you're working on.
+
+3. **Code and Test**: Write your code, and make sure to test it thoroughly to ensure it functions as expected.
+
+4. **Documentation**: If your contribution involves code changes, update the relevant documentation to reflect those changes.
+
+5. **Submit a Pull Request**: Submit a pull request to the project's repository. Be sure to provide a clear and concise description of your changes. Include a reference to any related issues.
+
+6. **Code Review**: Your pull request will undergo code review by maintainers and contributors. Be prepared to address any feedback and make necessary changes.
+
+7. **Merge**: Once your contribution is approved and passes all checks, it will be merged into the project.
+
+## Coding Standards
+
+When contributing code, adhere to the following coding standards:
+
+- Follow the project's coding style, including code formatting and naming conventions.
+- Ensure your code is well-documented and includes comments where necessary.
+- Write clear commit messages that describe the purpose of each commit.
+
+## Local Setup
+
+To set up your local development environment for this project, follow these steps:
+
+### 1. Clone the Repository
+
+```bash
+git clone https://github.com/your-project/repository.git
+cd repository
+```
+
+### 2. Install Dependencies
+
+We use [Poetry](https://python-poetry.org/) for dependency management. If you don't have Poetry installed, you can get it from [here](https://python-poetry.org/docs/#installation).
+
+Once you have Poetry, you can install the project's dependencies:
+
+```bash
+poetry install
+```
+
+### 3. Pre-Commit Hooks
+
+This project uses pre-commit hooks to ensure code quality. To install the hooks, run:
+
+```bash
+poetry run pre-commit install
+```
+
+This will set up the necessary hooks to check code formatting, linting, and other code quality checks before each commit.
+
+### 4. Running Tests
+
+We use [pytest](https://docs.pytest.org/en/latest/) for running tests. You can run all the tests with:
+
+```bash
+poetry run pytest tests/
+```
+
+### 5. Environment Variables
+
+If you're working with database-specific sections (e.g., BigQuery or ClickHouse), make sure to set the required environment variables for your chosen database. Refer to the respective "Usage" sections for details on these variables.
+
+### 6. Development Workflow
+
+Before you start contributing, create a new branch for your work:
+
+```bash
+git checkout -b your-feature-branch
+```
+
+Make your code changes, commit them, and create a pull request to the project's repository following the [Contributing Guidelines](#Contributing).
+
+### 7. Code Formatting and Linting
+
+As part of the pre-commit hooks, code formatting and linting will be automatically checked before each commit. Be sure to address any issues reported by the hooks.

README.md

@@ -1,5 +1,7 @@
 # SQL Mock: Python Library for Mocking SQL Queries with Dictionary Inputs
 
+[![PyPI version](https://img.shields.io/pypi/v/sql-mock.svg)](https://pypi.org/project/sql-mock/)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/sql-mock.svg)](https://pypi.org/project/sql-mock/)
 [![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.
@@ -19,10 +21,10 @@ pip install --upgrade sql-mock
 To install database specific versions, you can use the following:
 ```shell
 # BigQuery
-pip install --upgrade sql-mock[bigquery]
+pip install --upgrade "sql-mock[bigquery]"
 
 # Clickhouse
-pip install --upgrade sql-mock[clickhouse]
+pip install --upgrade "sql-mock[clickhouse]"
 ```
 
 If you need to modify this source code, install the dependencies using poetry:
@@ -144,83 +146,4 @@ If you have ideas for new features or improvements, please use the project's iss
 
 ### Contributing Code
 
-If you're interested in contributing code, follow these steps:
-
-1. **Fork the Repository**: Fork the project's repository to your GitHub account.
-
-2. **Create a Branch**: Create a new branch for your contribution, preferably with a name that describes the feature or fix you're working on.
-
-3. **Code and Test**: Write your code, and make sure to test it thoroughly to ensure it functions as expected.
-
-4. **Documentation**: If your contribution involves code changes, update the relevant documentation to reflect those changes.
-
-5. **Submit a Pull Request**: Submit a pull request to the project's repository. Be sure to provide a clear and concise description of your changes. Include a reference to any related issues.
-
-6. **Code Review**: Your pull request will undergo code review by maintainers and contributors. Be prepared to address any feedback and make necessary changes.
-
-7. **Merge**: Once your contribution is approved and passes all checks, it will be merged into the project.
-
-### Coding Standards
-
-When contributing code, adhere to the following coding standards:
-
-- Follow the project's coding style, including code formatting and naming conventions.
-- Ensure your code is well-documented and includes comments where necessary.
-- Write clear commit messages that describe the purpose of each commit.
-
-## Local Setup
-
-To set up your local development environment for this project, follow these steps:
-
-### 1. Clone the Repository
-
-```bash
-git clone https://github.com/your-project/repository.git
-cd repository
-```
-
-### 2. Install Dependencies
-
-We use [Poetry](https://python-poetry.org/) for dependency management. If you don't have Poetry installed, you can get it from [here](https://python-poetry.org/docs/#installation).
-
-Once you have Poetry, you can install the project's dependencies:
-
-```bash
-poetry install
-```
-
-### 3. Pre-Commit Hooks
-
-This project uses pre-commit hooks to ensure code quality. To install the hooks, run:
-
-```bash
-poetry run pre-commit install
-```
-
-This will set up the necessary hooks to check code formatting, linting, and other code quality checks before each commit.
-
-### 4. Running Tests
-
-We use [pytest](https://docs.pytest.org/en/latest/) for running tests. You can run all the tests with:
-
-```bash
-poetry run pytest tests/
-```
-
-### 5. Environment Variables
-
-If you're working with database-specific sections (e.g., BigQuery or ClickHouse), make sure to set the required environment variables for your chosen database. Refer to the respective "Usage" sections for details on these variables.
-
-### 6. Development Workflow
-
-Before you start contributing, create a new branch for your work:
-
-```bash
-git checkout -b your-feature-branch
-```
-
-Make your code changes, commit them, and create a pull request to the project's repository following the [Contributing Guidelines](#Contributing).
-
-### 7. Code Formatting and Linting
-
-As part of the pre-commit hooks, code formatting and linting will be automatically checked before each commit. Be sure to address any issues reported by the hooks.
+Find more about contributing code in the [Contribution Guidelines](./CONTRIBUTION.md)