feat(py)!: Rename package to hugr (#913)

CQCL · Apr 3, 2024 · 9fe65db · 9fe65db
1 parent ff9d786
commit 9fe65db
Show file tree

Hide file tree

Showing 18 changed files with 58 additions and 58 deletions.
diff --git a/.github/workflows/ci-py.yml b/.github/workflows/ci-py.yml
@@ -33,7 +33,7 @@ jobs:
       with:
         filters: |
           python:
-            - 'quantinuum-hugr-py/**'
+            - 'hugr-py/**'
             - 'pyproject.toml'
             - 'specification/schema/**'
 

diff --git a/.github/workflows/python-wheels.yml b/.github/workflows/python-wheels.yml
@@ -15,7 +15,7 @@ jobs:
     strategy:
       matrix:
         package:
-          - 'quantinuum-hugr-py'
+          - 'hugr-py'
 
     steps:
       - uses: actions/checkout@v4

diff --git a/codecov.yml b/codecov.yml
@@ -14,7 +14,7 @@ coverage:
 
 # Ignore tests and binaries
 ignore:
-  - "quantinuum-hugr-py/tests"
+  - "hugr-py/tests"
   - "scripts"
 
 # Coverage groups config

diff --git a/quantinuum-hugr-py/CHANGELOG.md → hugr-py/CHANGELOG.md b/quantinuum-hugr-py/CHANGELOG.md → hugr-py/CHANGELOG.md
diff --git a/quantinuum-hugr-py/README.md → hugr-py/README.md b/quantinuum-hugr-py/README.md → hugr-py/README.md
@@ -1,4 +1,4 @@
-quantinuum_hugr
+hugr
 ===============
 
 [![build_status][]](https://github.com/CQCL/hugr/actions)
@@ -22,9 +22,9 @@ The HUGR specification is [here](https://github.com/CQCL/hugr/blob/main/specific
 
 ## Installation
 
-The package name is `quantinuum_hugr`. It can be installed from PyPI:
+The package name is `hugr`. It can be installed from PyPI:
 ```bash
-pip install quantinuum_hugr
+pip install hugr
 ```
 
 The current releases are in alpha stage, and the API is subject to change.
@@ -48,4 +48,4 @@ This project is licensed under Apache License, Version 2.0 ([LICENSE][] or http:
   [build_status]: https://github.com/CQCL/hugr/actions/workflows/ci-py.yml/badge.svg?branch=main
   [codecov]: https://img.shields.io/codecov/c/gh/CQCL/hugr?logo=codecov
   [LICENSE]: https://github.com/CQCL/hugr/blob/main/LICENCE
-  [CHANGELOG]: https://github.com/CQCL/hugr/blob/main/quantinuum-hugr-py/CHANGELOG.md
+  [CHANGELOG]: https://github.com/CQCL/hugr/blob/main/hugr-py/CHANGELOG.md
diff --git a/quantinuum-hugr-py/pyproject.toml → hugr-py/pyproject.toml b/quantinuum-hugr-py/pyproject.toml → hugr-py/pyproject.toml
@@ -12,7 +12,7 @@ classifiers = [
     "Intended Audience :: Science/Research",
     "Topic :: Scientific/Engineering",
 ]
-name = "quantinuum_hugr"
+name = "hugr"
 version = "0.1.0a1"
 description = "Quantinuum's common representation for quantum programs"
 #keywords = []

diff --git a/...m-hugr-py/src/quantinuum_hugr/__init__.py → hugr-py/src/hugr/__init__.py b/...m-hugr-py/src/quantinuum_hugr/__init__.py → hugr-py/src/hugr/__init__.py
@@ -1,4 +1,4 @@
-"""`quantinuum-hugr` is a Python package for the Quantinuum HUGR common
+"""`hugr` is a Python package for the Quantinuum HUGR common
 representation.
 """
 

diff --git a/...quantinuum_hugr/serialization/__init__.py → hugr-py/src/hugr/serialization/__init__.py b/...quantinuum_hugr/serialization/__init__.py → hugr-py/src/hugr/serialization/__init__.py
diff --git a/.../src/quantinuum_hugr/serialization/ops.py → hugr-py/src/hugr/serialization/ops.py b/.../src/quantinuum_hugr/serialization/ops.py → hugr-py/src/hugr/serialization/ops.py
diff --git a/...ntinuum_hugr/serialization/serial_hugr.py → ...-py/src/hugr/serialization/serial_hugr.py b/...ntinuum_hugr/serialization/serial_hugr.py → ...-py/src/hugr/serialization/serial_hugr.py
diff --git a/.../src/quantinuum_hugr/serialization/tys.py → hugr-py/src/hugr/serialization/tys.py b/.../src/quantinuum_hugr/serialization/tys.py → hugr-py/src/hugr/serialization/tys.py
diff --git a/quantinuum-hugr-py/tests/__init__.py → hugr-py/tests/__init__.py b/quantinuum-hugr-py/tests/__init__.py → hugr-py/tests/__init__.py
diff --git a/...m-hugr-py/tests/serialization/__init__.py → hugr-py/tests/serialization/__init__.py b/...m-hugr-py/tests/serialization/__init__.py → hugr-py/tests/serialization/__init__.py
diff --git a/...hugr-py/tests/serialization/test_basic.py → hugr-py/tests/serialization/test_basic.py b/...hugr-py/tests/serialization/test_basic.py → hugr-py/tests/serialization/test_basic.py
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ name = "hugr-project"
 version = "0.0.0"
 authors = ["TKET development team <tket-support@cambridgequantum.com>"]
 readme = "README.md"
-packages = [{ include = "quantinuum_hugr", from = "quantinuum-hugr-py" }]
+packages = [{ include = "hugr", from = "hugr-py" }]
 package-mode = false
 
 [tool.poetry.group.main.dependencies]
@@ -17,8 +17,8 @@ pytest-cov = "^4.1.0"
 mypy = "^1.9.0"
 ruff = "^0.3.3"
 
-[tool.poetry.group.quantinuum-hugr.dependencies]
-quantinuum-hugr = { path = "quantinuum-hugr-py", develop = true }
+[tool.poetry.group.hugr.dependencies]
+hugr = { path = "hugr-py", develop = true }
 
 [build-system]
 requires = ["poetry-core"]

diff --git a/scripts/generate_schema.py b/scripts/generate_schema.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-"""Dumps the json schema for `quantinuum_hugr.serialization.SerialHugr` to a file.
+"""Dumps the json schema for `hugr.serialization.SerialHugr` to a file.
 
 The schema is written to a file named `hugr_schema_v#.json` in the specified output directory.
 If no output directory is specified, the schema is written to the current working directory.
@@ -13,7 +13,7 @@
 
 from pydantic import TypeAdapter
 
-from quantinuum_hugr.serialization import SerialHugr
+from hugr.serialization import SerialHugr
 
 if __name__ == "__main__":
     if len(sys.argv) == 1:

diff --git a/specification/schema/serialization.md b/specification/schema/serialization.md
@@ -4,7 +4,7 @@ This folder contains the schema for the serialization of the HUGR objects
 compliant with the [JSON Schema](https://json-schema.org/draft/2020-12/release-notes)
 specification.
 
-The model is generated from the pydantic model in the `quantinuum_hugr` python
+The model is generated from the pydantic model in the `hugr` python
 package, and is used to validate the serialization format of the Rust
 implementation.