diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 72 |
1 files changed, 70 insertions, 2 deletions
@@ -1,2 +1,70 @@ -# python-wikiget -Download files from MediaWiki sites +# wikiget + +Something like a wget clone for downloading files from MediaWiki sites (like +Wikipedia or Wikimedia Commons) using only the file name or the URL of its +description page. Requires Python 2 or 3. Install with `pip install --user -U wikiget`. + +## Usage + +`wikiget [-h] [-V] [-q | -v] [-f] [--site SITE] [-o OUTPUT] FILE` + +If `FILE` is in the form `File:Example.jpg` or `Example.jpg`, it will be fetched +from the default site, which is "en.wikipedia.org". If it's the fully-qualified +URL of a file description page, like `https://commons.wikimedia.org/wiki/File:Example.jpg`, +the file is fetched from the specified site, in this case "commons.wikimedia.org". + +The site can also be specified with the `--site` flag, though this will not have +any effect if the full URL is given. + +More detailed information, such as the site used and full URL of the file, can be +displayed with `-v` or `--verbose`. Use `-vv` to display even more detail. `-q` can +be used to silence warnings. + +By default, the program won't overwrite existing files with the same name as the +target, but this can be forced with `-f` or `--force`. Additionally, the file can +be downloaded to a different name with `-o`. + +## Future plans + +- download from any MediaWiki-powered site, not just Wikimedia projects +- download Wikipedia articles, in plain text, wikitext, or other formats + +## Contributing + +It's recommended that you use a virtual environment manager (like virtualenv) to +install dependencies: + +```bash +pip install --user -U virtualenv +git clone https://github.com/clpo13/python-wikiget.git +cd python-wikiget +virtualenv venv +``` + +To activate the virtual environment, use one of the following commands: + +```bash +source venv/bin/activate # Linux and macOS (bash, zsh) +.\venv\Scripts\activate.bat # Windows command prompt +.\venv\Scripts\Activate.ps1 # Windows PowerShell +``` + +Then run `pip install -e .` to invoke an editable install, meaning any changes +made to the source will be reflected immediately. + +## License + +Copyright (C) 2018 Cody Logan + +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 +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see <https://www.gnu.org/licenses/>. |