Refactored config file loading logic for easier default config usage.

[Thomas-Rowlands]

Description

Config files are now loaded separately depending on whether a default config is used or a new, user-made custom one.

Fixes #143

This new way of loading a default config file can be done like this:

from autocorpus.Autocorpus import Autocorpus
from autocorpus.configs.default_config import DefaultConfig

ac = Autocorpus(base_dir="my_base_dir", main_text="path/to/html/file")
ac.config = DefaultConfig.load_config(DefaultConfig.LEGACY_PMC)
ac.process_files("output/path")

For custom config files, users can do the following:

from autocorpus.Autocorpus import Autocorpus

ac = Autocorpus(base_dir="my_base_dir", main_text="path/to/html/file")
ac.config = ac.read_config("path/to/my_config.json")
ac.process_files("output/path")

Type of change

• Documentation (non-breaking change that adds or improves the documentation)
• New feature (non-breaking change which adds functionality)
• Optimization (non-breaking, back-end change that speeds up the code)
• Bug fix (non-breaking change which fixes an issue)
• Breaking change (whatever its nature)

Key checklist

• All tests pass (eg. pytest)
• The documentation builds and looks OK (eg. mkdocs)
• Pre-commit hooks run successfully (eg. pre-commit run --all-files)

Further checks

• Code is commented, particularly in hard-to-understand areas
• Tests added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))

[alexdewar]

Looks good! There's a missing call to process_files() needed and I'd replace that assert statement, but other than that I think it's all ok. I've made some other suggestions, but I'll leave it up to you whether you think they're worth it or not.

[AdrianDAlessandro]

Overall pretty good. Alex made some relevant comments that should be addressed

[Thomas-Rowlands]

Re-requested reviews as plenty of requested changes have been implemented but one may have been missed, I've put a refactor of the DefaultConfig class in which outdated some of the issues

[AdrianDAlessandro]

This is really good overall! I've made one suggestion about making the type of config consistent, which should also simplify the Enum. Will be happy to merge after that change

[alexdewar]

Agree with @AdrianDAlessandro's comment, but aside from that it looks good!

[Thomas-Rowlands]

load_config is now called to retrieve the config data as a dict, with the class docs adjusted

[alexdewar]

LGTM! 🚀

[alexdewar]

Oh, except that ruff is complaining about missing docstrings. You'll need to fix that before it'll let you merge.

Tip: you can install a hook locally to check this stuff before you commit if you run pre-commit install.

[Thomas-Rowlands]

Oh, except that ruff is complaining about missing docstrings. You'll need to fix that before it'll let you merge.

Tip: you can install a hook locally to check this stuff before you commit if you run pre-commit install.

Just tried my local ruff and its not reporting what is listed in the pre-commit.ci check on GitHub, so looks like I have a config issue. I've made changes based on the listed problems in the ruff GitHub action so far

[AdrianDAlessandro]

Great! I've enabled auto-merge and updated the branch, so this will merge once the checks have passed.