PyPi 설명 인하가 내가 사용 PyPi에 패키지를 업로드

Question

작동하지 않습니다

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

내가 decsription을 수정하기 위해 노력하고있어, 나는 다음과 같은 코드 조각의 서식을 편집하지 마십시오 (썼다 내가) 내 문제를 설명하는 목적에서 만들어 : 그대로

**nose-docstring-plugin** 

This plugin enables you to modify docstring of tests based on their attributes, for example: 
```python 
@attr(section='MySection', type='functional+', module='MyModule', id=1) 
def test_function(self): 
    """ 
    This is the original docstring 
    """ 
    pass 
``` 

그러나, 텍스트가 나타납니다 을 Markdown을 형식없이. 내가 도대체 ​​뭘 잘못하고있는 겁니까?

Answer 1

PyPI는 이 아니며은 Markdown을 지원하므로 README는 HTML로 렌더링되지 않습니다.

렌더링 된 README를 원하면 reStructuredText를 사용하십시오. Sphinx introduction to reStructuredText은 좋은 출발점입니다.

docutils package을 설치하여 문서를 로컬에서 테스트 할 수 있습니다. README에 포함 된 rst2html.py 스크립트를 실행하여 어떤 오류가 발생했는지 확인하십시오. 특정 샘플의 오류가 너무 많습니다.

$ 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. 

코드 블록이 Github의 Markdown 확장 프로그램을 사용하고 있는데, 이는 reStructuredText에서 완전히 잘못되었습니다. (docutils의 PyPI 버전은 충분히 새로운 경우 아마도) 당신은 나머지 코드 블록을 사용할 수

.. code-block:: python 

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

당신이뿐만 아니라 Pygments을 설치해야합니다 로컬이를 테스트합니다.

관심이 있으시면 Markdown에 대한 지원을 추가 하시려면 feature request with pull request이 있습니다.

Answer 2

@Martijn Pieters으로 명시된 바와 같이 PyPi은 Markdown을 지원하지 않습니다. 다음 트릭을 어디에서 배웠는지 모르겠지만, PyPi에 업로드하기 전에 Pandoc과 PyPandoc을 사용하여 Markdown 파일을 RestructuredText로 변환 할 수 있습니다. 이를 위해, 당신의 setup.py 파일에 다음을 추가

try: 
    import pypandoc 
    long_description = pypandoc.convert('README.md', 'rst') 
except(IOError, ImportError): 
    long_description = open('README.md').read() 

setup(
    name='blah', 
    version=find_version('blah.py'), 
    description='Short description', 
    long_description=long_description, 
) 

은 OS X에 Pandoc를 설치하려면, 내가 Homebrew을 사용 :

pip install pypandoc 

:

brew install pandoc 

이 PyPandoc를 설치하려면, 나는 pip 사용

Answer 3

\r 문자로 문제가 발생하여 구문 분석 문제가 발생합니다. e README가 pypi에 나타납니다. 아래의 코드는 그것이 pypandoc 모듈 저장소에서 오는 문제를 해결

try: 
    long_description = pypandoc.convert('README.md', 'rst') 
    long_description = long_description.replace("\r","") # Do not forget this line 
except OSError: 
    print("Pandoc not found. Long_description conversion failure.") 
    import io 
    # pandoc is not installed, fallback to using raw contents 
    with io.open('README.md', encoding="utf-8") as f: 
     long_description = f.read() 

이 방법 long_description은 추가 정보의 소각 버전을 포함 당신은 당신의 setup.py 스크립트에서 설정() 함수에 전달할 수 있습니다.

Answer 4

다른 답변에서 언급 한 것처럼 PyPI는 첫 번째를 지원하며 마크 다운을 지원하지 않습니다. 하지만 pypandoc perse이 필요하지 않습니다. 단지 pandoc이 좋습니다. 먼저 로컬에서 첫 번째 파일을 생성 한 다음 설치 프로그램을 실행할 수 있습니다.py를 사용하여 패키지를 업로드하십시오.

upload.sh

: README라는 이름의 생성 된 파일을 자동으로 인식됩니다

#!/bin/bash 
pandoc --from=markdown --to=rst --output=README README.md 
python setup.py sdist upload 

. .gitignore에 반드시 추가하십시오! setup.py은 특별한 작업을 수행 할 필요가 없습니다.

setup.py

는 :

from distutils.core import setup 

setup(
    name='mypackage', 
    packages=['mypackage'], # this must be the same as the name above 
    version='0.2.8', 
    description='short', 
    author='Chiel ten Brinke', 
    author_email='<email>', 
    url='<github url>', # use the URL to the github repo 
    keywords=[], # arbitrary keywords 
    classifiers=[], 
) 

은 그럼 그냥 PyPI에 물건을 업로드 bash upload.sh를 실행합니다.

Answer 5

지금 내 설정에 그것을 사용하고

https://pypi.python.org/pypi/restructuredtext_lint/

나를 위해 일한 좋은 PIP 패키지가있다 : 나는을 만든

https://github.com/pablodav/burp_server_reports/blob/master/setup.py 또한

def check_readme(file='README.rst'): 
""" 
Checks readme rst file, to ensure it will upload to pypi and be formatted correctly. 
:param file: 
:return: 
""" 
errors = rst_lint.lint_file(file) 
if errors: 
    msg = 'There are errors in {}, errors \n {}'.format(file, errors[0].message) 
    raise SystemExit(msg) 
else: 
    msg = 'No errors in {}'.format(file) 
print(msg) 

은 나중에 py.test에서 사용할 수있는 lib

https://github.com/pablodav/burp_server_reports/blob/master/burp_reports/lib/check_readme.py