From 6bcd21f40f050260fe96813163b2627dd444cd39 Mon Sep 17 00:00:00 2001 From: Kirill Markin Date: Mon, 16 Dec 2024 10:38:09 +0100 Subject: [PATCH] fix pyproject usage --- .github/workflows/tests.yml | 3 +-- MANIFEST.in | 3 +-- README.md | 26 +++++++++++++++++++------- 3 files changed, 21 insertions(+), 11 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 6edf942..dba36b5 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -27,8 +27,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install -r requirements.txt - pip install pytest + pip install .[dev] - name: Run tests run: | pytest tests/ \ No newline at end of file diff --git a/MANIFEST.in b/MANIFEST.in index bb910eb..74215c3 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,3 +1,2 @@ include README.md -include LICENSE -include requirements.txt +include LICENSE \ No newline at end of file diff --git a/README.md b/README.md index bee71f4..0a7f9df 100644 --- a/README.md +++ b/README.md @@ -177,19 +177,31 @@ To install `repo-to-text` locally for development, follow these steps: cd repo-to-text ``` -2. Install the package locally: +2. Install the package with development dependencies: ```bash - pip install -e . + pip install -e .[dev] ``` -### Installing Dependencies +### Requirements -To install all the required dependencies, run the following command: +- Python >= 3.6 +- Core dependencies: + - setuptools >= 70.0.0 + - pathspec >= 0.12.1 + - argparse >= 1.4.0 + - PyYAML >= 6.0.1 -```bash -pip install -r requirements.txt -``` +### Development Dependencies + +For development, additional packages are required: + +- pytest >= 8.2.2 +- black +- mypy +- isort +- build +- twine ### Running Tests