Start development of v1.0 (#2)

- Add automated dev version upload to pypi
- Get the merge queue ci working
- Pass version info into the pybind module via compiler flags
- Rerun the getting started notebook with an actual pip install

.github/workflows/ci.yml

@@ -19,6 +19,9 @@ on:
       - main
     tags:
       - v*
+  merge_group:
+    branches:
+      - main
   pull_request:
     branches:
       - main
@@ -175,3 +178,17 @@ jobs:
       - run: pip install pytest stim sinter pygltflib
       - run: pytest src
       - run: tools/doctest_proper.py --module chromobius
+  upload_dev_release_to_pypi:
+    needs: ["build_dist"]
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/download-artifact@v2
+        with:
+          name: dist
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          packages_dir: dist/
+          password: ${{ secrets.pypi_token_chromobius }}

BUILD

@@ -95,6 +95,7 @@ cc_binary(
         "-std=c++20",
         "-fvisibility=hidden",
         "-DNDEBUG",
+        "-DVERSION_INFO=0.0.dev0",
     ],
     includes = ["src/"],
     linkshared = 1,

doc/chromobius.pyi

@@ -9,6 +9,7 @@ if TYPE_CHECKING:
     import stim
     import sinter
     import chromobius
+__version__: str
 class CompiledDecoder:
     """A chromobius decoder ready to predict observable flips from detection events.
 

setup.py

@@ -51,6 +51,7 @@ def build_extension(self, ext):
             ext.sourcedir,
             f"-DCMAKE_LIBRARY_OUTPUT_DIRECTORY={pathlib.Path(self.get_ext_fullpath(ext.name)).parent.absolute()}",
             f"-DPYTHON_EXECUTABLE={sys.executable}",
+            f"-DVERSION_INFO={__version__}",
             *osx_cmake_flags,
             *[
                 env_arg_item
@@ -70,7 +71,7 @@ def build_extension(self, ext):
         ], cwd=build_temp, env=build_env)
 
 
-__version__ = '0.0.dev0'
+__version__ = '1.0.dev0'
 
 with open("README.md", "r", encoding="utf-8") as f:
     long_description = f.read()

src/chromobius/pybind/chromobius.pybind.cc

@@ -22,6 +22,9 @@
 
 #include "stim.h"
 
+#define str_literal(s) #s
+#define xstr_literal(s) str_literal(s)
+
 struct CompiledDecoder {
     chromobius::Decoder decoder;
     uint64_t num_detectors;
@@ -119,7 +122,7 @@ struct CompiledDecoder {
 };
 
 PYBIND11_MODULE(chromobius, m) {
-    m.attr("__version__") = "0.0.dev0";
+    m.attr("__version__") = xstr_literal(VERSION_INFO);
     m.doc() = R"pbdoc(
         chromobius: A fast implementation of the mobius color code decoder.
     )pbdoc";

src/chromobius/pybind/chromobius_pybind_test.py

@@ -19,6 +19,10 @@
 import chromobius
 
 
+def test_version():
+    assert chromobius.__version__ is not None
+
+
 def test_errors():
     with pytest.raises(ValueError, match='must be a stim.DetectorErrorModel'):
         chromobius.compile_decoder_for_dem(object())

tools/gen_chromobius_stub_file.py

@@ -28,6 +28,7 @@ def main():
     import stim
     import sinter
     import chromobius
+__version__: str
 '''.strip())
 
     for obj in generate_documentation(obj=chromobius, full_name="chromobius", level=-1):