Skip to content

Commit ddd8dae

Browse files
committed
Configure rfmodal fork for PyPI publishing with Trusted Publishing
1 parent 5acbbdf commit ddd8dae

File tree

4 files changed

+118
-16
lines changed

4 files changed

+118
-16
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Publish rfmodal to PyPI
2+
3+
on:
4+
push:
5+
tags:
6+
- "v*"
7+
workflow_dispatch:
8+
release:
9+
types: [created]
10+
11+
permissions:
12+
contents: read
13+
14+
jobs:
15+
publish:
16+
name: Publish to PyPI
17+
runs-on: ubuntu-latest
18+
environment:
19+
name: release
20+
url: https://pypi.org/project/rfmodal/
21+
permissions:
22+
id-token: write # Required for OIDC/Trusted Publishing
23+
contents: read
24+
steps:
25+
- name: 🛎️ Checkout
26+
uses: actions/checkout@v4
27+
28+
- name: 🐍 Set up Python
29+
uses: actions/setup-python@v5
30+
with:
31+
python-version: '3.10'
32+
33+
- name: 📦 Install build dependencies
34+
run: |
35+
python -m pip install --upgrade pip
36+
pip install build twine
37+
38+
- name: 🏗️ Build package
39+
run: |
40+
python -m build
41+
twine check dist/*
42+
43+
- name: 🚀 Publish to PyPI
44+
uses: pypa/gh-action-pypi-publish@release/v1
45+
with:
46+
attestations: true
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Publish rfmodal to TestPyPI
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches: [ main ]
7+
paths:
8+
- 'pyproject.toml'
9+
- 'modal/**'
10+
- 'modal_version/**'
11+
- 'modal_proto/**'
12+
13+
permissions:
14+
contents: read
15+
16+
jobs:
17+
publish-test:
18+
name: Publish to TestPyPI
19+
runs-on: ubuntu-latest
20+
environment:
21+
name: testpypi
22+
url: https://test.pypi.org/project/rfmodal/
23+
permissions:
24+
id-token: write # Required for OIDC/Trusted Publishing
25+
contents: read
26+
steps:
27+
- name: 🛎️ Checkout
28+
uses: actions/checkout@v4
29+
30+
- name: 🐍 Set up Python
31+
uses: actions/setup-python@v5
32+
with:
33+
python-version: '3.10'
34+
35+
- name: 📦 Install build dependencies
36+
run: |
37+
python -m pip install --upgrade pip
38+
pip install build twine
39+
40+
- name: 🏗️ Build package
41+
run: |
42+
python -m build
43+
twine check dist/*
44+
45+
- name: 🚀 Publish to TestPyPI
46+
uses: pypa/gh-action-pypi-publish@release/v1
47+
with:
48+
repository-url: https://test.pypi.org/legacy/
49+
attestations: true

README.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
1-
# Modal Python Library
1+
# RFModal - Roboflow Fork of Modal Python Library
2+
3+
This is a Roboflow fork of the [Modal Python library](https://github.com/modal-labs/modal-client).
4+
5+
## Fork Information
6+
7+
- **Original Package**: [modal](https://pypi.org/project/modal/)
8+
- **Original Author**: Modal Labs
9+
- **Fork Maintainer**: Roboflow, Inc.
10+
- **PyPI Package**: `rfmodal`
11+
12+
---
13+
14+
# Original README: Modal Python Library
215

316
[![PyPI Version](https://img.shields.io/pypi/v/modal.svg)](https://pypi.org/project/modal/)
417
[![License](https://img.shields.io/badge/license-apache_2.0-darkviolet.svg)](https://github.com/modal-labs/modal-client/blob/master/LICENSE)
@@ -19,20 +32,14 @@ a [user guide](https://modal.com/docs/guide), and the detailed
1932

2033
**This library requires Python 3.9 – 3.13.**
2134

22-
Install the package with `pip`:
23-
24-
```bash
25-
pip install modal
26-
```
27-
28-
You can create a Modal account (or link your existing one) directly on the
29-
command line:
35+
Install the Roboflow fork:
3036

31-
```bash
32-
python3 -m modal setup
37+
```shell
38+
pip install rfmodal
3339
```
3440

35-
## Support
41+
## Developing
3642

37-
For usage questions and other support, please reach out on the
38-
[Modal Slack](https://modal.com/slack).
43+
See the
44+
[contributing guide](https://github.com/modal-labs/modal-client/blob/main/CONTRIBUTING.md)
45+
for instructions on setting up a development environment.

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ requires = ["setuptools~=77.0.3", "wheel"]
33
build-backend = "setuptools.build_meta"
44

55
[project]
6-
name = "modal"
7-
description = "Python client library for Modal"
6+
name = "rfmodal"
7+
description = "Roboflow fork of Modal Python client library"
88
readme = "README.md"
99
dynamic = ["version"]
1010
requires-python = ">=3.9"

0 commit comments

Comments
 (0)