diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 14 insertions, 6 deletions
@@ -1,13 +1,13 @@ # wikiget -[](https://travis-ci.org/clpo13/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 or Wikimedia Commons) using only the file name or the URL of its description page. -Requires Python 3.6+. Get it with `pip install --user wikiget`. +Requires Python 3.7+. Get it with `pip install --user wikiget` or `pipx install wikiget`. ## Usage @@ -79,7 +79,10 @@ to clutter your system Python environment: # and clone that instead git clone https://github.com/clpo13/wikiget cd wikiget + python3 -m venv venv +# or +virtualenv venv ``` To activate the virtual environment, use one of the following commands: @@ -93,13 +96,18 @@ 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 `python setup.py test`. +["editable" install](https://pip.pypa.io/en/stable/topics/local-project-installs/#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` +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-2021 Cody Logan and contributors +Copyright (C) 2018-2023 Cody Logan and contributors This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by |