pypiserver/pypiserver

Documentation for -P is incorrect

Fermée

#261 ouverte le 6 juil. 2019

Voir sur GitHub
 (3 commentaires) (0 réaction) (0 personne assignée)Python (291 forks)batch import
good first issue

Métriques du dépôt

Stars
 (1 663 étoiles)
Métriques de merge PR
 (Merge moyen 3j 18h) (7 PRs mergées en 30 j)

Description

The -P option appears to require no spaces after the P for it to work correctly. I encountered this in my dev Kubernetes instance where I wanted no authentication, and I could not get the server to start with the following CMD:

CMD ["pypi-server", "-p 8080", "-P .", "-a .", "/root/packages"]

However, the following CMD (no space between P and .) worked as expected:

CMD ["pypi-server", "-p 8080", "-P.", "-a .", "/root/packages"]

Then when I deployed the pypi server to my production Kubernetes environment where I want authentication for upload/download, the following CMD caused the server to not start because it could not find the .htaccess file:

CMD ["pypi-server", "-p 8080", "-P /root/packages/.htaccess", "-a update,download", "/root/packages"]

However, when I rebuilt the image with no space between -P and /root/packages/.htaccess, the server started just fine. This is a non-standard behavior for options AFAIK.

The version I'm running is 1.3.0, that is what pip pulled for a docker image based on Ubuntu 18.10.

Guide contributeur

Direction de recherche
Investigate how the P option is parsed in the pypi server command. The issue reports that no space between P and its argument works correctly, but with a space it fails. Check the argument parsing logic in the main script (likely pypiserver/ init .py or similar) and the documentation in README or man page. The fix may involve updating documentation to clarify the no space requirement or modifying the argument parser to handle spaces properly. Look at the CMD examples in the issue and test variations.
Stack technique
python
Domaine
backendcli
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
basic pythonunderstanding of CLI argument parsing
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60