# semantic_diffs [](https://pypi.org/project/semantic-diffs/) [](https://pypi.org/project/semantic-diffs/)
[](https://github.com/bswck/semantic_diffs/actions/workflows/test.yml)
[](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/semantic_diffs)
[](https://python-poetry.org/)
[](https://github.com/astral-sh/ruff)
[](https://github.com/psf/black)
[](https://github.com/bswck/semantic_diffs/blob/HEAD/LICENSE)
[](https://github.com/pre-commit/pre-commit)
Reuse codebase changes to automate refactoring.
# Installation
If you want to…
## …use this tool in your project 💻
You might simply install it with pip:
```shell
pip install semantic-diffs
```
If you use [Poetry](https://python-poetry.org/), then run:
```shell
poetry add semantic-diffs
```
## …contribute to [semantic_diffs](https://github.com/bswck/semantic_diffs) 🚀
> [!Note]
> If you use Windows, it is highly recommended to complete the installation in the way presented below through [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).
1. Fork the [semantic_diffs repository](https://github.com/bswck/semantic_diffs) on GitHub.
1. [Install Poetry](https://python-poetry.org/docs/#installation).<br/>
Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.
You might use [pipx](https://github.com/pypa/pipx#readme) to install it globally (recommended):
```shell
pipx install poetry
```
<sub>If you encounter any problems, refer to [the official documentation](https://python-poetry.org/docs/#installation) for the most up-to-date installation instructions.</sub>
If you want to use pipx to install dev dependencies as well, install the [`poetry pipx`](https://github.com/bswck/poetry-pipx#readme) plugin:
```shell
pipx inject poetry poetry-pipx
```
Be sure to have Python 3.8 installed—if you use [pyenv](https://github.com/pyenv/pyenv#readme), simply run:
```shell
pyenv install 3.8
```
1. Clone your fork locally and install dependencies.
```shell
git clone https://github.com/your-username/semantic_diffs path/to/semantic_diffs
cd path/to/semantic_diffs
poetry env use $(cat .python-version)
```
If you use pipx, run the following command to install dev dependencies globally:
```shell
poetry install --without=dev
poetry pipx install dev
```
Otherwise, run:
```shell
poetry install
```
Next up, simply activate the virtual environment and install pre-commit hooks:
```shell
poetry shell
pre-commit install --hook-type pre-commit --hook-type pre-push
```
For more information on how to contribute, check out [CONTRIBUTING.md](https://github.com/bswck/semantic_diffs/blob/HEAD/CONTRIBUTING.md).<br/>
Always happy to accept contributions! ❤️
# Legal info
© Copyright by Bartosz Sławecki ([@bswck](https://github.com/bswck)).
<br />This software is licensed under the terms of [MIT License](https://github.com/bswck/semantic_diffs/blob/HEAD/LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/bswck/semantic_diffs",
"name": "semantic-diffs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "bswck",
"author_email": "bswck.dev@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/42/65/481615040ebe945c10804ae1d029332f6cae52154882a75466e0a1bf6b4f/semantic_diffs-0.0.0.tar.gz",
"platform": null,
"description": "\n# semantic_diffs [](https://pypi.org/project/semantic-diffs/) [](https://pypi.org/project/semantic-diffs/)\n[](https://github.com/bswck/semantic_diffs/actions/workflows/test.yml)\n[](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/semantic_diffs)\n[](https://python-poetry.org/)\n[](https://github.com/astral-sh/ruff)\n[](https://github.com/psf/black)\n[](https://github.com/bswck/semantic_diffs/blob/HEAD/LICENSE)\n[](https://github.com/pre-commit/pre-commit)\n\nReuse codebase changes to automate refactoring.\n\n# Installation\nIf you want to\u2026\n\n\n\n## \u2026use this tool in your project \ud83d\udcbb\nYou might simply install it with pip:\n\n```shell\npip install semantic-diffs\n```\n\nIf you use [Poetry](https://python-poetry.org/), then run:\n\n```shell\npoetry add semantic-diffs\n```\n\n## \u2026contribute to [semantic_diffs](https://github.com/bswck/semantic_diffs) \ud83d\ude80\n\n\n> [!Note]\n> If you use Windows, it is highly recommended to complete the installation in the way presented below through [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).\n\n\n\n1. Fork the [semantic_diffs repository](https://github.com/bswck/semantic_diffs) on GitHub.\n\n1. [Install Poetry](https://python-poetry.org/docs/#installation).<br/>\n Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.\n You might use [pipx](https://github.com/pypa/pipx#readme) to install it globally (recommended):\n\n ```shell\n pipx install poetry\n ```\n\n <sub>If you encounter any problems, refer to [the official documentation](https://python-poetry.org/docs/#installation) for the most up-to-date installation instructions.</sub>\n\n If you want to use pipx to install dev dependencies as well, install the [`poetry pipx`](https://github.com/bswck/poetry-pipx#readme) plugin:\n ```shell\n pipx inject poetry poetry-pipx\n ```\n\n Be sure to have Python 3.8 installed\u2014if you use [pyenv](https://github.com/pyenv/pyenv#readme), simply run:\n\n ```shell\n pyenv install 3.8\n ```\n\n1. Clone your fork locally and install dependencies.\n\n ```shell\n git clone https://github.com/your-username/semantic_diffs path/to/semantic_diffs\n cd path/to/semantic_diffs\n poetry env use $(cat .python-version)\n ```\n\n If you use pipx, run the following command to install dev dependencies globally:\n ```shell\n poetry install --without=dev\n poetry pipx install dev\n ```\n Otherwise, run:\n\n ```shell\n poetry install\n ```\n Next up, simply activate the virtual environment and install pre-commit hooks:\n\n ```shell\n poetry shell\n pre-commit install --hook-type pre-commit --hook-type pre-push\n ```\n\nFor more information on how to contribute, check out [CONTRIBUTING.md](https://github.com/bswck/semantic_diffs/blob/HEAD/CONTRIBUTING.md).<br/>\nAlways happy to accept contributions! \u2764\ufe0f\n\n\n# Legal info\n\u00a9 Copyright by Bartosz S\u0142awecki ([@bswck](https://github.com/bswck)).\n<br />This software is licensed under the terms of [MIT License](https://github.com/bswck/semantic_diffs/blob/HEAD/LICENSE).\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Reuse codebase changes to automate refactoring.",
"version": "0.0.0",
"project_urls": {
"Coverage": "https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/semantic_diffs",
"Distribution": "https://pypi.org/project/semantic-diffs/",
"Documentation": "https://semantic-diffs.readthedocs.io/en/latest/",
"Homepage": "https://github.com/bswck/semantic_diffs",
"Issues": "https://github.com/bswck/semantic_diffs/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "59c7242157f34f919985fde23e80a6f5eb780e77ec56b10fb1efaaa04f027a36",
"md5": "3b48658ab8b20fa86c9072612108f741",
"sha256": "4d3eedd9c62e4d97bbe1d05cbbf16b8561e9a227a8edc2f46f7cb463b292a177"
},
"downloads": -1,
"filename": "semantic_diffs-0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3b48658ab8b20fa86c9072612108f741",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 4203,
"upload_time": "2023-12-05T04:54:39",
"upload_time_iso_8601": "2023-12-05T04:54:39.977231Z",
"url": "https://files.pythonhosted.org/packages/59/c7/242157f34f919985fde23e80a6f5eb780e77ec56b10fb1efaaa04f027a36/semantic_diffs-0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4265481615040ebe945c10804ae1d029332f6cae52154882a75466e0a1bf6b4f",
"md5": "efad4830b9a110ab2311bc8100509c56",
"sha256": "49419e5dc23599eba7021f919668608dc9d484f388609bccf5009cb867c509b1"
},
"downloads": -1,
"filename": "semantic_diffs-0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "efad4830b9a110ab2311bc8100509c56",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 4560,
"upload_time": "2023-12-05T04:54:41",
"upload_time_iso_8601": "2023-12-05T04:54:41.026201Z",
"url": "https://files.pythonhosted.org/packages/42/65/481615040ebe945c10804ae1d029332f6cae52154882a75466e0a1bf6b4f/semantic_diffs-0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-05 04:54:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bswck",
"github_project": "semantic_diffs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "semantic-diffs"
}
JSON
