Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 9 additions & 15 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

permissions:
contents: read
id-token: write # For Trusted Publisher

jobs:
deploy:
Expand All @@ -20,12 +21,9 @@
with:
fetch-depth: 0
- name: Install uv
uses: astral-sh/setup-uv@v4
uses: astral-sh/setup-uv@v6
with:
enable-cache: true
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
shell: bash
Expand All @@ -45,19 +43,15 @@
uv pip install twine
uv run twine check dist/*
echo "Dry run completed. Package would be published in a release."
# - name: Publish to PyPI
# if: ${{github.event_name == 'release'}}
# shell: bash
# env:
# UV_PUBLISH_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
# run: |
# set -eux
# uv publish
- name: Publish to PyPI
if: ${{github.event_name == 'release'}}
shell: bash
run: |
set -eux
uv publish
- name: Publish to TestPyPI
if: ${{github.event_name == 'workflow_dispatch'}}
shell: bash
env:
UV_PUBLISH_TOKEN: ${{ secrets.TEST_PYPI_API_TOKEN }}
run: |
set -eux
uv publish --publish-url https://test.pypi.org/legacy/ --token $UV_PUBLISH_TOKEN
uv publish --publish-url https://test.pypi.org/legacy/
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ Documentation: https://jij-inc.github.io/OmmxQuantumBenchmarks/

```bash
# Clone and install
git clone https://github.com/Jij-Inc/OmmxQuantumBenchmarks.git
cd OmmxQuantumBenchmarks
pip install -e .
pip install ommx-quantum-benchmarks
```

### Basic Usage
Expand Down
10 changes: 1 addition & 9 deletions docs/en/index.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -82,20 +82,12 @@
"Install this package through pip!\n",
"\n",
"```bash\n",
"# Using uv\n",
"uv pip install git+https://github.com/Jij-Inc/OmmxQuantumBenchmarks.git\n",
"\n",
"# Using pip\n",
"pip install ommx_quantum_benchmarks\n",
"pip install ommx-quantum-benchmarks\n",
"```\n",
"\n",
"Or, you can install it from github, which is arguably the latest version:\n",
"\n",
"```bash\n",
"# Using uv\n",
"uv pip install git+https://github.com/Jij-Inc/OmmxQuantumBenchmarks.git\n",
"\n",
"# Using pip\n",
"pip install git+https://github.com/Jij-Inc/OmmxQuantumBenchmarks.git\n",
"```\n",
"\n",
Expand Down
10 changes: 1 addition & 9 deletions docs/en/quickstart.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,12 @@
"Install this package through pip!\n",
"\n",
"```bash\n",
"# Using uv\n",
"uv pip install git+https://github.com/Jij-Inc/OmmxQuantumBenchmarks.git\n",
"\n",
"# Using pip\n",
"pip install ommx_quantum_benchmarks\n",
"pip install ommx-quantum-benchmarks\n",
"```\n",
"\n",
"Or, you can install it from github, which is arguably the latest version:\n",
"\n",
"```bash\n",
"# Using uv\n",
"uv pip install git+https://github.com/Jij-Inc/OmmxQuantumBenchmarks.git\n",
"\n",
"# Using pip\n",
"pip install git+https://github.com/Jij-Inc/OmmxQuantumBenchmarks.git\n",
"```"
]
Expand Down
10 changes: 1 addition & 9 deletions docs/ja/index.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -82,20 +82,12 @@
"pipを通じてこのパッケージをインストールしてください!\n",
"\n",
"```bash\n",
"# uvを使用\n",
"uv pip install git+https://github.com/Jij-Inc/OmmxQuantumBenchmarks.git\n",
"\n",
"# pipを使用\n",
"pip install ommx_quantum_benchmarks\n",
"pip install ommx-quantum-benchmarks\n",
"```\n",
"\n",
"または、GitHubから直接インストールすることもでき、こちらが最新版となります:\n",
"\n",
"```bash\n",
"# uvを使用\n",
"uv pip install git+https://github.com/Jij-Inc/OmmxQuantumBenchmarks.git\n",
"\n",
"# pipを使用\n",
"pip install git+https://github.com/Jij-Inc/OmmxQuantumBenchmarks.git\n",
"```\n",
"\n",
Expand Down
10 changes: 1 addition & 9 deletions docs/ja/quickstart.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,12 @@
"pipを通じてこのパッケージをインストールしてください!\n",
"\n",
"```bash\n",
"# uvを使用\n",
"uv pip install git+https://github.com/Jij-Inc/OmmxQuantumBenchmarks.git\n",
"\n",
"# pipを使用\n",
"pip install ommx_quantum_benchmarks\n",
"pip install ommx-quantum-benchmarks\n",
"```\n",
"\n",
"または、GitHubから直接インストールすることもでき、こちらが最新版となります:\n",
"\n",
"```bash\n",
"# uvを使用\n",
"uv pip install git+https://github.com/Jij-Inc/OmmxQuantumBenchmarks.git\n",
"\n",
"# pipを使用\n",
"pip install git+https://github.com/Jij-Inc/OmmxQuantumBenchmarks.git\n",
"```"
]
Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ requires = ["setuptools >= 64", "setuptools_scm >= 8", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "ommx_quantum_benchmarks"
name = "ommx-quantum-benchmarks"
dynamic = ["version"]
description = "Quantum Benchmark dataset in OMMX format"
readme = "README.md"
Expand All @@ -21,6 +21,7 @@ packages = ["ommx_quantum_benchmarks"]

[tool.setuptools_scm]
version_file = "ommx_quantum_benchmarks/_version.py"
local_scheme = "no-local-version"

[dependency-groups]
dev = [
Expand Down