Skip to content

Commit 4e293a3

Browse files
authored
[readme] README update + programatic versioning (#66)
* clean instructions * move version to package * fixed programmatic version
1 parent 3aaa04d commit 4e293a3

File tree

4 files changed

+9
-6
lines changed

4 files changed

+9
-6
lines changed

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Extract datetimes, datetime ranges, and datetime lists from natural language tex
1414
Install with pip using
1515

1616
```shell
17-
pip install timefhuman
17+
$ pip install timefhuman
1818
```
1919

2020
Then, find natural language dates and times in any text.
@@ -197,14 +197,12 @@ class tfhConfig:
197197
Install the development version.
198198

199199
```shell
200-
$ pip install .e .[test] # for bash
201200
$ pip install -e .\[test\] # for zsh
202201
```
203202

204203
To run tests and simultaneously generate a coverage report, use the following commands:
205204

206205
```shell
207-
$ py.test --cov
208-
$ coverage html
206+
$ py.test --cov --cov-report=html
209207
$ open htmlcov/index.html
210208
```

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "timefhuman"
7-
version = "0.1.2"
7+
dynamic = ["version"]
88
description = "Extract datetimes, datetime ranges, and datetime lists from natural language text"
99
readme = "README.md"
1010
license = { text = "Apache-2.0" }

setup.cfg

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[metadata]
2+
version = attr: timefhuman.__VERSION__

timefhuman/__init__.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
from .main import timefhuman, tfhConfig, Direction, DEFAULT_CONFIG
1+
from .main import timefhuman, tfhConfig, Direction, DEFAULT_CONFIG
2+
3+
4+
__VERSION__ = '0.1.3'

0 commit comments

Comments
 (0)