protobuf-protoc-bin 0.0__tar.gz

protobuf_protoc_bin-0.0/.github/workflows/build.yml

@@ -0,0 +1,84 @@
+name: Build wheels
+
+on: push
+
+jobs:
+  build_wheels:
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - run: |
+          python -m pip install -U pip
+          pip install build
+
+      - run: python -m build --wheel -v
+      - if: matrix.os == 'ubuntu-latest'
+        run: python -m build --sdist -v
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist-${{ matrix.os }}
+          retention-days: 1
+          path: dist
+
+  combine_artifacts:
+    name: Combine artifacts
+    needs: build_wheels
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/download-artifact@v4
+      with:  # Download all artifacts so far
+        path: dist
+        merge-multiple: true
+    - uses: actions/upload-artifact@v4
+      with:
+        name: package
+        path: dist
+
+  test_artifacts:
+    name: Test distributions
+    needs: combine_artifacts
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, ubuntu-20.04, macos-latest, macos-13, macos-12, windows-latest]
+    steps:
+      - uses: actions/checkout @v4
+      - uses: actions/download-artifact@v4
+        with:
+          name: package
+          path: dist
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      # Now install the package from the local wheels and try to use it:
+      - run: |
+          pip install --no-index --find-links ./dist protobuf_protoc_bin
+          protoc --version
+          python -m unittest discover tests/
+
+  # Publish to PyPi if tests succeeded and this job is for a pushed tag that starts with 'v'
+  publish:
+    name: Publish distributions
+    needs: test_artifacts
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/v')
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: package
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}

protobuf_protoc_bin-0.0/.gitignore

@@ -0,0 +1,166 @@
+# Custom
+**/_version.py
+*_pb2.*
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Downloads
+resources/
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+.venv*
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+.idea/

