From 39fc51041f3ece615228114ccaf493a92efef681 Mon Sep 17 00:00:00 2001 From: "Jonas M. Miguel" <44494117+jonasmmiguel@users.noreply.github.com> Date: Sun, 7 Apr 2024 06:40:19 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=C2=A0Remove=20references=20to=20a?= =?UTF-8?q?=20.rst=20README=20generated=20by=20poetry=20new=20(#632)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jonas M. Miguel Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: svlandeg Co-authored-by: Sebastián Ramírez --- docs/tutorial/package.md | 61 ++-------------------------------------- 1 file changed, 3 insertions(+), 58 deletions(-) diff --git a/docs/tutorial/package.md b/docs/tutorial/package.md index a6901a0a94..17fe5a4149 100644 --- a/docs/tutorial/package.md +++ b/docs/tutorial/package.md @@ -97,7 +97,7 @@ You can see that you have a generated project structure that looks like: . ├── poetry.lock ├── pyproject.toml -├── README.rst +├── README.md ├── rick_portal_gun │   └── __init__.py └── tests @@ -146,13 +146,7 @@ def load(): ## Modify the README -Let's change the README. By default it's a file `README.rst`. - -Let's change it to `README.md`. So, change the extension from `.rst` to `.md`. - -So that we can use Markdown instead of reStructuredText. - -And change the file to have something like: +Let's change the README to have something like: ```Markdown # Portal Gun @@ -160,55 +154,6 @@ And change the file to have something like: The awesome Portal Gun ``` -## Modify your project metadata - -Edit your file `pyproject.toml`. - -It would look something like: - -```TOML -[tool.poetry] -name = "rick-portal-gun" -version = "0.1.0" -description = "" -authors = ["Rick Sanchez "] - -[tool.poetry.dependencies] -python = "^3.10" -typer = {extras = ["all"], version = "^0.1.0"} - -[tool.poetry.dev-dependencies] -pytest = "^5.2" - -[build-system] -requires = ["poetry>=0.12"] -build-backend = "poetry.masonry.api" -``` - -We changed the default README, so let's make it use the new `README.md`. - -Add the line: - -```TOML hl_lines="6" -[tool.poetry] -name = "rick-portal-gun" -version = "0.1.0" -description = "" -authors = ["Rick Sanchez "] -readme = "README.md" - -[tool.poetry.dependencies] -python = "^3.10" -typer = {extras = ["all"], version = "^0.1.0"} - -[tool.poetry.dev-dependencies] -pytest = "^5.2" - -[build-system] -requires = ["poetry>=0.12"] -build-backend = "poetry.masonry.api" -``` - ## Add a "script" We are creating a Python package that can be installed with `pip install`. @@ -468,7 +413,7 @@ The file would live right beside `__init__.py`: . ├── poetry.lock ├── pyproject.toml -├── README.rst +├── README.md ├── rick_portal_gun │ ├── __init__.py │ ├── __main__.py