aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorclpo13 <clpo13@gmail.com>2023-09-26 13:30:26 -0700
committerGitHub <noreply@github.com>2023-09-26 13:30:26 -0700
commite274ccea56219c7d07c0e677d44c8122a699dcaf (patch)
treef19915db2eafe895b949ced6dee183b51d3fb975 /README.md
parent602bbbb7e387f5c126d5130c6e7193f5ae906d9c (diff)
parent3c720f269d69f8bc505efed3f86881e530f55949 (diff)
downloadwikiget-e274ccea56219c7d07c0e677d44c8122a699dcaf.tar.gz
wikiget-e274ccea56219c7d07c0e677d44c8122a699dcaf.zip
Merge pull request #7 from clpo13/dev
Merge dev branch into master
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index 043f305..a0ccf8d 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,6 @@
# wikiget
+[![Python package](https://github.com/clpo13/wikiget/actions/workflows/python.yml/badge.svg?branch=master)](https://github.com/clpo13/wikiget/actions/workflows/python.yml)
[![PyPI version](https://badge.fury.io/py/wikiget.svg)](https://badge.fury.io/py/wikiget)
Something like wget for downloading a file from MediaWiki sites (like Wikipedia
@@ -93,9 +94,13 @@ source venv/bin/activate
Then run `pip install -e .` to invoke an
["editable" install](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs),
meaning any changes made to the source will be reflected immediately in the executable
-script. Unit tests can be run with `pytest` (make sure to run `pip install pytest-cov`
+script. Unit tests can be run with `pytest` (make sure to run `pip install pytest`
in the virtual environment first.)
+Alternatively, using [Hatch](https://hatch.pypa.io/latest/), simply clone the repository
+and run `hatch run test` to create the environment and run pytest. Also try `hatch shell`
+or `hatch run wikiget --help`.
+
## License
Copyright (C) 2018-2023 Cody Logan and contributors