Skip to content

Commit f30b65e

Browse files
Add automated PyPI publishing workflow and polish README
- Add GitHub Actions workflow for Trusted Publishing (publish on tag push) - Create missing tags: v0.1.1, v0.1.2 - Update PyPI badge to use shields.io (more reliable) - Add Downloads badge - Add 'Stability & API Guarantees' section for 0.x expectations - Document semantic versioning plan for v1.0+ Workflow will auto-publish to PyPI on future tag pushes. Setup Trusted Publishing at: https://pypi.org/manage/account/publishing/
1 parent f103f5e commit f30b65e

2 files changed

Lines changed: 42 additions & 1 deletion

File tree

.github/workflows/publish.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Publish to PyPI
2+
3+
on:
4+
push:
5+
tags:
6+
- "v*"
7+
8+
permissions:
9+
contents: read
10+
id-token: write
11+
12+
jobs:
13+
build-and-publish:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
18+
- uses: actions/setup-python@v5
19+
with:
20+
python-version: "3.11"
21+
22+
- name: Install build tools
23+
run: python -m pip install -U build
24+
25+
- name: Build package
26+
run: python -m build
27+
28+
- name: Publish to PyPI
29+
uses: pypa/gh-action-pypi-publish@release/v1

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33
**Official Python SDK for [DataSetIQ](https://www.datasetiq.com) — The Modern Economic Data Platform**
44

5-
[![PyPI version](https://badge.fury.io/py/datasetiq.svg)](https://badge.fury.io/py/datasetiq)
5+
[![PyPI version](https://img.shields.io/pypi/v/datasetiq.svg)](https://pypi.org/project/datasetiq/)
66
[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
77
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
8+
[![Downloads](https://img.shields.io/pypi/dm/datasetiq.svg)](https://pypi.org/project/datasetiq/)
89
[![GitHub](https://img.shields.io/github/stars/DataSetIQ/datasetiq-python?style=social)](https://github.com/DataSetIQ/datasetiq-python)
910

1011
---
@@ -356,6 +357,17 @@ ruff check datasetiq tests
356357

357358
---
358359

360+
## 🛡️ Stability & API Guarantees
361+
362+
**Current Status: Beta (0.x versions)**
363+
364+
- **Breaking changes** may occur between minor versions (e.g., 0.1.x → 0.2.x)
365+
- **Core functions** (`get()`, `set_api_key()`) are stable and tested
366+
- **v1.0 release** will follow semantic versioning with backward compatibility guarantees
367+
- Subscribe to [GitHub releases](https://github.com/DataSetIQ/datasetiq-python/releases) for updates
368+
369+
---
370+
359371
## 🗺️ Roadmap
360372

361373
- [ ] Add `get_insight()` for AI-generated analysis

0 commit comments

Comments
 (0)