protobuf_protoc_bin-0.0/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.1
+Name: protobuf-protoc-bin
+Version: 0.0
+Summary: Pip package to host the protobuf protoc binary
+Author-email: Robert Roos <robert.roos@demcon.com>
+Requires-Python: >=2.7
+Description-Content-Type: text/markdown
+
+# Protobuf Protoc Bin
+
+This Python package is an installer for [protobuf](https://protobuf.dev/)'s `protoc` compiler.
+
+Use this package to install a specific version of `protoc` in your project, without having to figure out the installation externally.
+
+This package is not maintained by or affiliated with the official protobuf group!
+
+This repository does not host any binaries on itself.
+Instead, the binaries are downloaded from the official protobuf Github during package built or during source installation.
+
+## How to install
+
+The package is hosted on PyPi at https://pypi.org/project/protobuf-protoc-bin (WIP).  
+It can be installed via PIP as normal with:
+```shell
+pip install protobuf-protoc-bin
+```
+
+The wheels hosted on PyPi do contain a copy of the protoc releases.
+You can also install this package directly from the Github source.
+During an installation from source, `protoc` will be downloaded fresh from the official Protobuf releases:
+```
+pip install "git+https://github.com/RobertoRoos/protobuf-protoc-bin.git@<tag>"
+```
+(Replacing `<tag>` with a version like `v27.3`.)
+
+## How to require
+
+To require `protoc` only during a build script, include it in your `pyproject.toml` with:
+```
+[build-system]
+requires = [..., "protobuf-protoc-bin==27.3"]
+# ...
+```
+
+Or make it part of an additional install group in your regular environment (with the Poetry backend):
+```
+[tool.poetry.group.dev.dependencies]
+protobuf-protoc-bin = "27.3"
+```

protobuf_protoc_bin-0.0/README.md

@@ -0,0 +1,41 @@
+# Protobuf Protoc Bin
+
+This Python package is an installer for [protobuf](https://protobuf.dev/)'s `protoc` compiler.
+
+Use this package to install a specific version of `protoc` in your project, without having to figure out the installation externally.
+
+This package is not maintained by or affiliated with the official protobuf group!
+
+This repository does not host any binaries on itself.
+Instead, the binaries are downloaded from the official protobuf Github during package built or during source installation.
+
+## How to install
+
+The package is hosted on PyPi at https://pypi.org/project/protobuf-protoc-bin (WIP).  
+It can be installed via PIP as normal with:
+```shell
+pip install protobuf-protoc-bin
+```
+
+The wheels hosted on PyPi do contain a copy of the protoc releases.
+You can also install this package directly from the Github source.
+During an installation from source, `protoc` will be downloaded fresh from the official Protobuf releases:
+```
+pip install "git+https://github.com/RobertoRoos/protobuf-protoc-bin.git@<tag>"
+```
+(Replacing `<tag>` with a version like `v27.3`.)
+
+## How to require
+
+To require `protoc` only during a build script, include it in your `pyproject.toml` with:
+```
+[build-system]
+requires = [..., "protobuf-protoc-bin==27.3"]
+# ...
+```
+
+Or make it part of an additional install group in your regular environment (with the Poetry backend):
+```
+[tool.poetry.group.dev.dependencies]
+protobuf-protoc-bin = "27.3"
+```

protobuf_protoc_bin-0.0/pyproject.toml

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["setuptools", "setuptools-scm", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "protobuf-protoc-bin"
+# Versioning is done dynamically
+description = "Pip package to host the protobuf protoc binary"
+authors = [
+    {name = "Robert Roos", email = "robert.roos@demcon.com"}
+]
+readme = "README.md"
+dynamic = ["version"]
+requires-python = ">=2.7"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+packages = ["protobuf_protoc_bin"]
+
+[tool.setuptools_scm]
+version_file = "src/protobuf_protoc_bin/_version.py"
+# Use the tag directly, without local changes:
+version_scheme = "only-version"
+local_scheme = "no-local-version"

protobuf_protoc_bin-0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

protobuf_protoc_bin-0.0/setup.py

@@ -0,0 +1,162 @@
+import os
+import platform
+import re
+import shutil
+import stat
+import sysconfig
+import urllib.error
+import urllib.request
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+from setuptools import setup
+from setuptools.command.install import install
+from wheel.bdist_wheel import bdist_wheel
+
+
+class CustomInstallCommand(install):
+    """Download `protoc` binary and install with package."""
+
+    PKG_ROOT = Path(__file__).parent.absolute()
+
+    def run(self):
+        install.run(self)  # Avoid `super()` for legacy reasons
+
+        version = self._get_version()
+        plat = self._get_platform()
+
+        base_url = "https://github.com/protocolbuffers/protobuf/releases"
+
+        if version == "0.0":  # Typical for un-tagged CI build
+            print("Finding latest protoc release...")
+            new_url: str = urllib.request.urlopen(f"{base_url}/latest").geturl()
+            _, _, new_version = new_url.rpartition("/")
+            version = new_version.lstrip("v")
+
+        with TemporaryDirectory() as temp_dir:
+            download_dir = Path(temp_dir).absolute()
+            zip_file = download_dir / "protoc.zip"
+            url = f"{base_url}/download/v{version}/protoc-{version}-{plat}.zip"
+            print(f"Downloading {url}...")
+            try:
+                urllib.request.urlretrieve(url, zip_file)
+            except urllib.error.HTTPError as err:
+                raise RuntimeError(
+                    f"Failed to download protoc version `{version}`: " + str(err)
+                )
+
+            shutil.unpack_archive(zip_file, download_dir)
+
+            # Copy binary:
+            bin_filename = "protoc" + (".exe" if "win" in plat.lower() else "")
+            protoc_download_path = download_dir / "bin" / bin_filename
+            protoc_dest = Path(self.install_scripts).absolute() / bin_filename
+            protoc_dest.parent.mkdir(parents=True, exist_ok=True)
+            self.copy_file(
+                str(protoc_download_path),
+                str(protoc_dest),
+            )
+            # Allow executing of new file:
+            os.chmod(
+                protoc_dest,
+                stat.S_IRUSR
+                | stat.S_IWUSR
+                | stat.S_IXUSR
+                | stat.S_IRGRP
+                | stat.S_IXGRP
+                | stat.S_IROTH
+                | stat.S_IXOTH,  # Set to 755 mode
+            )
+
+            # Copy 'include' directory als well
+            # But protoc requires its include/ to be in the folder adjacent to the
+            # binary, not in a regular system include/ folder
+            include_download_path = download_dir / "include"
+            # The 'google' directory will be created in here:
+            include_dest = protoc_dest.parent / "include"
+            include_dest.mkdir(parents=True, exist_ok=True)
+            self.copy_tree(str(include_download_path), str(include_dest))
+
+    def _get_version(self) -> str:
+        """Get current package version (or raise exception)."""
+        with open(
+            self.PKG_ROOT / "src" / "protobuf_protoc_bin" / "_version.py", "r"
+        ) as fh:
+            re_version = re.compile(r'.*version = [\'"](.*)[\'"]')
+            while line := fh.readline():
+                if match := re_version.search(line):
+                    return match.group(1)
+
+        raise RuntimeError(f"Failed to parse version from pyproject.toml")
+
+    @staticmethod
+    def _get_platform() -> str:
+        """Detect necessary platform tag for protoc download.
+
+        See available tags from https://github.com/protocolbuffers/protobuf/releases/latest
+        """
+        system = platform.system().lower()
+        arch = [x.lower() if isinstance(x, str) else x for x in platform.architecture()]
+
+        if system == "windows":
+            if "64bit" in arch:
+                return "win64"
+            return "win32"
+
+        if system == "linux":
+            if "64bit" in arch:
+                return "linux-x86_64"
+            return "linux-x86_32"
+            # Other Linux types are still ignored
+
+        if system == "darwin":
+            if "64bit" in arch:
+                return "osx-x86_64"
+            return "osx-universal_binary"
+
+        raise RuntimeError(
+            f"Could not choose protoc download for system `{system}` ({arch})"
+        )
+
+
+class CustomWheel(bdist_wheel):
+    """Custom command to mark our wheel as platform-specific.
+
+    Without this, all wheels are marked as `None` and are considered platform
+    independent, which is not true as we included a specific `protoc` binary.
+
+    The tag produced here is different from the tag used for `protoc` in
+    :meth:`CustomInstallCommand._get_platform`.
+    """
+
+    def get_tag(self):
+        """
+
+        See https://packaging.python.org/en/latest/specifications/platform-compatibility-tags/
+        """
+        impl_tag = "py2.py3"  # Same wheel across Python versions
+        abi_tag = "none"  # Same wheeel across ABI versions (not a C-extension)
+        # But we need to differentiate on the platform for the compiled adslib:
+        plat_tag = sysconfig.get_platform().replace("-", "_").replace(".", "_")
+
+        if plat_tag.startswith("linux_"):
+            # But the basic Linux prefix is deprecated, use new scheme instead:
+            plat_tag = "manylinux_2_24" + plat_tag[5:]
+
+        # MacOS platform tags area already okay
+
+        # We also keep Windows tags in place, instead of using `any`, to prevent an
+        # obscure Linux platform to getting a wheel without adslib source
+
+        return impl_tag, abi_tag, plat_tag
+
+
+# noinspection PyTypeChecker
+setup(
+    cmdclass={
+        "install": CustomInstallCommand,
+        "bdist_wheel": CustomWheel,
+    }
+)
+
+# Rely on `pyproject.toml` for all other info instead

protobuf_protoc_bin-0.0/src/protobuf_protoc_bin/__init__.py

@@ -0,0 +1,9 @@
+"""
+This is a package placeholder for the `protoc` executable.
+
+No actual Python code is included.
+"""
+
+from ._version import __version__, __version_tuple__
+
+# `_version.py` will be generated by "setuptools_scm"

protobuf_protoc_bin-0.0/src/protobuf_protoc_bin/_version.py

@@ -0,0 +1,16 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple, Union
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.0'
+__version_tuple__ = version_tuple = (0, 0)

protobuf_protoc_bin-0.0/src/protobuf_protoc_bin.egg-info/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.1
+Name: protobuf-protoc-bin
+Version: 0.0
+Summary: Pip package to host the protobuf protoc binary
+Author-email: Robert Roos <robert.roos@demcon.com>
+Requires-Python: >=2.7
+Description-Content-Type: text/markdown
+
+# Protobuf Protoc Bin
+
+This Python package is an installer for [protobuf](https://protobuf.dev/)'s `protoc` compiler.
+
+Use this package to install a specific version of `protoc` in your project, without having to figure out the installation externally.
+
+This package is not maintained by or affiliated with the official protobuf group!
+
+This repository does not host any binaries on itself.
+Instead, the binaries are downloaded from the official protobuf Github during package built or during source installation.
+
+## How to install
+
+The package is hosted on PyPi at https://pypi.org/project/protobuf-protoc-bin (WIP).  
+It can be installed via PIP as normal with:
+```shell
+pip install protobuf-protoc-bin
+```
+
+The wheels hosted on PyPi do contain a copy of the protoc releases.
+You can also install this package directly from the Github source.
+During an installation from source, `protoc` will be downloaded fresh from the official Protobuf releases:
+```
+pip install "git+https://github.com/RobertoRoos/protobuf-protoc-bin.git@<tag>"
+```
+(Replacing `<tag>` with a version like `v27.3`.)
+
+## How to require
+
+To require `protoc` only during a build script, include it in your `pyproject.toml` with:
+```
+[build-system]
+requires = [..., "protobuf-protoc-bin==27.3"]
+# ...
+```
+
+Or make it part of an additional install group in your regular environment (with the Poetry backend):
+```
+[tool.poetry.group.dev.dependencies]
+protobuf-protoc-bin = "27.3"
+```

protobuf_protoc_bin-0.0/src/protobuf_protoc_bin.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+.gitignore
+README.md
+pyproject.toml
+setup.py
+.github/workflows/build.yml
+src/protobuf_protoc_bin/__init__.py
+src/protobuf_protoc_bin/_version.py
+src/protobuf_protoc_bin.egg-info/PKG-INFO
+src/protobuf_protoc_bin.egg-info/SOURCES.txt
+src/protobuf_protoc_bin.egg-info/dependency_links.txt
+src/protobuf_protoc_bin.egg-info/top_level.txt
+tests/example.proto
+tests/test_protoc.py

protobuf_protoc_bin-0.0/src/protobuf_protoc_bin.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

protobuf_protoc_bin-0.0/src/protobuf_protoc_bin.egg-info/top_level.txt

@@ -0,0 +1 @@
+protobuf_protoc_bin

protobuf_protoc_bin-0.0/tests/example.proto

@@ -0,0 +1,10 @@
+syntax = "proto3";
+
+import "google/protobuf/timestamp.proto";
+
+package example;
+
+message MyMessage {
+    google.protobuf.Timestamp my_timestamp = 1;
+    bool my_bool = 2;
+}

protobuf_protoc_bin-0.0/tests/test_protoc.py

@@ -0,0 +1,40 @@
+import subprocess
+import unittest
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+
+class ProtocBasicTests(unittest.TestCase):
+
+    tests_dir = Path(__file__).parent.absolute()
+
+    def test_version(self):
+        """Test basic calling of `protoc` executable."""
+        output = subprocess.run(
+            ["protoc", "--version"], check=True, capture_output=True
+        )
+        self.assertEqual(0, output.returncode)
+        self.assertGreater(len(output.stdout), 5)
+
+    def test_compile(self):
+        """Test compilation with `protoc`."""
+        proto_file = self.tests_dir / "example.proto"
+
+        with TemporaryDirectory() as temp:
+            temp = Path(temp)
+            output = subprocess.run(
+                [
+                    "protoc",
+                    "--proto_path",
+                    str(self.tests_dir),
+                    "--python_out",
+                    str(temp),
+                    proto_file,
+                ],
+                check=True,
+                capture_output=True,
+            )
+            self.assertEqual(0, output.returncode)
+            self.assertFalse(output.stderr)
+            dest_file = temp / "example_pb2.py"
+            self.assertTrue(dest_file.is_file())