Critchecker is a Python 3.11+ tool that fetches all the critique blocks and critiques posted by Critmas participants, counts the critique length, and stores the info in a CSV database.
To run, critchecker needs beautifulsoup4, tqdm and aiohttp.
Install them with:
python3 -m pip install beautifulsoup4 tqdm aiohttpInstalling the dependencies manually is not required if you install
critchecker via the .whl file.
To install critchecker, use pip and install the distributed .whl file with
the following command:
python3 -m pip install critchecker-X.Y.Z-py3-none-any.whlThe tool will then be available as critchecker or critchecker.exe,
depending on your OS of choice.
It's possible to display a brief usage message by running:
critchecker -hThe required parameters are the URL of the Critmas launch journal and the Critmas launch date, in the YYYY-MM-DD format. As such, an example invocation will be:
critchecker https://www.deviantart.com/beckykidus/journal/Critmas-2023-We-re-off-1005330829 2023-12-26It's possible to force a specific path to be used in place of the default one
for the CSV file.
For example, to save the critique database in a file called report.csv in the
current working directory, use:
critchecker -r "./report.csv" <url> <startdate>The default location for the CSV file will be either $HOME/critmas.csv or
C:\Users\<username>\critmas.csv, depending on your OS of choice.
Note that the target file will be overwritten if already present when
critchecker is run.
To build critchecker, run the following from the project's root directory:
poetry buildThis will build both the sdist and the wheel, placing them in the dist
subdirectory.
To build critchecker, you will need Poetry to manage project building,
virtual environments and dependencies.
If you want to contribute, feel encouraged to fork the project, move to the project root and run:
poetry installThis will setup a virtual environment with all the required dependencies,
including pylint, pytest, hypothesis and black.
Moreover, it'll make critchecker itself be installed inside the virtualenv,
and thus executable with:
poetry run critcheckerRemember to create a branch for every feature you want to implement or modify.
This project follows the Black code style, so it's sufficient to run the formatter on your code prior to contributing it. Sometimes, it might make sense to have Black avoid cramming multiple lines in one for the sake of clarity. If your gut says that code would look better on multiple lines, append a trailing comma to the last line as per the docs.
Type-annotate both the parameters and return values of your functions and methods, and always add docstrings to public code.
For the love of all that is dear, avoid inheritance outside of exception hierarchies. Likewise, do not use global variables, although global "constants" are fine.
Preferably, use the imperative tense in your commit titles, and make sure their length is 50 characters max.
Before issuing a PR, ensure that Pylint does not raise any warning apart from TODOs. If you feel the need to silence a warning, leave a comment explaining your reasons, or mention the rationale in the commit message.
To lint a file, use:
poetry run pylint <file>Remember - Pylint is our friend, not our enemy.
While not mandatory, I'd appreciate it if you added a Hypothesis-based unit test for every function you write, save for those dealing with the network. In case property-based testing isn't your cup of tea, ping me and I'll write the unit test.
To run the tests, use:
poetry run pytestIf you also want statistics on how Hypothesis spends time, use:
poetry run pytest --hypothesis-show-statisticsThis tool wouldn't exist if not for a certain BeckyKidus - it's thanks to
this noodle's encouragement and typo-spotting sight if critchecker was even
ready for Critmas 2020.
Checking out her art is highly recommended.
A thank you goes to neurotype too - as the Critmas 2020 host, she sure had a say on this tool's database format.
This program is licensed under the terms of the MIT license.
Check LICENSE.txt for further info.