Skip to main content

CLI wrapper around Pywikibot for simpler Wikimedia Commons uploads

Project description

It is a wrapper around pywikibot to make uploading to Wikimedia Commons from CLI simpler.

Install

From PyPI:

pip install pwb-wrapper-for-simpler-uploading-to-commons

With shell autocompletion support:

pip install 'pwb-wrapper-for-simpler-uploading-to-commons[autocomplete]'

Usage

Installed CLI command:

pwb-upload --file my.jpg --source https://example.com --license 'PD-old' --category 'Sunsets in Batumi' --date '2025-12-27' --desc 'A beautiful sunset from the beach' --target myrenamed.jpg

For multiple categories, repeat --category:

pwb-upload --file my.jpg --category 'Sunsets in Batumi' --category 'Evening in Georgia' --date '2025-12-27'

Default source is {{own}}.

Default license is cc-by-4.0.

--target (file name on Commons) is optional.

--prefix (prefix for file name on Commons) is optional.

--i lets you start from a specific index.

--recursive includes files from subfolders when no file is specified.

You can upload with minimal arguments:

pwb-upload --file my.jpg --category 'Sunsets in Batumi' --date '2025-12-27'

Or pass the file as positional argument:

pwb-upload my.jpg --category 'Sunsets in Batumi' --date '2025-12-27'

Or upload without category and date (set them later on Commons):

pwb-upload my.jpg

If no file is specified, it uploads eligible files from the current folder (no subfolders by default).

To include subfolders:

pwb-upload --recursive

For local development (without installation), you can still run:

./upload.py --file my.jpg

Author: for the current user use me.

Autocompletion

Enable completion for the installed command:

eval "$(register-python-argcomplete pwb-upload)"

Release to PyPI

Build distribution files:

python3 -m build

Upload to TestPyPI:

python3 -m twine upload --repository testpypi dist/*

Upload to PyPI:

python3 -m twine upload dist/*

Wikidata item about this tool https://www.wikidata.org/wiki/Q137601716

Commons category https://commons.wikimedia.org/wiki/Category:Uploaded_with_pwb_wrapper_script_by_Vitaly_Zdanevich

SonarCloud https://sonarcloud.io/project/overview?id=vitaly-zdanevich_pwb_wrapper_for_simpler_uploading_to_commons

See also

My another Python script for uploading to Commons from gThumb

My web extension for uploading to Commons

All upload tools

CLI upload tools

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file pwb_wrapper_for_simpler_uploading_to_commons-0.2.1.tar.gz.

File metadata

File hashes

Hashes for pwb_wrapper_for_simpler_uploading_to_commons-0.2.1.tar.gz
Algorithm Hash digest
SHA256 03466b35bb9f78dc591b010fbe6b1ab497dc358d9d9ce38b15426ec868c5d56c
MD5 55c8d45a2eee34a519ed94b8ae6b1f29
BLAKE2b-256 ab427bb742482df05fa06a8c01b239cb3fe5639f7f0f937c733c517dd8e75f57

See more details on using hashes here.

File details

Details for the file pwb_wrapper_for_simpler_uploading_to_commons-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pwb_wrapper_for_simpler_uploading_to_commons-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d6185ea882f8ff883796d9a66e71867ffe6a90c9344984d527a2123eda0f85c0
MD5 9e1c0f9e4431d37ae54a1ff6076bc1cf
BLAKE2b-256 0a232cba892d2abec0b1771487305fbb52533047a57a5cc7f0d290e25d798395

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page