Metadata-Version: 2.1
Name: github2pypi
Version: 1.0.0
Summary: Utils to release Python project from GitHub to PyPi.
Home-page: https://github.com/wkentaro/github2pypi
Author: Kentaro Wada
Author-email: www.kentaro.wada@gmail.com
License: MIT
Project-URL: Bug Tracker, https://github.com/wkentaro/github2pypi/issues
Keywords: "GitHub Release"
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: !=3.0.*,!=3.1.*,!=3.2.*,>=2.7
Description-Content-Type: text/markdown

<h1 align="center">
  github2pypi
</h1>

<h4 align="center">
  Utils to release Python repository on GitHub to PyPi
</h4>

<div align="center">
  <a href="https://github.com/wkentaro/github2pypi/actions"><img src="https://github.com/wkentaro/github2pypi/workflows/ci/badge.svg"></a>
</div>


## Usage

```bash
pip install github2pypi
```


### 2. Edit `setup.py`.

```python
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


