Merge pull request #3 from FujitsuResearch/feature/pypi

Set up PyPI publishing with Trusted Publishers and GitHub Actions

Author: FKKimura

.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.gitignore

@@ -1,6 +1,8 @@
 *.swp
 __pycache__
 *.egg-info
+dist/
+build/
 models
 .vscode/
 .cursor/rules/benchmark-directory.mdc

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## [v1.0.0] 2026-03-31
 
+### PyPI Publishing Setup
+
+- Added PyPI metadata to `pyproject.toml`: `keywords`, `classifiers`, and `project.urls` (Homepage, Documentation, Repository, Bug Tracker, Changelog)
+- Removed `gemlite` optional-dependency extra that used direct git URLs (PEP 440 violation); equivalent packages are already in main `dependencies`
+- Added `.github/workflows/publish.yml`: automated PyPI publishing via Trusted Publishers (OIDC) on GitHub Release
+- Updated `README.md`: installation command changed from `pip install git+<URL>` to `pip install onecomp`
+- Added `dist/` and `build/` to `.gitignore`
+- Updated `uv.lock`
+
 ### Default Parameter Changes
 
 - Changed `Runner.__init__` default values for calibration parameters:

README.md

@@ -74,7 +74,7 @@ print(torch.cuda.is_available())
 Once PyTorch is installed, you can install `onecomp`:
 
 ```bash
-pip install git+<git repository URL>
+pip install onecomp
 ```
 
 ### for developers (uv : recommended)
@@ -90,7 +90,7 @@ With its Rust-based dependency resolver and the `uv.lock` lockfile, uv provides
 curl -LsSf https://astral.sh/uv/install.sh | sh
 
 git clone <git repository URL>
-cd onecomp
+cd OneCompression
 uv sync --extra cu128 --extra dev
 ```
 
@@ -135,8 +135,8 @@ black --check onecomp/
 
 ```bash
 git clone <git repository URL>
+cd OneCompression
 
-cd onecomp
 # First, install PyTorch with CUDA support for your environment
 pip install torch --index-url https://download.pytorch.org/whl/cu128
 # Then install onecomp with development dependencies

pyproject.toml

@@ -12,6 +12,16 @@ authors = [
     {name = "Keiji Kimura"},
 ]
 requires-python = ">=3.12, <3.14"
+keywords = ["llm", "quantization", "compression", "post-training-quantization", "gptq"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Intended Audience :: Science/Research",
+]
 dependencies = [
     "transformers >= 5.3.0",
     "accelerate",
@@ -25,6 +35,13 @@ dependencies = [
     "ortools>=9.15.6755",
 ]
 
+[project.urls]
+Homepage = "https://github.com/FujitsuResearch/OneCompression"
+Documentation = "https://FujitsuResearch.github.io/OneCompression/"
+Repository = "https://github.com/FujitsuResearch/OneCompression"
+"Bug Tracker" = "https://github.com/FujitsuResearch/OneCompression/issues"
+Changelog = "https://github.com/FujitsuResearch/OneCompression/blob/main/CHANGELOG.md"
+
 [project.scripts]
 onecomp = "onecomp.cli:main"
 
@@ -41,10 +58,6 @@ dev = [
     "pylint",
     "pytest",
 ]
-gemlite = [
-    "gemlite @ git+https://github.com/mobiusml/gemlite.git",
-    "hqq @ git+https://github.com/mobiusml/hqq.git",
-]
 vllm = ["vllm"]
 docs = [
     "mkdocs-material",