Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/asifarmanrahman/to-pypi-using-flit

An action to build and publish Python 🐍 package to PyPI using Flit.
https://github.com/asifarmanrahman/to-pypi-using-flit

actions automation flit github-actions pypi pypi-package pypi-packages python release release-automation workflow workflows

Last synced: 3 months ago
JSON representation

An action to build and publish Python 🐍 package to PyPI using Flit.

Host: GitHub
URL: https://github.com/asifarmanrahman/to-pypi-using-flit
Owner: AsifArmanRahman
License: mit
Created: 2022-07-09T02:54:12.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-07-18T08:26:09.000Z (over 2 years ago)
Last Synced: 2024-09-17T00:45:46.842Z (4 months ago)
Topics: actions, automation, flit, github-actions, pypi, pypi-package, pypi-packages, python, release, release-automation, workflow, workflows
Homepage: https://github.com/marketplace/actions/to-pypi-using-flit
Size: 3.91 KB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# to-pypi-using-flit
An action to build and publish Python 🐍 packages to PyPI using Flit.

## Usage

To use the action add the following step to your workflow file (e.g. .github/workflows/main.yml)

### Example Workflow

```yaml
name: publish

# Controls when the workflow will run
on:

# Workflow will run when a release has been published for the package
release:
types:
- published

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:

# This workflow contains a single job called "publish"
publish:

# The type of runner that the job will run on
runs-on: ubuntu-latest

# Steps represent a sequence of tasks that will be executed as part of the job
steps:

# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v3

- name: Set up Python 3.9
uses: actions/setup-python@v3
with:
python-version: 3.9
cache: pip

- name: To PyPI using Flit
uses: AsifArmanRahman/to-pypi-using-flit@v1
with:
password: ${{ secrets.PYPI_API_TOKEN }}

```

> **_The action assume:_**
> * The project has a `pyproject.toml` (or `setup.py`) in the top-level directory.
> * Python and pip are installed.

### To use with PyPI API token

```yaml
- name: To PyPI using Flit
uses: AsifArmanRahman/to-pypi-using-flit@v1
with:
password: ${{ secrets.PYPI_API_TOKEN }}
```

### To use with PyPI Username and Password

```yaml
- name: To PyPI using Flit
uses: AsifArmanRahman/to-pypi-using-flit@v1
with:
user-name: ${{ secrets.PYPI_USERNAME }}
password: ${{ secrets.PYPI_PASSWORD }}
```

### To use with TestPyPI API token

```yaml
- name: To PyPI using Flit
uses: AsifArmanRahman/to-pypi-using-flit@v1
with:
password: ${{ secrets.TESTPYPI_API_TOKEN }}
repository-url: https://test.pypi.org/legacy/
```

### To use with TestPyPI Username and Password

```yaml
- name: To PyPI using Flit
uses: AsifArmanRahman/to-pypi-using-flit@v1
with:
user-name: ${{ secrets.TESTPYPI_USERNAME }}
password: ${{ secrets.TESTPYPI_PASSWORD }}
repository-url: https://test.pypi.org/legacy/
```

---

## Inputs

---

## License

The source code for this project is released under the [MIT License](/LICENSE). This project is not associated with GitHub.