pydantic / pydantic/pytest-examples
Feature requrest [I can do it myself if allowed]: Allow configuration of `pytest-examples` from `pyproject.toml`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 178
- Forks
- 25
- Avg merge
- 4d 1h
- Merged PRs (30d)
- 7
Description
Summary
Hey everyone!
I use pytest-examples in my small library and I see that at least pydantic-ai uses it
So I would like to make this library better
My initial PR was to enable pytest-examples on Windows, and now I would like to make it configurable via pyproject.toml
Here are examples of how I currently do this in my own library:
Example of how I pass my configurations:
https://github.com/Danipulok/pydantic-jsonschema/blob/3d14999a72bc873f3879cbbf30fe43cd6c6035ca/tests/test_docs.py#L12-L42
Example of the pyproject.toml I use:
https://github.com/Danipulok/pydantic-jsonschema/blob/3d14999a72bc873f3879cbbf30fe43cd6c6035ca/pyproject.toml#L257-L263
If allowed, I will see what options should be enabled etc., and simply will pass then as I do in my own code, but inside the library.
PS
I'm ready to help and would like to make this library better, so I can update all the deps, QOL, typehints and etc.
For this I would need someone to guide me (a little bit, I'm pretty independent) and merge PRs
I'm sure that samuelcolvin is pretty busy, but maybe someone from pydantic team would be able to spend like 10 minutes a day for this?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the referenced pydantic-jsonschema tests/test_docs.py configuration with its pyproject.toml example. Identify which pytest-examples options should be configurable and verify that equivalent settings work through pyproject.toml, with tests covering the supported configuration.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- testing-qa
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 64/100