https://github.com/louis70109/github_action_python_package_example

Python package template for GitHub Action
https://github.com/louis70109/github_action_python_package_example

github github-actions pypi-package python python-sdk

Last synced: about 2 months ago
JSON representation

Python package template for GitHub Action

• Host: GitHub
• URL: https://github.com/louis70109/github_action_python_package_example
• Owner: louis70109
• License: mit
• Created: 2021-02-05T06:06:20.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-08-31T06:18:32.000Z (almost 4 years ago)
• Last Synced: 2025-04-09T11:51:12.363Z (about 2 months ago)
• Topics: github, github-actions, pypi-package, python, python-sdk
• Language: Python
• Homepage: https://nijialin.com/2021/02/11/how-to-use-github-action/
• Size: 31.3 KB
• Stars: 5
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [GitHub Action Python Example](https://pypi.org/project/GitHub-Action-Python-Example/)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/louis70109/line-notify#contributing)

This is a GitHub Action example for an auto publish PyPi package and test automation.

## Setup PyPi property

- Go to [PyPi](https://pypi.org/) ➡️ Your project ➡️ Account Setting.

![](https://nijialin.com/images/2021/action/token1.png)

- Create an API token.

  - Note: If you just first time create the token, need to select **all project** at Scope.

![](https://nijialin.com/images/2021/action/token2.png)

- You would find **username** and **password**.

- Setup **PYPI_USERNAME** and **PYPI_PASSWORD** in GitHub `Setting` ➡️ `Secrets`.

- Click _New repository secret_ and add two property.

![](https://nijialin.com/images/2021/action/token3.png)

- Modify `GitHub_Action_Python_Example/__version__.py` version number(e.g. 1.0.2).

- Click and draft `Release` note.

![](https://nijialin.com/images/2021/action/release1.png)

- `.github/workflows/publish.yml` will help you to publish package to PyPi.

![](https://nijialin.com/images/2021/action/release4.png)

## Install package

```

pip install GitHub-Action-Python-Example

```

```python

from GitHub_Action_Python_Example.client import HelloWorld

message = HelloWorld(message="Change the World~")

print(message.get_message())

```

# License

[MIT](https://github.com/louis70109/line-notify/blob/master/LICENSE) © [NiJia Lin](https://nijialin.com/about/)