mirror of
https://github.com/ZGCA-Forge/MsgCenterPy.git
synced 2026-02-10 09:45:16 +00:00
Compare commits
15 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ec2fafb363 | ||
|
|
74e7a15ef9 | ||
|
|
661ee43a1c | ||
|
|
0dff62e738 | ||
|
|
823b04dcbc | ||
|
|
80726163dd | ||
|
|
656ef7ca80 | ||
|
|
cc394fd63c | ||
|
|
2d83bad8ce | ||
|
|
9d52781134 | ||
|
|
89169ca7be | ||
|
|
cda31464d3 | ||
|
|
20a904ef8a | ||
|
|
d8070b5e49 | ||
|
|
d5704e78c3 |
@@ -1,5 +1,5 @@
|
|||||||
[bumpversion]
|
[bumpversion]
|
||||||
current_version = 0.0.5
|
current_version = 0.1.0
|
||||||
commit = True
|
commit = True
|
||||||
tag = True
|
tag = True
|
||||||
tag_name = v{new_version}
|
tag_name = v{new_version}
|
||||||
|
|||||||
12
.github/workflows/ci.yml
vendored
12
.github/workflows/ci.yml
vendored
@@ -16,7 +16,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
|
|
||||||
- name: Set up Python
|
- name: Set up Python
|
||||||
uses: actions/setup-python@v5
|
uses: actions/setup-python@v5
|
||||||
@@ -40,7 +40,7 @@ jobs:
|
|||||||
needs: [code-format] # Only run after code formatting passes
|
needs: [code-format] # Only run after code formatting passes
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
|
|
||||||
- name: Set up Python 3.10
|
- name: Set up Python 3.10
|
||||||
uses: actions/setup-python@v5
|
uses: actions/setup-python@v5
|
||||||
@@ -72,7 +72,7 @@ jobs:
|
|||||||
needs: [basic-build] # Only run after basic build passes
|
needs: [basic-build] # Only run after basic build passes
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
|
|
||||||
- name: Setup Miniconda
|
- name: Setup Miniconda
|
||||||
uses: conda-incubator/setup-miniconda@v3
|
uses: conda-incubator/setup-miniconda@v3
|
||||||
@@ -112,7 +112,7 @@ jobs:
|
|||||||
needs: [basic-build] # Run in parallel with ROS2 test after basic build
|
needs: [basic-build] # Run in parallel with ROS2 test after basic build
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
|
|
||||||
- name: Set up Python
|
- name: Set up Python
|
||||||
uses: actions/setup-python@v5
|
uses: actions/setup-python@v5
|
||||||
@@ -142,7 +142,7 @@ jobs:
|
|||||||
needs: [basic-build] # Run in parallel with other checks
|
needs: [basic-build] # Run in parallel with other checks
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
|
|
||||||
- name: Set up Python
|
- name: Set up Python
|
||||||
uses: actions/setup-python@v5
|
uses: actions/setup-python@v5
|
||||||
@@ -182,7 +182,7 @@ jobs:
|
|||||||
python-version: "3.10"
|
python-version: "3.10"
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
|
|
||||||
- name: Set up Python ${{ matrix.python-version }}
|
- name: Set up Python ${{ matrix.python-version }}
|
||||||
uses: actions/setup-python@v5
|
uses: actions/setup-python@v5
|
||||||
|
|||||||
6
.github/workflows/docs.yml
vendored
6
.github/workflows/docs.yml
vendored
@@ -36,7 +36,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
ref: ${{ github.event.inputs.branch || github.ref }}
|
ref: ${{ github.event.inputs.branch || github.ref }}
|
||||||
|
|
||||||
@@ -55,7 +55,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Setup Pages
|
- name: Setup Pages
|
||||||
id: pages
|
id: pages
|
||||||
uses: actions/configure-pages@v4
|
uses: actions/configure-pages@v5
|
||||||
if: github.ref == 'refs/heads/main' || (github.event_name == 'workflow_dispatch' && github.event.inputs.deploy_to_pages == 'true')
|
if: github.ref == 'refs/heads/main' || (github.event_name == 'workflow_dispatch' && github.event.inputs.deploy_to_pages == 'true')
|
||||||
|
|
||||||
- name: Build Sphinx documentation
|
- name: Build Sphinx documentation
|
||||||
@@ -64,7 +64,7 @@ jobs:
|
|||||||
make html
|
make html
|
||||||
|
|
||||||
- name: Upload artifact
|
- name: Upload artifact
|
||||||
uses: actions/upload-pages-artifact@v3
|
uses: actions/upload-pages-artifact@v4
|
||||||
if: github.ref == 'refs/heads/main' || (github.event_name == 'workflow_dispatch' && github.event.inputs.deploy_to_pages == 'true')
|
if: github.ref == 'refs/heads/main' || (github.event_name == 'workflow_dispatch' && github.event.inputs.deploy_to_pages == 'true')
|
||||||
with:
|
with:
|
||||||
path: docs/_build/html
|
path: docs/_build/html
|
||||||
|
|||||||
20
.github/workflows/publish.yml
vendored
20
.github/workflows/publish.yml
vendored
@@ -29,7 +29,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
|
|
||||||
- name: Set up Python
|
- name: Set up Python
|
||||||
uses: actions/setup-python@v5
|
uses: actions/setup-python@v5
|
||||||
@@ -53,7 +53,7 @@ jobs:
|
|||||||
needs: [code-format] # Only run after code formatting passes
|
needs: [code-format] # Only run after code formatting passes
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
|
|
||||||
- name: Set up Python 3.10
|
- name: Set up Python 3.10
|
||||||
uses: actions/setup-python@v5
|
uses: actions/setup-python@v5
|
||||||
@@ -85,7 +85,7 @@ jobs:
|
|||||||
needs: [basic-build] # Only run after basic build passes
|
needs: [basic-build] # Only run after basic build passes
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
|
|
||||||
- name: Setup Miniconda
|
- name: Setup Miniconda
|
||||||
uses: conda-incubator/setup-miniconda@v3
|
uses: conda-incubator/setup-miniconda@v3
|
||||||
@@ -125,7 +125,7 @@ jobs:
|
|||||||
needs: [basic-build] # Run in parallel with ROS2 test after basic build
|
needs: [basic-build] # Run in parallel with ROS2 test after basic build
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
|
|
||||||
- name: Set up Python
|
- name: Set up Python
|
||||||
uses: actions/setup-python@v5
|
uses: actions/setup-python@v5
|
||||||
@@ -154,7 +154,7 @@ jobs:
|
|||||||
needs: [test-with-ros2]
|
needs: [test-with-ros2]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
|
|
||||||
- name: Set up Python
|
- name: Set up Python
|
||||||
uses: actions/setup-python@v5
|
uses: actions/setup-python@v5
|
||||||
@@ -223,7 +223,7 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Retrieve release distributions
|
- name: Retrieve release distributions
|
||||||
uses: actions/download-artifact@v4
|
uses: actions/download-artifact@v5
|
||||||
with:
|
with:
|
||||||
name: release-dists
|
name: release-dists
|
||||||
path: dist/
|
path: dist/
|
||||||
@@ -246,7 +246,7 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Retrieve release distributions
|
- name: Retrieve release distributions
|
||||||
uses: actions/download-artifact@v4
|
uses: actions/download-artifact@v5
|
||||||
with:
|
with:
|
||||||
name: release-dists
|
name: release-dists
|
||||||
path: dist/
|
path: dist/
|
||||||
@@ -266,13 +266,13 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Retrieve release distributions
|
- name: Retrieve release distributions
|
||||||
uses: actions/download-artifact@v4
|
uses: actions/download-artifact@v5
|
||||||
with:
|
with:
|
||||||
name: release-dists
|
name: release-dists
|
||||||
path: dist/
|
path: dist/
|
||||||
|
|
||||||
- name: Upload release assets
|
- name: Upload release assets
|
||||||
uses: softprops/action-gh-release@v1
|
uses: softprops/action-gh-release@v2
|
||||||
with:
|
with:
|
||||||
files: dist/*
|
files: dist/*
|
||||||
env:
|
env:
|
||||||
@@ -285,7 +285,7 @@ jobs:
|
|||||||
if: always() && (needs.pypi-publish.result == 'success' || needs.test-pypi-publish.result == 'success')
|
if: always() && (needs.pypi-publish.result == 'success' || needs.test-pypi-publish.result == 'success')
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
|
|
||||||
- name: Create deployment summary
|
- name: Create deployment summary
|
||||||
run: |
|
run: |
|
||||||
|
|||||||
25
README.md
25
README.md
@@ -4,6 +4,7 @@
|
|||||||
|
|
||||||
[](https://badge.fury.io/py/msgcenterpy)
|
[](https://badge.fury.io/py/msgcenterpy)
|
||||||
[](https://pypi.org/project/msgcenterpy/)
|
[](https://pypi.org/project/msgcenterpy/)
|
||||||
|
[](https://pypi.org/project/msgcenterpy/)
|
||||||
[](https://github.com/ZGCA-Forge/MsgCenterPy/actions)
|
[](https://github.com/ZGCA-Forge/MsgCenterPy/actions)
|
||||||
[](https://zgca-forge.github.io/MsgCenterPy/)
|
[](https://zgca-forge.github.io/MsgCenterPy/)
|
||||||
|
|
||||||
@@ -59,7 +60,25 @@ Please visit: [https://zgca-forge.github.io/MsgCenterPy/](https://zgca-forge.git
|
|||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
### Development Environment Setup
|
### Quick Development Setup
|
||||||
|
|
||||||
|
For **Linux/macOS**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/ZGCA-Forge/MsgCenterPy.git
|
||||||
|
cd MsgCenterPy
|
||||||
|
./scripts/setup-dev.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
For **Windows**:
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
git clone https://github.com/ZGCA-Forge/MsgCenterPy.git
|
||||||
|
cd MsgCenterPy
|
||||||
|
.\scripts\setup-dev.ps1
|
||||||
|
```
|
||||||
|
|
||||||
|
### Manual Development Setup
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/ZGCA-Forge/MsgCenterPy.git
|
git clone https://github.com/ZGCA-Forge/MsgCenterPy.git
|
||||||
@@ -70,6 +89,10 @@ pre-commit install
|
|||||||
|
|
||||||
For API documentation, please refer to Quick Start
|
For API documentation, please refer to Quick Start
|
||||||
|
|
||||||
|
## Star History
|
||||||
|
|
||||||
|
[](https://star-history.com/#ZGCA-Forge/MsgCenterPy&Date)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under Apache-2.0 License - see the [LICENSE](LICENSE) file for details.
|
This project is licensed under Apache-2.0 License - see the [LICENSE](LICENSE) file for details.
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ A multi-format message conversion system supporting seamless conversion
|
|||||||
between ROS2, Pydantic, Dataclass, JSON, Dict, YAML and JSON Schema.
|
between ROS2, Pydantic, Dataclass, JSON, Dict, YAML and JSON Schema.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
__version__ = "0.0.5"
|
__version__ = "0.1.0"
|
||||||
__license__ = "Apache-2.0"
|
__license__ = "Apache-2.0"
|
||||||
|
|
||||||
from msgcenterpy.core.envelope import MessageEnvelope, create_envelope
|
from msgcenterpy.core.envelope import MessageEnvelope, create_envelope
|
||||||
|
|||||||
Reference in New Issue
Block a user