Skip to content

Commit

Permalink
Added dependencies and CLI function to project, and documented
Browse files Browse the repository at this point in the history
  • Loading branch information
smangham committed Oct 12, 2023
1 parent 0cfdd60 commit 5e0833d
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,21 @@ print(f"{n}{km.abbr} in {mile} = {km.to_unit(n, mile)}")

### CLI

The converter can also be run as a command-line tool.
Once it's been installed, it can be run in your terminal as:

```bash
oxrse-unit-conv 42 km mile
```

Help is available using:

```bash
oxrse-unit-conv --help
```



## Development

### Structure
Expand Down
9 changes: 8 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,18 @@ classifiers = [
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
]
dependencies = [
"click"
]

[project.scripts]
oxrse-unit-conv = "oxrse_unit_conv.main:click_convert"

[project.urls]
"Homepage" = "https://github.com/OxfordRSE/oxrse_unit_conv"
"Bug Tracker" = "https://github.com/OxfordRSE/oxrse_unit_conv/issues"


[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
build-backend = "hatchling.build"

0 comments on commit 5e0833d

Please sign in to comment.