openedx / openedx/api-doc-tools
Consider pinning drf-yasg in setup.py `install_requires`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
Different versions of drf-yasg may break or change the behavior of api-doc-tools.
Thus, if drf-yasg is upgraded in a service, it may seem like api-doc-tools changed, even if that package's version did not change.
I recommend that we require a specific version of drf-yasg as an installation requirement of edx-api-doc-tools. Ideally, this pin could be continuously updated by make upgrade PRs in this repo.
As far as I know, no edX repository other than this one directly depends on drf-yasg, so we shouldn't see issues with conflicting version constraints.
Contributor guide
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
Inspect setup.py and the existing make upgrade workflow to see how dependencies are declared and updated. Pin drf-yasg to an agreed specific version and confirm that make upgrade can continue producing update PRs for that pin.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100