swagger-api / swagger-api/swagger-codegen

[Python] improving "packageName" and "projectName" in CLI options

Open
#5,840 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Client: Python General: Suggestion help wanted
Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Description

Here is the suggestion by @frol

Semantically, projectName should be the "most important" configuration, which would be used to generate packageName (meaning that it is the other way around than it is implemented now), BUT given the fact that packageName was introduced earlier, it makes sense to have this backward packageName to projectName generation. Can both projectName -> packageName and packageName -> projectName autogenerations be implemented? Does this make sense to you?

Swagger-codegen version

Latest master

Related issues

https://github.com/swagger-api/swagger-codegen/pull/5836``

Suggest a Fix

If anyone has feedback or wants to work on this enhancement, please reply to let us know.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the CLI option handling for packageName and projectName, then read the related pull request #5836 for existing context. Done means both options can generate the other while preserving the backward compatibility noted in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.