v3p 0.1.0__py3-none-any.whl

v3p/__init__.py

@@ -0,0 +1,5 @@
+"""v3p - Vuer 3DGS Processing tools."""
+
+from pathlib import Path
+
+__version__ = (Path(__file__).parent.parent.parent / "VERSION").read_text().strip()

v3p/scripts/__init__.py

@@ -0,0 +1 @@
+"""v3p CLI scripts."""

v3p/scripts/cli.py

@@ -0,0 +1,40 @@
+"""v3p CLI with params-proto subcommands."""
+
+import sys
+
+
+def cli():
+    """Main CLI entry point with subcommand routing."""
+    if len(sys.argv) < 2:
+        print("Usage: v3p <command> [options]")
+        print("")
+        print("Commands:")
+        print("  process    Process 3DGS point clouds")
+        print("  convert    Convert between formats")
+        print("")
+        print("Run 'v3p <command> --help' for more information.")
+        sys.exit(1)
+
+    command = sys.argv[1]
+    sys.argv = [sys.argv[0]] + sys.argv[2:]  # Remove subcommand from argv
+
+    if command == "process":
+        # Import triggers CLI parsing with @proto(cli=True)
+        from v3p.scripts.process import ProcessConfig, main
+
+        main()
+    elif command == "convert":
+        from v3p.scripts.convert import ConvertConfig, main
+
+        main()
+    elif command in ["-h", "--help"]:
+        sys.argv = [sys.argv[0]]
+        cli()  # Show help
+    else:
+        print(f"Unknown command: {command}")
+        print("Run 'v3p --help' for available commands.")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    cli()

v3p/scripts/convert.py

@@ -0,0 +1,46 @@
+"""Example params-proto subcommand for format conversion."""
+
+from params_proto import proto
+
+
+@proto(cli=True)
+class ConvertConfig:
+    """Configuration for format conversion.
+
+    Args:
+        input_path: Path to input file
+        output_path: Path to output file
+        input_format: Input format (auto, ply, pcd, xyz)
+        output_format: Output format (ply, pcd, xyz)
+        binary: Write binary format when supported
+        verbose: Enable verbose output
+    """
+
+    input_path: str = None
+    output_path: str = None
+
+    # Format options
+    input_format: str = "auto"
+    output_format: str = "ply"
+
+    # Options
+    binary: bool = True
+    verbose: bool = False
+
+
+def main():
+    """Run format conversion with the given configuration."""
+    print(f"Converting: {ConvertConfig.input_path}")
+    print(f"Output: {ConvertConfig.output_path}")
+    print(f"Input format: {ConvertConfig.input_format}")
+    print(f"Output format: {ConvertConfig.output_format}")
+
+    if ConvertConfig.verbose:
+        print(f"Binary: {ConvertConfig.binary}")
+
+    # Placeholder for actual conversion logic
+    print("Conversion complete!")
+
+
+if __name__ == "__main__":
+    main()

v3p/scripts/process.py

@@ -0,0 +1,49 @@
+"""Example params-proto subcommand for 3DGS processing."""
+
+from params_proto import proto
+
+
+@proto(cli=True)
+class ProcessConfig:
+    """Configuration for 3DGS processing.
+
+    Args:
+        input_path: Path to input PLY or point cloud file
+        output_path: Path to output file
+        voxel_size: Voxel size for downsampling
+        remove_outliers: Remove statistical outliers
+        num_neighbors: Number of neighbors for outlier detection
+        std_ratio: Standard deviation ratio for outlier removal
+        verbose: Enable verbose output
+    """
+
+    input_path: str = None
+    output_path: str = "output.ply"
+
+    # Processing options
+    voxel_size: float = 0.01
+    remove_outliers: bool = True
+    num_neighbors: int = 20
+    std_ratio: float = 2.0
+
+    # Output options
+    verbose: bool = False
+
+
+def main():
+    """Run 3DGS processing with the given configuration."""
+    print(f"Processing: {ProcessConfig.input_path}")
+    print(f"Output: {ProcessConfig.output_path}")
+    print(f"Voxel size: {ProcessConfig.voxel_size}")
+    print(f"Remove outliers: {ProcessConfig.remove_outliers}")
+
+    if ProcessConfig.verbose:
+        print(f"Neighbors: {ProcessConfig.num_neighbors}")
+        print(f"Std ratio: {ProcessConfig.std_ratio}")
+
+    # Placeholder for actual processing logic
+    print("Processing complete!")
+
+
+if __name__ == "__main__":
+    main()

v3p-0.1.0.dist-info/METADATA

