github2pypi

Utils to release Python repository on GitHub to PyPi

Usage

1. Install github2pypi.

pip install github2pypi

2. Edit setup.py.

import github2pypi

...
with open('README.md') as f:
    # e.g., ![](examples/image.jpg) ->
    #       ![](https://github.com/wkentaro/imgviz/blob/main/examples/image.jpg)
    long_description = github2pypi.replace_url(
        slug='wkentaro/imgviz', content=f.read(), branch="main"
    )

setup(
    ...
    long_description=long_description,
    long_description_content_type='text/markdown',
)

Examples

• https://github.com/wkentaro/labelme
• https://github.com/wkentaro/imgviz