- Python 94.7%
- Makefile 2.8%
- Dockerfile 2.5%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
SethFalco
39bc38a5f6
This is just noise which I used to do because I thought it was cool. And it kind of still is, but all platforms show the success status in the latest commit anyway so it's redundant. |
||
| .woodpecker | ||
| src/nordic_ashes_wiki_bot | ||
| tests | ||
| .dockerignore | ||
| .editorconfig | ||
| .gitignore | ||
| cspell.jsonc | ||
| Dockerfile | ||
| LICENSE | ||
| Makefile | ||
| NOTICE | ||
| poetry.lock | ||
| poetry.toml | ||
| pyproject.toml | ||
| README.md | ||
MediaWiki Bot for Nordic Ashes
A little helper for the Nordic Ashes Wiki.
Prerequisites
You should visit Special:BotPasswords to generate an application password for this service. You must grant the following rights:
- Edit existing pages
- Upload new files
- Edit protected pages (Only if the page to update is protected.)
Software
- Git
- Python >= v3.13
- Poetry
Installation
This package is not published anywhere. The only supported installation method is to clone the source code.
# Clone via HTTPS
git clone https://codeberg.org/SethFalco/nordic-ashes-wiki-bot.git
# Or clone via SSH
git clone ssh://git@codeberg.org/SethFalco/nordic-ashes-wiki-bot.git
# Install dependencies with Poetry
poetry install
Usage
You must create the files user-config.py and user-password.py in the directory you'll invoke the application from:
user-config.py
mylang = "en"
usernames["nordicashes"]["en"] = "YOUR_USERNAME"
password_file = "user-password.py"
user_agent_description = "Nordic Ashes Wiki Bot <YOUR@EMAIL.ADDRESS>"
user-password.py
('en', 'nordicashes', 'YOUR_USERNAME', BotPassword('YOUR_BOT_USERNAME', 'YOUR_BOT_PASSWORD'))
Then run the application with:
poetry run nordic-ashes-wiki-bot
By default, Nordic Ashes Wiki Bot will write deltas to a temporary directory, usually /tmp/. To publish changes directly to MediaWiki, pass the --publish flag:
poetry run nordic-ashes-wiki-bot --publish
You must always review the deltas when making changes. Do not run commands that will publish to the wiki without thoroughly testing them, or you may be banned for vandalizing the wiki.
⚠️ Warning
While running Nordic Ashes Wiki Bot, a pywikibot-YOUR_USERNAME.lwp file will be created. The file must be treated like a password. Never ever share it with anyone!