swagger-api / swagger-api/swagger-codegen
[Python] The configuration is not initialized in the readme doc
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
The configuration is not initialized in the python generated client readme doc
Maybe should provide a way to initialize the configuration for users
link
https://github.com/swagger-api/swagger-codegen/blob/v3.0.42/samples/client/petstore/python/README.md
Swagger-codegen version
v3.0.42
Swagger declaration file content or url
Command line used for generation
Steps to reproduce
Related issues/PRs
Suggest a fix/enhancement
Provide the initialization method of configuration
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
Start with samples/client/petstore/python/README.md linked in the issue and inspect how the generated Python client currently describes configuration. Update the generated README to show the configuration initialization method, then verify that the resulting documentation gives users a usable setup example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100