@@ -0,0 +1,174 @@
+Metadata-Version: 2.4
+Name: v3p
+Version: 0.1.0
+Summary: Vuer 3DGS Processing - Tools for Gaussian Splatting workflows.
+Home-page: https://github.com/vuer-ai/vuer-doc-boilerplate
+Author: Ge Yang<ge.ike.yang@gmail.com>
+Author-email: ge.ike.yang@gmail.com
+License: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: params-proto>=3.1.0
+Requires-Dist: numpy>=1.21
+Provides-Extra: all
+Provides-Extra: dev
+Requires-Dist: pylint==2.13.4; extra == "dev"
+Requires-Dist: pytest==7.1.2; extra == "dev"
+Requires-Dist: sphinx==7.1.2; extra == "dev"
+Requires-Dist: furo; extra == "dev"
+Requires-Dist: sphinx-autobuild; extra == "dev"
+Requires-Dist: sphinx_copybutton; extra == "dev"
+Requires-Dist: sphinxcontrib-video; extra == "dev"
+Requires-Dist: sphinx-design; extra == "dev"
+Requires-Dist: myst_parser; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: home-page
+Dynamic: license-file
+
+# v3p - Vuer 3DGS Processing
+
+Tools for Gaussian Splatting (3DGS) processing workflows. Built with [params-proto](https://github.com/geyang/params-proto) for configuration management.
+
+[![PyPI version](https://badge.fury.io/py/v3p.svg)](https://badge.fury.io/py/v3p)
+[![Documentation](https://readthedocs.org/projects/v3p/badge/?version=latest)](https://v3p.readthedocs.io/en/latest/)
+
+## Installation
+
+```bash
+pip install v3p
+```
+
+For development:
+
+```bash
+git clone https://github.com/vuer-ai/vuer-3dgs-processing.git
+cd vuer-3dgs-processing
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+### CLI Usage
+
+The `v3p` command provides several subcommands for processing 3DGS point clouds:
+
+```bash
+# Show available commands
+v3p
+
+# Process a point cloud
+v3p process --input-path input.ply --output-path output.ply
+
+# Convert between formats
+v3p convert --input-path input.ply --output-path output.pcd
+```
+
+### Python API
+
+```python
+import v3p
+print(v3p.__version__)
+```
+
+Using the configuration classes directly:
+
+```python
+from v3p.scripts.process import ProcessConfig, main
+
+# Configure via class attributes
+ProcessConfig.input_path = "input.ply"
+ProcessConfig.output_path = "output.ply"
+ProcessConfig.voxel_size = 0.01
+ProcessConfig.verbose = True
+
+# Run processing
+main()
+```
+
+## Commands
+
+### v3p process
+
+Process 3DGS point clouds with filtering and downsampling.
+
+```bash
+v3p process --input-path <path> [options]
+```
+
+Options:
+- `--input-path`: Path to input PLY or point cloud file (required)
+- `--output-path`: Path to output file (default: output.ply)
+- `--voxel-size`: Voxel size for downsampling (default: 0.01)
+- `--remove-outliers`: Remove statistical outliers (default: True)
+- `--num-neighbors`: Number of neighbors for outlier detection (default: 20)
+- `--std-ratio`: Standard deviation ratio for outlier removal (default: 2.0)
+- `--verbose`: Enable verbose output
+
+### v3p convert
+
+Convert between point cloud formats.
+
+```bash
+v3p convert --input-path <path> --output-path <path> [options]
+```
+
+Options:
+- `--input-path`: Path to input file (required)
+- `--output-path`: Path to output file (required)
+- `--input-format`: Input format - auto, ply, pcd, xyz (default: auto)
+- `--output-format`: Output format - ply, pcd, xyz (default: ply)
+- `--binary`: Write binary format when supported (default: True)
+- `--verbose`: Enable verbose output
+
+## Configuration with params-proto
+
+v3p uses [params-proto](https://github.com/geyang/params-proto) for configuration management. This allows you to:
+
+1. **Set parameters via CLI**: All config class attributes become CLI flags
+2. **Set parameters programmatically**: Modify class attributes directly
+3. **Use sweep files**: Generate parameter sweeps for batch processing
+
+Example sweep file:
+
+```python
+from params_proto import Sweep
+from v3p.scripts.process import ProcessConfig
+
+with Sweep(ProcessConfig) as sweep:
+    ProcessConfig.input_path = "input.ply"
+    with sweep.product:
+        ProcessConfig.voxel_size = [0.01, 0.02, 0.05]
+
+sweep.save("process_sweep.jsonl")
+```
+
+## Development
+
+```bash
+# Install dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+make test
+
+# Build and preview documentation
+make preview
+
+# Build wheel
+make wheel
+
+# Publish to PyPI
+make publish
+```
+
+## Documentation
+
+Full documentation: https://v3p.readthedocs.io/en/latest/
+
+## License
+
+MIT

v3p-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+v3p/__init__.py,sha256=rlCs9rH3_Ad5ONMMEwaF6z3-fZoe5iKy4GBOrQ0CyrA,151
+v3p/scripts/__init__.py,sha256=RY1HbyhfgROTqabREzyOsvdiaLnkYByOJBvjhXV0wUg,23
+v3p/scripts/cli.py,sha256=MrVoxz-zu6mu6X7u4ZiTTczPEQv7ByDgEK9If5pEMr0,1104
+v3p/scripts/convert.py,sha256=kKslOKLSF-vblE_ZDAq2S4PYHjdqo9VD8JU5SvbV4oM,1177
+v3p/scripts/process.py,sha256=PStFgWSDxptP8PWkgvqd46CFNmgtB1NtfRLBQ2FL8g8,1374
+v3p-0.1.0.dist-info/licenses/LICENSE,sha256=ViVJUWot4p3kmGwzBBRu6vqoBFQuLFKyGIR3jzh4X_A,1064
+v3p-0.1.0.dist-info/METADATA,sha256=jklAMqeU_4oxmOa_zg9GEXnzRG6CtArodIHzJoSmVXo,4365
+v3p-0.1.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+v3p-0.1.0.dist-info/entry_points.txt,sha256=1ylylWLGt8KrQitXSd5urf_sDCNbbXBaGGtvFKmyl6M,122
+v3p-0.1.0.dist-info/top_level.txt,sha256=wKNNPrpvpbRlZT92HhhBbgwypZosamm3ZaO-WYNbAiQ,4
+v3p-0.1.0.dist-info/RECORD,,

v3p-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

v3p-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+v3p = v3p.scripts.cli:cli
+v3p-convert = v3p.scripts.convert:main
+v3p-process = v3p.scripts.process:main

v3p-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ge Yang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

v3p-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+v3p