diff options
| author | Cody Logan <cody@lokken.dev> | 2023-10-30 16:01:34 -0700 |
|---|---|---|
| committer | Cody Logan <cody@lokken.dev> | 2023-10-30 16:01:34 -0700 |
| commit | b34a5e2357355642e4ab9a93bb9464ec8601bf0c (patch) | |
| tree | 6eb494f440f454d18f54205300ec2812f1bf6f77 | |
| parent | 55ee670ab004fd4b964188555ae9d05bff98c481 (diff) | |
| download | wikiget-b34a5e2357355642e4ab9a93bb9464ec8601bf0c.tar.gz wikiget-b34a5e2357355642e4ab9a93bb9464ec8601bf0c.zip | |
Update README
| -rw-r--r-- | README.md | 38 |
1 files changed, 28 insertions, 10 deletions
@@ -1,17 +1,28 @@ # wikiget -[](https://github.com/clpo13/wikiget/actions/workflows/python.yml) -[](https://badge.fury.io/py/wikiget) +[][python] +[][action] +[][codecov] +[][pypi] +[][license] -Something like wget for downloading a file from MediaWiki sites (like Wikipedia or Wikimedia Commons) using only the +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. ## Installation -Requires Python 3.7+ and pip. Get it with `pip install wikiget` or `pipx install wikiget`. +Requires Python 3.7+ and pip. Install the latest version with: -For the latest features, at the risk of bugs and undocumented behavior, you can try the dev branch: -`pip install https://github.com/clpo13/wikiget/archive/refs/heads/dev.zip` +```bash +pip install wikiget +``` + +For the latest features, at the risk of bugs and undocumented behavior, you can install the development version directly +from [GitHub]: + +```bash +pip install https://github.com/clpo13/wikiget/archive/refs/heads/master.zip +``` ## Usage @@ -64,8 +75,8 @@ wikiget https://en.wikipedia.org/wiki/File:Example.jpg -o test.jpg Pull requests, bug reports, or feature requests are more than welcome. -It's recommended that you use a [virtual environment manager][venv] like venv or [virtualenv][virtualenv] to create an -isolated environment in which to install this package's dependencies as not to clutter your system Python environment: +It's recommended that you use a [virtual environment manager][venv] like venv or [virtualenv] to create an isolated +environment in which to install this package's dependencies as not to clutter your system Python environment: ```bash # if you plan on submitting pull requests, fork the repo on GitHub and clone that instead @@ -91,8 +102,8 @@ Then run `pip install -e .` to invoke an ["editable" install][editable], meaning 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][hatch], simply clone the repository and run `hatch run test` to create the environment and -run pytest all in one go. Also try `hatch shell` or `hatch run wikiget --help`. +Alternatively, using [Hatch], simply clone the repository and run `hatch run test` to create the environment and run +pytest all in one go. Wikiget can also be run directly in the Hatch environment with `hatch run wikiget [...]`. ## License @@ -108,6 +119,13 @@ warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Gen You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. +[wget]: https://www.gnu.org/software/wget/ +[github]: https://github.com/clpo13/wikiget/ +[python]: https://www.python.org/ +[action]: https://github.com/clpo13/wikiget/actions/workflows/python.yml +[codecov]: https://app.codecov.io/gh/clpo13/wikiget/ +[pypi]: https://pypi.org/project/wikiget/ +[license]: https://github.com/clpo13/wikiget/blob/master/LICENSE [venv]: https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/ [virtualenv]: https://virtualenv.pypa.io/en/latest/ [editable]: https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs |