diff options
| author | Cody Logan <clpo13@gmail.com> | 2023-09-26 13:25:19 -0700 |
|---|---|---|
| committer | Cody Logan <clpo13@gmail.com> | 2023-09-26 13:25:19 -0700 |
| commit | 3c720f269d69f8bc505efed3f86881e530f55949 (patch) | |
| tree | f19915db2eafe895b949ced6dee183b51d3fb975 /README.md | |
| parent | cc78716425b184fef0e8cda191c9a0cce53d26a9 (diff) | |
| download | wikiget-3c720f269d69f8bc505efed3f86881e530f55949.tar.gz wikiget-3c720f269d69f8bc505efed3f86881e530f55949.zip | |
Update README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 7 |
1 files changed, 6 insertions, 1 deletions
@@ -1,5 +1,6 @@ # wikiget +[](https://github.com/clpo13/wikiget/actions/workflows/python.yml) [](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 |