To make sure all regexes work as desired, we're using pytest to check them. Therefore, all regexes can be found inside a json file and the README.md file is generated with the contents of the json file.
So please, do not edit the README.md manually!
# set up a virtual environment
virtualenv -p /use/bin/python3 venv
source venv/bin/activate
# install the dependencies
pip install -r requirements.txt
- To add or change a regex, edit regexes.json.
Please use a capture group to extract contained information like usernames.
Also add tests to make sure everything works as expected.
Note that JSON requires double escaping for backslashes,
so for a literal dot
\.you'll need\\.inside the json file, e.g.example.com\\/index\\.htmlto matchexample.com/index.htmlliterally. - To update meta-information edit the template README.template.md
After you're done, please run make.
It will test your changes and generate the README.md file.
Please open a PR only after you followed these instructions.