plexus-python-protobuf-setup 1.0.3__tar.gz → 1.0.5__tar.gz

{plexus_python_protobuf_setup-1.0.3 → plexus_python_protobuf_setup-1.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plexus-python-protobuf-setup
-Version: 1.0.3
+Version: 1.0.5
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12

plexus_python_protobuf_setup-1.0.5/README.md

@@ -0,0 +1,29 @@
+# Plexus Python Protocol Buffer Setup Module
+
+[![codecov](https://codecov.io/gh/ruyangshou/plexus-python-protobuf-setup/graph/badge.svg?token=J4rQVKXeRx)](
+https://codecov.io/gh/ruyangshou/plexus-python-protobuf-setup)
+
+## Usage
+
+1. **Modify the `pyproject.toml` file** as follows:
+    ```toml
+    [build-system]
+    requires = [
+        "setuptools>=68.0",
+        "setuptools-scm>=8.0",
+        "plexus-python-protobuf-setup>=1.0"  # This is required
+    ]
+    ```
+2. **Use this tool in your `setup.py` script**:
+    ```python
+    import os
+    from setuptools import setup
+    from plexus.protobuf.setup import compile_protos
+   
+    # Call this code generation before setup
+    compile_protos(out_dir,
+                   proto_dirs,
+                   include_dirs,
+                   descriptor_path=os.path.join(out_dir, "descriptor.proto"))
+    setup()
+    ```

{plexus_python_protobuf_setup-1.0.3 → plexus_python_protobuf_setup-1.0.5}/src/plexus_python_protobuf_setup.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plexus-python-protobuf-setup
-Version: 1.0.3
+Version: 1.0.5
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12

plexus_python_protobuf_setup-1.0.5/src/plexus_python_protobuf_setup.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+MANIFEST.in
+README.md
+VERSION
+pyproject.toml
+setup.py
+src/plexus/protobuf/setup/__init__.py
+src/plexus_python_protobuf_setup.egg-info/PKG-INFO
+src/plexus_python_protobuf_setup.egg-info/SOURCES.txt
+src/plexus_python_protobuf_setup.egg-info/dependency_links.txt
+src/plexus_python_protobuf_setup.egg-info/not-zip-safe
+src/plexus_python_protobuf_setup.egg-info/requires.txt
+src/plexus_python_protobuf_setup.egg-info/top_level.txt

plexus_python_protobuf_setup-1.0.3/.editorconfig

@@ -1,80 +0,0 @@
-root = true
-
-[*.py]
-charset = utf-8
-end_of_line = lf
-insert_final_newline = true
-trim_trailing_whitespace = true
-indent_style = space
-indent_size = 4
-
-ij_python_align_collections_and_comprehensions = true
-ij_python_align_multiline_imports = true
-ij_python_align_multiline_parameters = true
-ij_python_align_multiline_parameters_in_calls = true
-ij_python_blank_line_at_file_end = true
-ij_python_blank_lines_after_imports = 1
-ij_python_blank_lines_after_local_imports = 0
-ij_python_blank_lines_around_class = 1
-ij_python_blank_lines_around_method = 1
-ij_python_blank_lines_around_top_level_classes_functions = 2
-ij_python_blank_lines_before_first_method = 0
-ij_python_call_parameters_new_line_after_left_paren = false
-ij_python_call_parameters_right_paren_on_new_line = false
-ij_python_call_parameters_wrap = normal
-ij_python_dict_alignment = 0
-ij_python_dict_new_line_after_left_brace = false
-ij_python_dict_new_line_before_right_brace = false
-ij_python_dict_wrapping = 1
-ij_python_from_import_new_line_after_left_parenthesis = false
-ij_python_from_import_new_line_before_right_parenthesis = false
-ij_python_from_import_parentheses_force_if_multiline = false
-ij_python_from_import_trailing_comma_if_multiline = false
-ij_python_from_import_wrapping = 1
-ij_python_hang_closing_brackets = false
-ij_python_keep_blank_lines_in_code = 1
-ij_python_keep_blank_lines_in_declarations = 1
-ij_python_keep_indents_on_empty_lines = false
-ij_python_keep_line_breaks = true
-ij_python_method_parameters_new_line_after_left_paren = false
-ij_python_method_parameters_right_paren_on_new_line = false
-ij_python_method_parameters_wrap = normal
-ij_python_new_line_after_colon = false
-ij_python_new_line_after_colon_multi_clause = true
-ij_python_optimize_imports_always_split_from_imports = false
-ij_python_optimize_imports_case_insensitive_order = false
-ij_python_optimize_imports_join_from_imports_with_same_source = false
-ij_python_optimize_imports_sort_by_type_first = true
-ij_python_optimize_imports_sort_imports = true
-ij_python_optimize_imports_sort_names_in_from_imports = true
-ij_python_space_after_comma = true
-ij_python_space_after_number_sign = true
-ij_python_space_after_py_colon = true
-ij_python_space_before_backslash = true
-ij_python_space_before_comma = false
-ij_python_space_before_for_semicolon = false
-ij_python_space_before_lbracket = false
-ij_python_space_before_method_call_parentheses = false
-ij_python_space_before_method_parentheses = false
-ij_python_space_before_number_sign = true
-ij_python_space_before_py_colon = false
-ij_python_space_within_empty_method_call_parentheses = false
-ij_python_space_within_empty_method_parentheses = false
-ij_python_spaces_around_additive_operators = true
-ij_python_spaces_around_assignment_operators = true
-ij_python_spaces_around_bitwise_operators = true
-ij_python_spaces_around_eq_in_keyword_argument = false
-ij_python_spaces_around_eq_in_named_parameter = false
-ij_python_spaces_around_equality_operators = true
-ij_python_spaces_around_multiplicative_operators = true
-ij_python_spaces_around_power_operator = true
-ij_python_spaces_around_relational_operators = true
-ij_python_spaces_around_shift_operators = true
-ij_python_spaces_within_braces = false
-ij_python_spaces_within_brackets = false
-ij_python_spaces_within_method_call_parentheses = false
-ij_python_spaces_within_method_parentheses = false
-ij_python_use_continuation_indent_for_arguments = false
-ij_python_use_continuation_indent_for_collection_and_comprehensions = false
-ij_python_use_continuation_indent_for_parameters = false
-ij_python_wrap_long_lines = false

plexus_python_protobuf_setup-1.0.3/.github/workflows/pr.yml

@@ -1,31 +0,0 @@
-name: Pull Request
-
-on:
-  pull_request:
-    branches: [ "master" ]
-
-env:
-  BUILD_NUMBER: ${{ github.run_number }}
-
-jobs:
-  build-python:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: [ "3.11", "3.12", "3.13" ]
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "${{ matrix.python-version }}"
-
-      - name: Build and Test
-        run: |
-          sudo apt-get update
-          sudo apt-get install libxml2-dev libxslt1-dev llvm-14-dev
-          python -m pip install --upgrade pip
-          python -m pip install .[test]
-          python -m pytest . --cov --cov-report xml --cov-config pyproject.toml

plexus_python_protobuf_setup-1.0.3/.github/workflows/push.yml

@@ -1,37 +0,0 @@
-name: Push
-
-on:
-  push:
-    branches: [ "master" ]
-
-env:
-  BUILD_NUMBER: ${{ github.run_number }}
-
-jobs:
-  push:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.13"
-
-      - name: Build and Upload
-        run: |
-          sudo apt-get update
-          sudo apt-get install libxml2-dev libxslt1-dev llvm-14-dev
-          python -m pip install --upgrade pip build twine
-          python -m pip install .[test]
-          python -m pytest . --cov --cov-report xml --cov-config pyproject.toml
-          python -m build -sw .
-          python -m twine upload --username __token__ --password ${{ secrets.PYPI_TOKEN }} dist/*
-
-      - name: Upload Coverage Report
-        uses: codecov/codecov-action@v5
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          slug: ${{ github.repository }}
-          fail_ci_if_error: true

plexus_python_protobuf_setup-1.0.3/.gitignore

@@ -1,187 +0,0 @@
-# System junks
-*.[oa]
-*~
-.DS_Store
-Thumbs.db
-
-# Git
-.git/
-
-# General
-target/
-output/
-build/
-opt/
-gen/
-tmp/
-temp/
-
-# IDEs
-*.iml
-.idea/
-.classpath
-.project
-.settings/
-.vscode/
-
-
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# 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/#use-with-ide
-.pdm.toml
-
-# 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
-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
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/

plexus_python_protobuf_setup-1.0.3/README.md

@@ -1 +0,0 @@
-# Plexus Python Protocol Buffer Setup Module

plexus_python_protobuf_setup-1.0.3/resources/unittest/setup/protos/dummy/person.proto

@@ -1,9 +0,0 @@
-syntax = "proto3";
-
-package dummy;
-
-message Person {
-  optional string name = 1;
-  optional int32 age = 2;
-  repeated string hobbies = 3;
-}

plexus_python_protobuf_setup-1.0.3/resources/unittest/setup/protos/dummy/relationship/company.proto

@@ -1,12 +0,0 @@
-syntax = "proto3";
-
-package dummy.relationship;
-
-import "dummy/person.proto";
-
-message Company {
-
-  optional dummy.Person boss = 1;
-  repeated dummy.Person staff = 2;
-
-}

plexus_python_protobuf_setup-1.0.3/resources/unittest/setup/protos/dummy/relationship/family.proto

@@ -1,13 +0,0 @@
-syntax = "proto3";
-
-package dummy.relationship;
-
-import "dummy/person.proto";
-
-message Family {
-
-  optional dummy.Person father = 1;
-  optional dummy.Person mother = 2;
-  repeated dummy.Person children = 3;
-
-}

plexus_python_protobuf_setup-1.0.3/src/plexus_python_protobuf_setup.egg-info/SOURCES.txt

@@ -1,22 +0,0 @@
-.editorconfig
-.gitignore
-MANIFEST.in
-README.md
-VERSION
-pyproject.toml
-setup.py
-.github/workflows/pr.yml
-.github/workflows/push.yml
-resources/unittest/setup/protos/dummy/person.proto
-resources/unittest/setup/protos/dummy/relationship/company.proto
-resources/unittest/setup/protos/dummy/relationship/family.proto
-src/plexus/protobuf/setup/__init__.py
-src/plexus_python_protobuf_setup.egg-info/PKG-INFO
-src/plexus_python_protobuf_setup.egg-info/SOURCES.txt
-src/plexus_python_protobuf_setup.egg-info/dependency_links.txt
-src/plexus_python_protobuf_setup.egg-info/not-zip-safe
-src/plexus_python_protobuf_setup.egg-info/requires.txt
-src/plexus_python_protobuf_setup.egg-info/top_level.txt
-test/plexus_test.py
-test/plexus_tests/__init__.py
-test/plexus_tests/protobuf/setup_test.py

plexus_python_protobuf_setup-1.0.3/test/plexus_test.py

@@ -1,13 +0,0 @@
-import unittest
-
-from plexus_tests import *
-
-
-class Test(unittest.TestCase):
-
-    def test(self):
-        self.assertIsNotNone(module_directory)
-        self.assertIsNotNone(source_directory)
-        self.assertIsNotNone(test_directory)
-        self.assertIsNotNone(resources_directory)
-        self.assertIsNotNone(temporary_directory)

plexus_python_protobuf_setup-1.0.3/test/plexus_tests/__init__.py

@@ -1,15 +0,0 @@
-import os
-
-__all__ = [
-    "module_directory",
-    "source_directory",
-    "test_directory",
-    "resources_directory",
-    "temporary_directory",
-]
-
-module_directory: str = os.path.abspath(os.path.dirname(os.path.dirname(os.path.dirname(__file__))))
-source_directory: str = os.path.abspath(os.path.join(module_directory, "src"))
-test_directory: str = os.path.abspath(os.path.join(module_directory, "test"))
-resources_directory: str = os.path.abspath(os.path.join(module_directory, "resources"))
-temporary_directory: str = os.path.abspath(os.path.join(module_directory, "tmp"))

plexus_python_protobuf_setup-1.0.3/test/plexus_tests/protobuf/setup_test.py

@@ -1,49 +0,0 @@
-import os
-import tempfile
-import unittest
-
-import plexus.protobuf.setup
-from plexus_tests import resources_directory
-
-
-class TestSetup(unittest.TestCase):
-
-    def test_compile_protos(self):
-        with tempfile.TemporaryDirectory() as temp_dir:
-            proto_dirs = [os.path.join(resources_directory, "unittest", "setup", "protos")]
-            include_dirs = [os.path.join(resources_directory, "unittest", "setup", "protos")]
-
-            plexus.protobuf.setup.compile_protos(temp_dir,
-                                                 proto_dirs,
-                                                 include_dirs,
-                                                 descriptor_path=os.path.join(temp_dir, "descriptor.proto"),
-                                                 with_grpc=True)
-
-            self.assertTrue(os.path.exists(os.path.join(temp_dir, "descriptor.proto")))
-            self.assertTrue(os.path.exists(os.path.join(temp_dir, "dummy", "person_pb2.py")))
-            self.assertTrue(os.path.exists(os.path.join(temp_dir, "dummy", "person_pb2.pyi")))
-            self.assertTrue(os.path.exists(os.path.join(temp_dir, "dummy", "person_pb2_grpc.py")))
-            self.assertTrue(os.path.exists(os.path.join(temp_dir, "dummy", "relationship", "company_pb2.py")))
-            self.assertTrue(os.path.exists(os.path.join(temp_dir, "dummy", "relationship", "company_pb2.pyi")))
-            self.assertTrue(os.path.exists(os.path.join(temp_dir, "dummy", "relationship", "company_pb2_grpc.py")))
-            self.assertTrue(os.path.exists(os.path.join(temp_dir, "dummy", "relationship", "family_pb2.py")))
-            self.assertTrue(os.path.exists(os.path.join(temp_dir, "dummy", "relationship", "family_pb2.pyi")))
-            self.assertTrue(os.path.exists(os.path.join(temp_dir, "dummy", "relationship", "family_pb2_grpc.py")))
-
-    def test_compile_protos__without_grpc(self):
-        with tempfile.TemporaryDirectory() as temp_dir:
-            proto_dirs = [os.path.join(resources_directory, "unittest", "setup", "protos")]
-            include_dirs = [os.path.join(resources_directory, "unittest", "setup", "protos")]
-
-            plexus.protobuf.setup.compile_protos(temp_dir, proto_dirs, include_dirs, with_grpc=False)
-
-            self.assertFalse(os.path.exists(os.path.join(temp_dir, "descriptor.proto")))
-            self.assertTrue(os.path.exists(os.path.join(temp_dir, "dummy", "person_pb2.py")))
-            self.assertTrue(os.path.exists(os.path.join(temp_dir, "dummy", "person_pb2.pyi")))
-            self.assertFalse(os.path.exists(os.path.join(temp_dir, "dummy", "person_pb2_grpc.py")))
-            self.assertTrue(os.path.exists(os.path.join(temp_dir, "dummy", "relationship", "company_pb2.py")))
-            self.assertTrue(os.path.exists(os.path.join(temp_dir, "dummy", "relationship", "company_pb2.pyi")))
-            self.assertFalse(os.path.exists(os.path.join(temp_dir, "dummy", "relationship", "company_pb2_grpc.py")))
-            self.assertTrue(os.path.exists(os.path.join(temp_dir, "dummy", "relationship", "family_pb2.py")))
-            self.assertTrue(os.path.exists(os.path.join(temp_dir, "dummy", "relationship", "family_pb2.pyi")))
-            self.assertFalse(os.path.exists(os.path.join(temp_dir, "dummy", "relationship", "family_pb2_grpc.py")))