Feature Request: Add support for housing config in `pyproject.toml`

[caffeinatedMike]

For some developers, like myself, pyproject.toml has become the central file for housing configuration for various CI/CD tool configurations in order to avoid having individual config files per-tool, which quickly becomes a headache to maintain.

With that being said, would you be open to adding support for housing the configuration within a project's pyproject.toml file? I understand that this would lead to an additional dependency (likely toml) until the lower-bound supported python version becomes 3.11 (a long ways from now), which has native support for parsing toml files using tomllib. However, as this is a fairly common dependency among other CI/CD tools, I feel the additional dependency is worth it.

Thoughts?

[MiWeiss]

Hi @caffeinatedMike

Thanks for bringing this up - supporting pyproject.toml has long been on our roadmap.

Additional Dependency

For what regards the additional dependence; I think its ok:

1. @HunterMcGushion already previously agreed to support toml files, and there's no way around the additional lib.
2. When adding yml support, we did the same.
3. The toml dependency is appears lightweight and stable.

How to put this alongside yml and legacy config files?

At the moment, if both a yml and legacy config file exist, we throw an exception. We can't be so strict with toml, as non-docstr-coverage toml files may be present. I suggest the following:

• If --config points to any toml or yml file, said file is used. If --docstr-ignore-file is also set, an exception is raised (same as before).
• If there is a toml with a [docstr-coverage] section, and a yml (with default file name) or legacy config, we raise an exception.
• If there is toml without a [docstr-coverage] section, we ignore it, but log an "info" message that we now support toml.

What do you think? Any case I am missing? Also, would you be willing to contribute this change?

[HunterMcGushion]

@MiWeiss beat me to the punch, but I agree with everything he said. I'm a big fan of reducing config files, so thanks for supporting this feature, @caffeinatedMike!

[caffeinatedMike]

@MiWeiss @HunterMcGushion I'd be happy to contribute this change. But, just as a heads up, I won't have the bandwidth until next week at the earliest.

[MiWeiss]

Awesome! Thanks heaps!

[MiWeiss]

Hi @caffeinatedMike. Do you have any updates on your progress?

[caffeinatedMike]

@MiWeiss sorry, I haven't been able to commit any time to projects outside of work for the last month

[MiWeiss]

@caffeinatedMike no worries :-) Can I keep the issue assigned to you, i.e., do you think you'll find the time to open a PR anytime soon?

[caffeinatedMike]

@MiWeiss It's your call. Unfortunately, I don't foresee things calming down until mid-November at the very earliest. We have a new-hire coming aboard, which I'll be helping get up to speed.

[MiWeiss]

No problem. If that's ok with you, I'll open the issue for anyone to work on it (it's hacktoberfest, hence we may find someone), put please comment again when you're available and I'll happily re-assign the issue to you :-)