Skip to content

Revert "Rename the Python SDK library from rerun_sdk to just rerun." #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ source crates/re_sdk_python/setup_env.sh
maturin build -m ./crates/re_sdk_python/Cargo.toml --release
```

Now you can install `rerun` in any Python3 environment using:
Now you can install `rerun_sdk` in any Python3 environment using:

```
pip3 install PATH_TO_RERUN_REPOSITORY/target/wheels/*.whl
Expand Down
2 changes: 1 addition & 1 deletion crates/re_sdk_python/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ python-source = "python"

[lib]
crate-type = ["cdylib"]
name = "rerun" # name of the Python library
name = "rerun_sdk" # name of the Python library


[features]
Expand Down
2 changes: 1 addition & 1 deletion crates/re_sdk_python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ The Rerun Python Log SDK.

Goal: an ergonomic Python library for logging rich data, over TCP, to a rerun server.

Note: The rust crate is called `re_sdk_python`, while the Python library is called `rerun`.
Note: The rust crate is called `re_sdk_python`, while the Python library is called `rerun_sdk`.

## Setup

Expand Down
4 changes: 2 additions & 2 deletions crates/re_sdk_python/USAGE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Using the `rerun` Python Library
# Using the `rerun_sdk` Python Library

Install instructions can be found at <https://github.com/rerun-io/rerun#readme>.

Expand All @@ -13,7 +13,7 @@ Rerun assumes you are using `numpy` for any large chunks of data.
The first argument to each log function is the object name. This needs to be unique for each thing you log. You can not log an image with the same name as a point cloud!

```python
import rerun
import rerun_sdk as rerun

# Logging an image is easy:
rerun.log_image("rgb_image", image)
Expand Down
2 changes: 1 addition & 1 deletion crates/re_sdk_python/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ classifiers = [
"Programming Language :: Python :: Implementation :: PyPy",
]
dependencies = ["opencv-python"]
name = "rerun"
name = "rerun_sdk"
requires-python = ">=3.7"
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# The Rerun Python SDK, which is a wrapper around a Rust crate.
# The Rerun Python SDK, which is a wrapper around the Rust crate rerun_sdk
import numpy as np

from .rerun import *
from .rerun_sdk import *

print("rerun initialized")
print("rerun_sdk initialized")


def log_points(obj_path, positions, colors):
Expand Down
4 changes: 2 additions & 2 deletions crates/re_sdk_python/src/python_bridge.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ use re_log_types::*;

use crate::sdk::Sdk;

/// The python module is called "rerun".
/// The python module is called "rerun_sdk".
#[pymodule]
fn rerun(_py: Python<'_>, m: &PyModule) -> PyResult<()> {
fn rerun_sdk(_py: Python<'_>, m: &PyModule) -> PyResult<()> {
// Log to stdout (if you run with `RUST_LOG=debug`).
tracing_subscriber::fmt::init();

Expand Down
2 changes: 1 addition & 1 deletion crates/re_sdk_python/test.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import numpy as np
import time

import rerun
import rerun_sdk as rerun


def log(args):
Expand Down
Binary file removed depth_image.pgm
Binary file not shown.