This project compares the source code of the Sojourn-13 project (https://github.com/sojourn-13/sojourn-station) with its Wiki (https://sojourn13.space/wiki/Main_Page) in certain topics, to make sure that the documentation there is up to date. This comparison consists of
- Perks
- Chemicals
- Psionic Powers
After the comparison, it shows what items exist in code, but not in the wiki, and what items exist in the wiki, but aren't in the code (anymore?).
To achieve this, certain parts of the sojourn-13 source code are downloaded from github and parsed. Then certain wiki pages are downloaded and also parsed. The results are then examined and compared.
- Python
- PyGithub (https://pygithub.readthedocs.io/),
pip install pygithub - Requests (https://pypi.org/project/requests/),
pip install requests - WikiTextParser (https://pypi.org/project/wikitextparser),
pip install wikitextparser
Call CodeWikiComparison.py
To speed up the download from the source files from github, a Github token can be placed in a text file named "githubtoken" and placed in the directory next to the CodeWikiComparison.py file.
The project is the first Python project by the author, expect it to be bad. Especially the parser of the code files is everything but universal. It worked for the certain set of files, but could trip over any (Dreammaker) language specific detail. It's bad. It works right now, but it's bad. Baaad.
Changes in the wiki articles could cause the project to seize functioning. This is especially the case when the articles are moved or renamed, but restructurings in them could be too much as well.
The project needs permission to create files and subdirectories in the directory in which it runs in.
There were first steps to create wiki table entries for missing entities, but it's not included yet.