Skip to content

Commit

Permalink
build(deps-dev): added new optional dependencies for the project (#75)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
mdsanima authored Oct 25, 2023
1 parent 5639077 commit 79c809e
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 21 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,18 +70,18 @@ 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.

After following the above instructions, we can start writing the program. You can also refer to the instructions regarding the configuration of the development environment, which are included in this [workflow](https://docs.mdsanima.dev/development/workflow/) guide.

#### 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:

Expand Down
22 changes: 15 additions & 7 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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" }
Expand Down Expand Up @@ -44,7 +44,7 @@ keywords = [
"zsh",
]
classifiers = [
"Development Status :: 2 - Pre-Alpha",
"Development Status :: 3 - Alpha",
"Environment :: Console",
"Environment :: Plugins",
"Intended Audience :: Developers",
Expand All @@ -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",
Expand Down Expand Up @@ -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]
Expand All @@ -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
Expand Down
8 changes: 0 additions & 8 deletions requirements-dev.txt

This file was deleted.

3 changes: 0 additions & 3 deletions requirements.txt

This file was deleted.

0 comments on commit 79c809e

Please sign in to comment.