Merge pull request #119 from the-dotify-project/development

Development

Author: billsioros

docs/CONTRIBUTING.md

@@ -67,14 +67,14 @@ Start by visiting the [Spotify Developer Portal](https://developer.spotify.com/d
 
 The project utilizes the [pre-commit](https://pre-commit.com/) framework. Having [created a virtual environment and installed the required dependencies](#installing-poetry), you may run `pre-commit install` to install the [git hook scripts](https://github.com/the-dotify-project/dotify/blob/master/.pre-commit-config.yaml).
 
-### Formatting, Linting and Testing
+### Using `tox`
 
-All of the above can be done via [tox](https://tox.readthedocs.io/en/latest/config.html):
+> We are using [tox](https://tox.readthedocs.io/en/latest/index.html) to automate testing on multiple environments.
 
 - You can lint the code by simply running `tox -e lint`
 - Checking for type errors, using [Mypy](https://mypy.readthedocs.io/en/stable/), can be achieved via `tox -e type-check`
 - Checking if your changes follow the project's formatting standard can be done via `tox -e fmt-check`
-- You may run `tox -e py38` in order to run the library's unit tests using Python 3.8 (the `py37`, `py38` and `py39` test environments assumes that you have **Python 3.7, 3.8 or 3.9** installed)
+- You may run `tox -e py38` to run the library's unit tests using Python 3.8 (the `py37`, `py38` and `py39` test environments assume, you have installed **Python 3.7, 3.8 or 3.9** accordingly)
 - Alternatively, you may simply run `tox` to execute all of the above
 
 Note that in order to run the test suite, you must export your client credentials beforehand, as such
@@ -84,10 +84,16 @@ export SPOTIFY_ID="<SPOTIFY_ID>"
 export SPOTIFY_SECRET="<SPOTIFY_SECRET>"
 ```
 
-You may also utilize [direnv](https://direnv.net/), in order to avoid re-exporting them every time you spawn a new shell instance.
+You may also utilize [direnv](https://direnv.net/), so that you avoid re-exporting them every time you spawn a new shell instance.
 
 _**ATTENTION**: Even though, using a `.envrc` file is far more convenient than re-exporting  environment variables each and every time you open up a new shell, it is **strongly** recommended that, you prefer the first approach as you risk compromising your client credentials otherwise._
 
+#### Using `poethepoet`
+
+> We are using [poethepoet](https://github.com/nat-n/poethepoet), to perform various development oriented tasks.
+
+Formatting, type-checking, running the test suite, as well as a few other operations, can be performed by running `poe <task>`. Please run `poe --help` (or `poetry run poe --help`), to list all available operations.
+
 #### (Optional) Installing pyenv
 
 [pyenv](https://github.com/pyenv/pyenv) is used, in the context of the **Dotify** project, in order to determine the project's compatibility with various versions of Python. Installing `pyenv` is not strictly required, but it is **strongly** recommended.

pyproject.toml

@@ -1,8 +1,3 @@
-[tool.semantic_release]
-version_toml = "pyproject.toml:tool.poetry.version"
-changelog_components = "semantic_release.changelog.changelog_headers,semantic_release.changelog.compare_url"
-build_command = "python -m pip install poetry && poetry build"
-
 [tool.poetry]
 name = "dotify"
 version = "2.0.4"
@@ -12,6 +7,21 @@ authors = ["billsioros <[email protected]>"]
 license = "MIT"
 homepage = "https://the-dotify-project.github.io/dotify"
 repository = "https://github.com/the-dotify-project/dotify"
+keywords = ["spotify", "download", "downloader", "youtube", "mp3"]
+classifiers = [
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Topic :: Multimedia",
+    "Topic :: Multimedia :: Sound/Audio",
+    "Operating System :: OS Independent"
+]
 
 [tool.poetry.urls]
 "Bug Tracker" = "https://github.com/the-dotify-project/dotify/issues"
@@ -52,9 +62,10 @@ mdx-truly-sane-lists = "^1.2"
 mike = "^1.0.1"
 poethepoet = "^0.10.0"
 
-[build-system]
-requires = ["poetry-core>=1.0.0"]
-build-backend = "poetry.core.masonry.api"
+[tool.semantic_release]
+version_toml = "pyproject.toml:tool.poetry.version"
+changelog_components = "semantic_release.changelog.changelog_headers,semantic_release.changelog.compare_url"
+build_command = "python -m pip install poetry && poetry build"
 
 [tool.vulture]
 min_confidence = 95
@@ -65,6 +76,10 @@ clean = { cmd = "rm -rf ./**/__pycache__ dist site .pytest_cache .mypy_cache .co
 format = { cmd = "poetry run isort .; poetry run black .", help = "Format your codebase" }
 hooks = { cmd = "poetry run pre-commit run --all-files", help = "Run all pre-commit hooks"}
 test = { cmd = "poetry run pytest --cov=dotify", help = "Run the test suite and produce a coverage report" }
-types = { cmd = "poetry run mypy dotify tests", help = "Run static type checking on your codebase" }
+type-check = { cmd = "poetry run mypy dotify tests", help = "Run static type checking on your codebase" }
 lint = { cmd = "poetry run flake8 .", help = "Lint your code for errors" }
 docs = { cmd = "poetry run mike serve", help = "Build and serve the documentation" }
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"