pypa / pypa/packaging.python.org
Packaging instructions are not optimal about README.MD
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 1.7k
- Forks
- 1.7k
- Merge moyen
- 3 j 12 h
- PR mergées (30 j)
- 4
Description
Thank you for providing feedback on Python packaging!
To help us help you, please fill out as much of the following as you can. If a question is not relevant, feel free to skip it.
- What is your operating system and version?
MacOS 10.15.3
- What is your Python version?
Python 3.7.3
- What version of pip do you have?
pip 19.0.3
- If following an online tutorial or guide, please provide a link to the page or section giving you trouble:
https://packaging.python.org/tutorials/packaging-projects/#creating-setup-py
- Could you describe your issue in as much detail as possible?
The instructions provide an adagio for a long readme and claim it is normal:
with open("README.md", "r") as fh:
long_description = fh.read()
This however, will only run from the directory containing this file. It is better to construct a path:
here = path.dirname (path.realpath (__file__))
readme = open (path.join (here, 'README.MD')).read ()
Both forms still leave a problem. When setup.py is run during pip install, it will try to open README.md once more, while it is being installed. (This was after uploading an sdist, not a bdist.)
Collecting arpa2.wsgi
Downloading https://files.pythonhosted.org/packages/71/87/fe38499da24d4bfcd04d301aa20a03af35bfdf379e8b739069b8a726af2a/arpa2.wsgi-0.4.0.tar.gz
Complete output from command python setup.py egg_info:
Traceback (most recent call last):
File "<string>", line 1, in <module>
File "/private/var/folders/5_/dsls_kvx7tq171bf6chfm3x80000gn/T/pip-install-zcq3d6v9/arpa2.wsgi/setup.py", line 19, in <module>
readme = open (path.join (here, 'README.MD')).read ()
FileNotFoundError: [Errno 2] No such file or directory: '/private/var/folders/5_/dsls_kvx7tq171bf6chfm3x80000gn/T/pip-install-zcq3d6v9/arpa2.wsgi/README.MD'
As far as I can see, I am not supposed to include the README.MD and it is only needed because of the packaging instruction -- which may be off. Not sure what a good fix would be, otherwise I'd suggest it.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par le tutoriel « Packaging Python Projects » du Packaging User Guide, à la section « Creating setup.py », et examinez l’exemple de README par rapport à l’échec d’installation de sdist signalé. C’est terminé lorsque les instructions expliquent correctement comment README est inclus et peuvent être suivies sans le FileNotFoundError signalé.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 42/100