Skip to content

Commit

Permalink
Remove section that has become irrelevant
Browse files Browse the repository at this point in the history
  • Loading branch information
svlandeg committed Apr 2, 2024
1 parent b2111ff commit 7fbfad7
Showing 1 changed file with 2 additions and 26 deletions.
28 changes: 2 additions & 26 deletions docs/tutorial/package.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,8 @@ def load():

## Modify the README

The default README has a `.md` extension and supports Markdown syntax. It can be replaced with an `.rst` file (reStructuredText), along with the corresponding change in `pyproject.toml`'s project metadata.

Let's change the README to have something like:

```Markdown
Expand All @@ -154,32 +156,6 @@ Let's change the README 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 <rick@example.com>"]
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`.
Expand Down

0 comments on commit 7fbfad7

Please sign in to comment.