Skip to content

Commit

Permalink
Update readme, add github link to pypi, bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
lkeegan committed Feb 5, 2024
1 parent 4b6e6c8 commit 6526203
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
12 changes: 9 additions & 3 deletions calculate-liam/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# calculate-liam

A simple example of a Python package.
A simple example of a Python package from the [SSC Python Packaging course](https://ssciwr.github.io/python-packaging).

## Local install
## testPyPI install

`pip install .`
First ensure that the dependencies are installed from (real) PyPI:

`pip install click numpy`

Then you can install this package from test PyPI:

`pip install -i https://test.pypi.org/simple/ calculate-liam`

## Use

Expand Down
7 changes: 5 additions & 2 deletions calculate-liam/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ build-backend = "hatchling.build"

[project]
name = "calculate-liam"
version = "0.0.1"
version = "0.0.2"
dependencies = ["click", "numpy"]
authors = [
{ name="Liam Keegan", email="liam@keegan.ch" },
]
description = "A simple package to flip a coin or roll dice"
description = "An example package from the SSC Python Packaging course"
readme = "README.md"
requires-python = ">=3.8"
classifiers = [
Expand All @@ -18,6 +18,9 @@ classifiers = [
"Operating System :: OS Independent",
]

[project.urls]
Github = "https://github.com/ssciwr/python-packaging"

[project.optional-dependencies]
test = ["pytest"]

Expand Down

0 comments on commit 6526203

Please sign in to comment.