What is it?
=================
This is sort of a plugin for poetry which add comments with description for every dependency in ``pyproject.toml`` based on ``poetry``.lock file.
So your dependencies will look like
.. code-block::
[tool.poetry.dependencies]
python = "^3.7"
toml = "^0.10.0" # Python Library for Tom's Obvious, Minimal Language ·· https://pypi.org/project/toml/
[tool.poetry.dev-dependencies]
pytest = "^5.2" # pytest: simple powerful testing with Python ·· https://pypi.org/project/pytest/
mock = "^4.0.2" # Rolling backport of unittest.mock for all Pythons ·· https://pypi.org/project/mock/
How to install
------------------------
Install via poetry
.. code-block::
poetry add --dev poetry-deps-formatter
Install via PIP
.. code-block::
pip install poetry-deps-formatter
Then you have to add it to ``tool.poetry.scripts`` section of your ``pyproject.toml`` file.
.. code-block::
[tool.poetry.scripts]
format = "poetry_deps_formatter:formatter"
How to use
------------------------
.. code-block::
poetry run format
Raw data
{
"_id": null,
"home_page": "https://github.com/true-brains/poetry-deps-formatter",
"name": "poetry-deps-formatter",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Jack Klimov",
"author_email": "jaklimoff@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f7/03/6f9c165622508d40a76c020130c36b54db6393b97ce9bfa76556f032c414/poetry_deps_formatter-0.1.2.tar.gz",
"platform": null,
"description": "What is it?\n=================\n\nThis is sort of a plugin for poetry which add comments with description for every dependency in ``pyproject.toml`` based on ``poetry``.lock file.\n\nSo your dependencies will look like\n\n.. code-block::\n\n [tool.poetry.dependencies]\n python = \"^3.7\"\n toml = \"^0.10.0\" # Python Library for Tom's Obvious, Minimal Language \u00b7\u00b7 https://pypi.org/project/toml/\n\n [tool.poetry.dev-dependencies]\n pytest = \"^5.2\" # pytest: simple powerful testing with Python \u00b7\u00b7 https://pypi.org/project/pytest/\n mock = \"^4.0.2\" # Rolling backport of unittest.mock for all Pythons \u00b7\u00b7 https://pypi.org/project/mock/\n\n\n\nHow to install\n------------------------\n\nInstall via poetry\n\n.. code-block::\n\n poetry add --dev poetry-deps-formatter\n\n\nInstall via PIP\n\n.. code-block::\n\n pip install poetry-deps-formatter\n\n\n\nThen you have to add it to ``tool.poetry.scripts`` section of your ``pyproject.toml`` file.\n\n.. code-block::\n\n [tool.poetry.scripts]\n format = \"poetry_deps_formatter:formatter\"\n\n\nHow to use\n------------------------\n\n.. code-block::\n\n poetry run format\n",
"bugtrack_url": null,
"license": null,
"summary": "Beautify dependencies in pyproject.yaml based on poetry.lock",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/true-brains/poetry-deps-formatter",
"Repository": "https://github.com/true-brains/poetry-deps-formatter"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "37c260d115c52d6d74c6611e4f78cf759552d8e54b39d15fc23ec1c794121f90",
"md5": "fdebe15b1e7f2d3e3aaca32f268790c2",
"sha256": "fa8c864c652f60a74e4b1cb09026f714f3d928a8bdc3076d6a68bfe7f688dbc8"
},
"downloads": -1,
"filename": "poetry_deps_formatter-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fdebe15b1e7f2d3e3aaca32f268790c2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 2773,
"upload_time": "2024-10-29T18:33:01",
"upload_time_iso_8601": "2024-10-29T18:33:01.643114Z",
"url": "https://files.pythonhosted.org/packages/37/c2/60d115c52d6d74c6611e4f78cf759552d8e54b39d15fc23ec1c794121f90/poetry_deps_formatter-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f7036f9c165622508d40a76c020130c36b54db6393b97ce9bfa76556f032c414",
"md5": "cde5437bb0f7f61ccf275fee3cd5cb63",
"sha256": "40a518a221b25916b632529139e70dc268a42a069180cff74191acd153e66481"
},
"downloads": -1,
"filename": "poetry_deps_formatter-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "cde5437bb0f7f61ccf275fee3cd5cb63",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 1981,
"upload_time": "2024-10-29T18:33:03",
"upload_time_iso_8601": "2024-10-29T18:33:03.097959Z",
"url": "https://files.pythonhosted.org/packages/f7/03/6f9c165622508d40a76c020130c36b54db6393b97ce9bfa76556f032c414/poetry_deps_formatter-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-29 18:33:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "true-brains",
"github_project": "poetry-deps-formatter",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"lcname": "poetry-deps-formatter"
}
JSON
