diff options
| author | clpo13 <clpo13@gmail.com> | 2023-09-26 10:06:38 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-26 10:06:38 -0700 |
| commit | 6d2acf3bba628f62fe91bb778b7bb92a1057969b (patch) | |
| tree | fd902648c2ba522829772a8f9630053df18395d4 /README.md | |
| parent | 1941452615ff5b810e180437ae74e16a6d14eba6 (diff) | |
| download | wikiget-6d2acf3bba628f62fe91bb778b7bb92a1057969b.tar.gz wikiget-6d2acf3bba628f62fe91bb778b7bb92a1057969b.zip | |
Modernize setuptools build (#5)
Remove usage of deprecated `python setup.py test` and move to pyproject.toml for project configuration.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 8 insertions, 5 deletions
@@ -1,13 +1,12 @@ # wikiget -[](https://travis-ci.org/clpo13/wikiget) [](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 @@ -75,7 +74,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: @@ -90,12 +92,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 `python setup.py test`. +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` +in the virtual environment first.) ## 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 |
