From 79c809e5547e352f3d3140bab22521ba505ea02f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcin=20R=C3=B3=C5=BCewski?= Date: Thu, 26 Oct 2023 00:46:04 +0200 Subject: [PATCH] build(deps-dev): added new optional dependencies for the project (#75) Added the `ipython`, `pytest-cov`, `pytest`, `setuptools`, and `wheel`. Updated the project name, description, urls names. Deleting the `requirements*.txt` files, and updating the documentation that have the new instruction for development. --- README.md | 6 +++--- pyproject.toml | 22 +++++++++++++++------- requirements-dev.txt | 8 -------- requirements.txt | 3 --- 4 files changed, 18 insertions(+), 21 deletions(-) delete mode 100644 requirements-dev.txt delete mode 100644 requirements.txt diff --git a/README.md b/README.md index 30762d2..6cf32b8 100644 --- a/README.md +++ b/README.md @@ -70,10 +70,10 @@ Creating and activating the development environment, and then installing the nec ```shell virtualenv --pip=23.3.1 --python=python3.12 .venv source .venv/bin/activate -pip install -r requirements.txt -r requirements-dev.txt +pip install ".[dev]" ``` -All dependencies for this project are specified in the `requirements*` files and in the project's TOML configuration. +All dependencies for this project are specified in the project's TOML configuration. You can install these dependencies using the `pip install .` command, which will build our package and install the basic dependencies along with the new version of our package. To install dev dependencies, you can use the `pip install ".[dev]"` command instead of specifying a `-r` flag and file as mentioned earlier. @@ -81,7 +81,7 @@ After following the above instructions, we can start writing the program. You ca #### Build Package -Building our **Python** package is done using the `build` module, which was previously installed as a requirement in the `requirements-dev.txt` file when activating the development environment. +Building our **Python** package is done using the `build` module, which was previously installed as a requirement when activating the development environment. To build the package, enter the following command in the terminal: diff --git a/pyproject.toml b/pyproject.toml index 6dbd840..a5378e4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -9,9 +9,9 @@ build-backend = "setuptools.build_meta" [project] -name = "mdsanima_cli" +name = "mdsanima-cli" dynamic = ["version"] -description = "Command-line tools for image processing, generating pixel art, adding logos to images, and much more." +description = "A command-line tool for image processing, generating pixel art, adding logos to images, and much more." readme = "README.md" requires-python = ">=3.10" license = { file = "LICENSE" } @@ -44,7 +44,7 @@ keywords = [ "zsh", ] classifiers = [ - "Development Status :: 2 - Pre-Alpha", + "Development Status :: 3 - Alpha", "Environment :: Console", "Environment :: Plugins", "Intended Audience :: Developers", @@ -64,6 +64,7 @@ classifiers = [ "Operating System :: Unix", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", "Topic :: Desktop Environment", "Topic :: Documentation :: Sphinx", "Topic :: Education :: Testing", @@ -96,19 +97,25 @@ dev = [ "black==23.10.1", "build==1.0.3", "flake8==6.1.0", + "ipython==8.16.1", "isort==5.12.0", "pylint==3.0.2", + "pytest-cov==4.1.0", + "pytest==7.4.2", "setuptools-scm==8.0.4", + "setuptools==68.2.2", "twine==4.0.2", "virtualenv==20.24.6", + "wheel==0.41.2", ] [project.urls] -homepage = "https://github.com/mdsanima-lab/mdsanima-cli" -documentation = "https://github.com/mdsanima-lab/mdsanima-cli#readme" -repository = "https://github.com/mdsanima-lab/mdsanima-cli.git" -changelog = "https://github.com/mdsanima-lab/mdsanima-cli/blob/main/CHANGELOG.md" +Homepage = "https://github.com/mdsanima-lab/mdsanima-cli" +Documentation = "https://github.com/mdsanima-lab/mdsanima-cli#readme" +Repository = "https://github.com/mdsanima-lab/mdsanima-cli.git" +Changelog = "https://github.com/mdsanima-lab/mdsanima-cli/blob/main/CHANGELOG.md" +Tracker = "https://github.com/mdsanima-lab/mdsanima-cli/issues" [project.scripts] @@ -122,6 +129,7 @@ line-length = 120 [tool.isort] profile = "black" +# known_first_party = ["mdsanima_cli", "tests"] src_paths = ["src", "tests"] force_single_line = true lines_before_imports = 2 diff --git a/requirements-dev.txt b/requirements-dev.txt deleted file mode 100644 index aa7470f..0000000 --- a/requirements-dev.txt +++ /dev/null @@ -1,8 +0,0 @@ -black==23.10.1 -build==1.0.3 -flake8==6.1.0 -isort==5.12.0 -pylint==3.0.2 -setuptools-scm==8.0.4 -twine==4.0.2 -virtualenv==20.24.6 diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index d484de8..0000000 --- a/requirements.txt +++ /dev/null @@ -1,3 +0,0 @@ -mdsanima-dev==0.2.0 -piexif==1.1.3 -pillow==10.1.0