openapi-generators / openapi-generators/openapi-python-client

Calling the generator from cli works with different syntax from documentation

Ouverte
#1,260 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Python
Étoiles
2k
Forks
293
Merge moyen
34 min
PR mergées (30 j)
1

Description

Describe the bug

Calling from cli using the suggested method with python -m does not work.

python -m openapi-python-client --version
PATH_TO_PYTHON\python.exe: No module named openapi-python-client

Using underscores, however, does work (python -m openapi_python_client -version):

python -m openapi_python_client --version
openapi-python-client version: 0.24.3

OpenAPI Spec File

Not applicable

Desktop (please complete the following information):

  • OS: Windows 11 (Microsoft Windows NT 10.0.26100.0)
  • Python Version: [e.g. 3.12.7]
  • openapi-python-client version [e.g. 0.24.3]

Additional context

Running from a powershell instance in VSCode with a conda environment selected as a Python interpreter.

Would it be possible to add a line to the documentation mentioning the call with python -m?

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez à l’emplacement du README indiqué dans l’issue et comparez son invocation documentée de python -m avec la forme fonctionnelle utilisant un underscore présentée dans le rapport. Vérifiez la commande dans le contexte CLI du projet, puis mettez à jour la documentation afin que l’invocation prise en charge soit explicite et cohérente. Le travail est terminé lorsqu’un nouveau contributeur peut exécuter avec succès la commande du README.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
cli, documentation
Type d'issue
Documentation
Difficulté
1/5
Temps estimé
Moins d'une heure
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
58/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.