Comment faire fonctionner la description Markdown de PyPi ?

J'ai téléchargé un package sur PyPi en utilisant :

python setup.py register -r pypi
python setup.py sdist upload -r pypi

J'essaie de modifier la description, j'ai écrit ( veuillez ne pas modifier la mise en forme du morceau de code suivant, je l'ai fait exprès pour illustrer mon problème ):

**my plugin**
This plugin enables you to... For example:
```python
@attr(section='MySection', id=1)
def test_function(self):
 """
 Bla bla bla
 """
 pass
```

Cependant, le texte apparaît tel quel, sans la mise en forme Markdown. Qu'est-ce que je fais mal?


Solution du problème

Depuis le 16 mars 2018, PyPI.org alias Warehouse prend (enfin) en charge Markdown dans les descriptions longues. Warehouse a remplacé l'ancienne implémentation PyPI héritée en avril 2018.

Vous devez:


  • Assurez-vous qu'il setuptoolsest mis à niveau vers la version 38.6.0 ou une version plus récente


  • Assurez-vous qu'il twineest mis à niveau vers la version 1.11.0 ou une version plus récente


  • Assurez-vous qu'il wheelest mis à niveau vers la version 0.31.0 ou une version plus récente


  • Ajoutez un nouveau champ nommé long_description_content_typeà votre setup()appel, et réglez-le sur'text/markdown' :

    setup(
     long_description="""# Markdown supported!\n\n* Cheer\n* Celebrate\n""",
     long_description_content_type='text/markdown',
     #....
    )

    Voir PEP 566 - Métadonnées pour les progiciels Python 2.1.


  • Utilisez twinepour télécharger vos distributions sur PyPI :

    $ python setup.py sdist bdist_wheel # adjust as needed
    $ twine upload dist/*


L'ancienne infrastructure PyPI héritée ne rendrait pas Markdown, seule la nouvelle infrastructure Warehouse le fait. L'infrastructure héritée a maintenant disparu (au 30/04/2018).

Actuellement, PyPI utilise cmarkgfmcomme moteur de rendu Markdown, via la readme_rendererbibliothèque (utilisant readme_renderer.markdown.render(long_description)pour produire une sortie HTML). Cela signifie que vos documents de démarquage s'afficheront exactement de la même manière que sur GitHub ; c'est essentiellement le même moteur de rendu.

Vous pouvez valider votre package long_descriptionavec la twine checkcommande ( twine1.12.0 ou plus récent).

L'ancienne réponse <2018-03-16 suit ci-dessous.

Note: this is the old, now outdated answer, as of 2018-03-16 Markdown is supported provided you use the right tools, see above.

PyPI does not support Markdown, so your README will not be rendered into HTML.

Si vous voulez un README rendu, restez avec reStructuredText; l' introduction de Sphinx à reStructuredText est un bon point de départ.

Vous souhaitez probablement installer le docutilspackage afin de pouvoir tester votre document localement; vous voulez exécuter le rst2html.pyscript inclus sur votre README pour voir quelles erreurs sont produites, le cas échéant. Votre échantillon spécifique contient trop d'erreurs :

$ bin/rst2html.py test.rst > /tmp/test.html
test.rst:7: (ERROR/3) Unexpected indentation.
test.rst:3: (WARNING/2) Inline literal start-string without end-string.
test.rst:3: (WARNING/2) Inline interpreted text or phrase reference start-string without end-string.
test.rst:11: (WARNING/2) Block quote ends without a blank line; unexpected unindent.
test.rst:11: (WARNING/2) Inline literal start-string without end-string.
test.rst:11: (WARNING/2) Inline interpreted text or phrase reference start-string without end-string.

Votre bloc de code utilise les extensions Markdown de Github, qui sont totalement fausses pour reStructuredText. Vous pouvez utiliser un bloc de code reST (probablement, si la version PyPI de docutils est suffisamment récente):

.. code-block:: python
 @attr(section='MySection', type='functional+', module='MyModule', id=1)
 def test_function(self):
 """
 This is the original docstring
 """
 pass

Pour tester cela localement, vous devrez également installer Pygments.

Il existe une demande de fonctionnalité avec une demande d'extraction pour ajouter la prise en charge de Markdown, si vous êtes intéressé.

Commentaires

Enregistrer un commentaire

Posts les plus consultés de ce blog

Erreur Symfony : "Une exception a été levée lors du rendu d'un modèle"

j'essaie d'inclure <link href="{{ asset('css/mystyle.css') }}" rel="stylesheet"/> dans mon fichier twig et le rendre. Mais cela me donne une exception PHP non interceptée Twig_Error_Runtime : "Une exception a été levée lors du rendu d'un modèle ("Le fichier manifeste de l'actif "/../public/build/manifest.json" n'existe pas.") ça marche quand j'utilise link href="css/mystyle.css" rel="stylesheet"/> . Voici mon contrôleur: <?php namespace App\Controller; use Symfony\Component\Routing\Annotation\Route; use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; use Symfony\Component\HttpFoundation\Response; class WelcomeController extends AbstractController { /** * @Route("/", name="welcome") */ public function index() { return $this->render('welcome/index.html.twig'); } } Voici mon modèle de brindille : <!doctype html> ...
Lire la suite

Détecter les appuis sur les touches fléchées en JavaScript

Comment détecter l'appui sur l'une des touches fléchées ? J'en ai profité pour savoir: function checkKey(e) { var event = window.event? window.event: e; console.log(event.keyCode) } Bien que cela fonctionnait pour toutes les autres touches, ce n'était pas le cas pour les touches fléchées (peut-être parce que le navigateur est censé faire défiler ces touches par défaut). Solution du problème event.key === "Flèche droite"... Plus récent et beaucoup plus propre: utilisez event.key . Plus de codes numériques arbitraires ! Si vous transpilez ou savez que vos utilisateurs utilisent tous des navigateurs modernes, utilisez ceci ! node.addEventListener('keydown', function(event) { const key = event.key; // "ArrowRight", "ArrowLeft", "ArrowUp", or "ArrowDown" }); Gestion détaillée : switch (event.key) { case "ArrowLeft": // Left pressed break; case "ArrowRight": // Right pressed break; c...
Lire la suite

Une chaîne vide donne "Des erreurs ont été détectées dans les arguments de la ligne de commande, veuillez vous assurer que tous les arguments sont correctement définis"

Image
Sur un serveur SQL 2016, j'ai un travail qui appelle un package SSIS. Ce package se trouve dans un projet dans la SSISDB et a des paramètres. L'un de ces paramètres est un type de chaîne vide par défaut. J'ai exécuté le travail avec la valeur vide pour ce paramètre, et il s'est exécuté avec succès. J'ai ensuite ouvert les propriétés du travail, je suis allé à l'étape qui appelle ce package et je suis entré dans la configuration et j'ai donné une valeur à ce paramètre. J'ai exécuté à nouveau le travail et il s'est exécuté avec succès, et la valeur du paramètre a eu l'effet attendu sur les résultats. Maintenant, je veux modifier le travail et redéfinir le paramètre sur une chaîne vide. En répétant ce que j'ai fait ci-dessus, j'ouvre la configuration et supprime complètement la valeur du paramètre. Lorsque j'essaie ensuite d'enregistrer les propriétés de l'étape du travail, j'obtiens une boîte de dialogue d'erreur a...
Lire la suite