Initial commit

.clang-format

@@ -0,0 +1,34 @@
+BasedOnStyle: Google
+
+# Make it slightly more similar to Rust.
+# Based loosely on https://gist.github.com/YodaEmbedding/c2c77dc693d11f3734d78489f9a6eea4
+AccessModifierOffset: -2
+AlignAfterOpenBracket: BlockIndent
+AllowAllArgumentsOnNextLine: false
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: Empty
+AllowShortIfStatementsOnASingleLine: Never
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: true
+BinPackArguments: false
+BreakStringLiterals: false
+ColumnLimit: 100
+ContinuationIndentWidth: 4
+DerivePointerAlignment: false
+EmptyLineBeforeAccessModifier: LogicalBlock
+IndentWidth: 4
+IndentWrappedFunctionNames: true
+InsertBraces: true
+InsertTrailingCommas: Wrapped
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: All
+PointerAlignment: Left
+ReflowComments: false
+SeparateDefinitionBlocks: Always
+SpacesBeforeTrailingComments: 1
+
+# Don't change include blocks, we want to control this manually.
+# Sorting headers however is allowed as all our headers should be standalone.
+IncludeBlocks: Preserve
+SortIncludes: CaseInsensitive

.github/workflows/cpp.yml

@@ -0,0 +1,20 @@
+# Copied from https://github.com/rerun-io/rerun_template
+on: [push, pull_request]
+
+name: C++
+
+jobs:
+ cpp-check:
+ name: C++
+ runs-on: ubuntu-22.04
+ steps:
+ - uses: actions/checkout@v4
+
+ - uses: prefix-dev/[email protected]
+ with:
+ pixi-version: v0.19.0
+ cache: true
+
+ - run: pixi run build
+
+ - run: pixi run cpp-fmt-check

.github/workflows/labels.yml

@@ -0,0 +1,34 @@
+# Copied from https://github.com/rerun-io/rerun_template
+
+# https://github.com/marketplace/actions/require-labels
+# Check for existence of labels
+# See all our labels at https://github.com/rerun-io/rerun/issues/labels
+
+name: PR Labels
+
+on:
+ pull_request:
+ types:
+ - opened
+ - synchronize
+ - reopened
+ - labeled
+ - unlabeled
+
+jobs:
+ label:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Check for a "do-not-merge" label
+ uses: mheap/github-action-required-labels@v3
+ with:
+ mode: exactly
+ count: 0
+ labels: "do-not-merge"
+
+ - name: Require label "include in changelog" or "exclude from changelog"
+ uses: mheap/github-action-required-labels@v3
+ with:
+ mode: minimum
+ count: 1
+ labels: "exclude from changelog, include in changelog"

.github/workflows/links.yml

@@ -0,0 +1,29 @@
+# Copied from https://github.com/rerun-io/rerun_template
+on: [push, pull_request]
+
+name: Link checker
+
+jobs:
+ link-checker:
+ name: Check links
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+
+ - name: Restore link checker cache
+ uses: actions/cache@v3
+ with:
+ path: .lycheecache
+ key: cache-lychee-${{ github.sha }}
+ restore-keys: cache-lychee-
+
+ # Check https://github.com/lycheeverse/lychee on how to run locally.
+ - name: Link Checker
+ id: lychee
+ uses: lycheeverse/[email protected]
+ with:
+ fail: true
+ lycheeVersion: "0.14.3"
+ # When given a directory, lychee checks only markdown, html and text files, everything else we have to glob in manually.
+ args: |
+ --base . --cache --max-cache-age 1d . "**/*.rs" "**/*.toml" "**/*.hpp" "**/*.cpp" "**/CMakeLists.txt" "**/*.py" "**/*.yml"

.github/workflows/python.yml

@@ -0,0 +1,20 @@
+# Copied from https://github.com/rerun-io/rerun_template
+on: [push, pull_request]
+
+name: C++
+
+jobs:
+ python-check:
+ name: Python
+ runs-on: ubuntu-22.04
+ steps:
+ - uses: actions/checkout@v4
+
+ - uses: prefix-dev/[email protected]
+ with:
+ pixi-version: v0.19.0
+ cache: true
+
+ - run: pixi run py-fmt-check
+
+ - run: pixi run py-lint

.github/workflows/rust.yml

@@ -0,0 +1,145 @@
+# Copied from https://github.com/rerun-io/rerun_template
+on: [push, pull_request]
+
+name: Rust
+
+env:
+ RUSTFLAGS: -D warnings
+ RUSTDOCFLAGS: -D warnings
+
+jobs:
+ rust-check:
+ name: Rust
+ runs-on: ubuntu-22.04
+ steps:
+ - uses: actions/checkout@v4
+
+ - uses: actions-rs/toolchain@v1
+ with:
+ profile: default
+ toolchain: 1.76.0
+ override: true
+
+ - name: Install packages (Linux)
+ if: runner.os == 'Linux' && false # TODO: enable if eframe is part of the project, otherwise remove
+ uses: awalsh128/[email protected]
+ with:
+ # some deps used by eframe, if that is part of the project
+ packages: libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev libssl-dev # libgtk-3-dev is used by rfd
+ version: 1.0
+ execute_install_scripts: true
+
+ - name: Set up cargo cache
+ uses: Swatinem/rust-cache@v2
+
+ - name: Rustfmt
+ uses: actions-rs/cargo@v1
+ with:
+ command: fmt
+ args: --all -- --check
+
+ - name: Install cargo-cranky
+ uses: baptiste0928/cargo-install@v1
+ with:
+ crate: cargo-cranky
+
+ - name: check --all-features
+ uses: actions-rs/cargo@v1
+ with:
+ command: check
+ args: --all-features --all-targets
+
+ - name: check default features
+ uses: actions-rs/cargo@v1
+ with:
+ command: check
+ args: --all-targets
+
+ - name: check --no-default-features
+ uses: actions-rs/cargo@v1
+ with:
+ command: check
+ args: --no-default-features --lib --all-targets
+
+ - name: Test doc-tests
+ uses: actions-rs/cargo@v1
+ with:
+ command: test
+ args: --doc --all-features
+
+ - name: cargo doc --lib
+ uses: actions-rs/cargo@v1
+ with:
+ command: doc
+ args: --lib --no-deps --all-features
+
+ - name: cargo doc --document-private-items
+ uses: actions-rs/cargo@v1
+ with:
+ command: doc
+ args: --document-private-items --no-deps --all-features
+
+ - name: Build tests
+ uses: actions-rs/cargo@v1
+ with:
+ command: test
+ args: --all-features --no-run
+
+ - name: Run test
+ uses: actions-rs/cargo@v1
+ with:
+ command: test
+ args: --all-features
+
+ - name: Cranky
+ uses: actions-rs/cargo@v1
+ with:
+ command: cranky
+ args: --all-targets --all-features -- -D warnings
+
+ # ---------------------------------------------------------------------------
+
+ check_wasm:
+ name: Check wasm32
+ runs-on: ubuntu-22.04
+ steps:
+ - uses: actions/checkout@v4
+ - uses: actions-rs/toolchain@v1
+ with:
+ profile: minimal
+ toolchain: 1.76.0
+ target: wasm32-unknown-unknown
+ override: true
+
+ - run: sudo apt-get update && sudo apt-get install libgtk-3-dev
+
+ - name: Set up cargo cache
+ uses: Swatinem/rust-cache@v2
+
+ - name: Install cargo-cranky
+ uses: baptiste0928/cargo-install@v1
+ with:
+ crate: cargo-cranky
+
+ - name: Check wasm32
+ uses: actions-rs/cargo@v1
+ with:
+ command: check
+ args: --target wasm32-unknown-unknown
+
+ - name: Cranky wasm32
+ env:
+ CLIPPY_CONF_DIR: "scripts/clippy_wasm" # Use scripts/clippy_wasm/clippy.toml
+ run: cargo cranky --target wasm32-unknown-unknown -- -D warnings
+
+ # ---------------------------------------------------------------------------
+
+ cargo-deny:
+ runs-on: ubuntu-22.04
+ steps:
+ - uses: actions/checkout@v3
+ - uses: EmbarkStudios/cargo-deny-action@v1
+ with:
+ rust-version: "1.76.0"
+ log-level: warn
+ command: check

.github/workflows/typos.yml

@@ -0,0 +1,19 @@
+# Copied from https://github.com/rerun-io/rerun_template
+
+# https://github.com/crate-ci/typos
+# Add exceptions to `.typos.toml`
+# install and run locally: cargo install typos-cli && typos
+
+name: Spell Check
+on: [pull_request]
+
+jobs:
+ run:
+ name: Spell Check
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout Actions Repository
+ uses: actions/checkout@v4
+
+ - name: Check spelling of entire workspace
+ uses: crate-ci/typos@master

.gitignore

@@ -0,0 +1,17 @@
+# Mac stuff:
+.DS_Store
+
+# C++ build directory
+build
+
+# Rust compile target directories:
+target
+target_ra
+target_wasm
+
+# https://github.com/lycheeverse/lychee
+.lycheecache
+
+# Pixi environment
+.pixi
+.ruff_cache

.mypy.ini

@@ -0,0 +1,11 @@
+[mypy]
+files = .
+exclude = build
+namespace_packages = True
+show_error_codes = True
+strict = True
+enable_error_code = redundant-expr, truthy-bool, ignore-without-code
+; plugins = numpy.typing.mypy_plugin
+ignore_missing_imports = True
+no_implicit_reexport = False
+disallow_untyped_calls = False

.typos.toml

@@ -0,0 +1,6 @@
+# https://github.com/crate-ci/typos
+# install: cargo install typos-cli
+# run: typos
+
+[default.extend-words]
+teh = "teh" # part of @teh-cmc

.vscode/extensions.json

@@ -0,0 +1,26 @@
+{
+ // See https://go.microsoft.com/fwlink/?LinkId=827846
+ // for the documentation about the extensions.json format
+ "recommendations": [
+ "charliermarsh.ruff",
+ "gaborv.flatbuffers",
+ "github.vscode-github-actions",
+ "josetr.cmake-language-support-vscode",
+ "ms-python.mypy-type-checker",
+ "ms-python.python",
+ "ms-vscode.cmake-tools",
+ "ms-vscode.cpptools-extension-pack",
+ "ms-vsliveshare.vsliveshare",
+ "polymeilex.wgsl",
+ "rust-lang.rust-analyzer",
+ "serayuzgur.crates",
+ "streetsidesoftware.code-spell-checker",
+ "tamasfe.even-better-toml",
+ "vadimcn.vscode-lldb",
+ "wayou.vscode-todo-highlight",
+ "webfreak.debug",
+ "xaver.clang-format", // C++ formatter
+ "zxh404.vscode-proto3",
+ "esbenp.prettier-vscode"
+ ]
+}

.vscode/launch.json

@@ -0,0 +1,56 @@
+{
+ // Use IntelliSense to learn about possible attributes.
+ // Hover to view descriptions of existing attributes.
+ // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+ "version": "0.2.0",
+ "configurations": [
+ // Python
+ {
+ "name": "Python Debugger: Current File",
+ "type": "debugpy",
+ "request": "launch",
+ "program": "${file}",
+ "console": "integratedTerminal"
+ },
+ // Rust:
+ {
+ "name": "Debug 'rerun_template'",
+ "type": "lldb",
+ "request": "launch",
+ "cargo": {
+ "args": [
+ "build"
+ ],
+ "filter": {
+ "name": "rerun_template",
+ "kind": "bin"
+ }
+ },
+ "args": [],
+ "cwd": "${workspaceFolder}",
+ "env": {
+ "RUST_LOG": "debug"
+ }
+ },
+ {
+ "name": "Launch Rust tests",
+ "type": "lldb",
+ "request": "launch",
+ "cargo": {
+ "args": [
+ "test",
+ "--no-run",
+ "--lib",
+ "--all-features"
+ ],
+ "filter": {
+ "kind": "lib"
+ }
+ },
+ "cwd": "${workspaceFolder}",
+ "env": {
+ "RUST_LOG": "debug"
+ }
+ },
+ ]
+}

.vscode/settings.json

@@ -0,0 +1,52 @@
+{
+ "editor.formatOnSave": true,
+ "editor.semanticTokenColorCustomizations": {
+ "rules": {
+ "*.unsafe:rust": "#eb5046"
+ }
+ },
+ "files.autoGuessEncoding": true,
+ "files.insertFinalNewline": true,
+ "files.trimTrailingWhitespace": true,
+ // don't share a cargo lock with rust-analyzer.
+ // see https://github.com/rerun-io/rerun/pull/519 for rationale
+ "rust-analyzer.check.overrideCommand": [
+ "cargo",
+ "cranky",
+ "--target-dir=target_ra",
+ "--workspace",
+ "--message-format=json",
+ "--all-targets",
+ "--all-features"
+ ],
+ "rust-analyzer.cargo.buildScripts.overrideCommand": [
+ "cargo",
+ "check",
+ "--quiet",
+ "--target-dir=target_ra",
+ "--workspace",
+ "--message-format=json",
+ "--all-targets",
+ "--all-features",
+ ],
+ // Our build scripts are generating code.
+ // Having Rust Analyzer do this while doing other builds can lead to catastrophic failures.
+ // INCLUDING attempts to publish a new release!
+ "rust-analyzer.cargo.buildScripts.enable": false,
+ "C_Cpp.default.configurationProvider": "ms-vscode.cmake-tools", // Use cmake-tools to grab configs.
+ "C_Cpp.autoAddFileAssociations": false,
+ "cmake.buildDirectory": "${workspaceRoot}/build/debug",
+ "cmake.generator": "Ninja", // Use Ninja, just like we do in our just/pixi command.
+ "rust-analyzer.showUnlinkedFileNotification": false,
+ "ruff.format.args": [
+ "--config=pyproject.toml"
+ ],
+ "ruff.lint.args": [
+ "--config=pyproject.toml"
+ ],
+ "prettier.requireConfig": true,
+ "prettier.configPath": ".prettierrc.toml",
+ "[python]": {
+ "editor.defaultFormatter": "charliermarsh.ruff"
+ },
+}

CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog

CMakeLists.txt

@@ -0,0 +1,18 @@
+cmake_minimum_required(VERSION 3.16...3.27)
+
+project(rerun_template LANGUAGES CXX) # TODO
+
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+if(NOT DEFINED CMAKE_CXX_STANDARD)
+ set(CMAKE_CXX_STANDARD 17)
+endif()
+
+# Rerun:
+include(FetchContent)
+FetchContent_Declare(rerun_sdk URL https://github.com/rerun-io/rerun/releases/download/0.15.1/rerun_cpp_sdk.zip)
+FetchContent_MakeAvailable(rerun_sdk)
+
+add_executable(rerun_template src/main.cpp) # TODO
+target_link_libraries(rerun_template rerun_sdk) # TODO
+target_include_directories(rerun_template PRIVATE src) # TODO

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+ and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+ community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+ any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+ without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

Cargo.lock

@@ -0,0 +1,7 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 3
+
+[[package]]
+name = "rerun_template"
+version = "0.1.0"

Cargo.toml

@@ -0,0 +1,30 @@
+[package]
+authors = ["rerun.io <[email protected]>"]
+categories = [] # TODO
+description = "" # TODO
+edition = "2021"
+homepage = "https://github.com/rerun-io/rerun_template" # TODO
+include = ["LICENSE-APACHE", "LICENSE-MIT", "**/*.rs", "Cargo.toml"]
+keywords = [] # TODO
+license = "MIT OR Apache-2.0"
+name = "rerun_template" # TODO
+readme = "README.md"
+repository = "https://github.com/rerun-io/rerun_template" # TODO
+rust-version = "1.76"
+version = "0.1.0"
+
+[package.metadata.docs.rs]
+all-features = true
+
+
+[features]
+default = []
+
+
+[dependencies]
+
+
+[dev-dependencies]
+
+
+[patch.crates-io]

Cranky.toml

@@ -0,0 +1,166 @@
+# Copied from https://github.com/rerun-io/rerun_template
+#
+# https://github.com/ericseppanen/cargo-cranky
+# cargo install cargo-cranky && cargo cranky
+# See also clippy.toml
+
+deny = [
+ "unsafe_code",
+ #"clippy::self_named_module_files", # Disabled waiting on https://github.com/rust-lang/rust-clippy/issues/9602
+]
+
+warn = [
+ "clippy::all",
+ "clippy::as_ptr_cast_mut",
+ "clippy::await_holding_lock",
+ "clippy::bool_to_int_with_if",
+ "clippy::char_lit_as_u8",
+ "clippy::checked_conversions",
+ "clippy::clear_with_drain",
+ "clippy::cloned_instead_of_copied",
+ "clippy::cloned_instead_of_copied",
+ "clippy::dbg_macro",
+ "clippy::debug_assert_with_mut_call",
+ "clippy::derive_partial_eq_without_eq",
+ "clippy::disallowed_macros", # See clippy.toml
+ "clippy::disallowed_methods", # See clippy.toml
+ "clippy::disallowed_names", # See clippy.toml
+ "clippy::disallowed_script_idents", # See clippy.toml
+ "clippy::disallowed_types", # See clippy.toml
+ "clippy::doc_link_with_quotes",
+ "clippy::doc_markdown",
+ "clippy::empty_enum",
+ "clippy::enum_glob_use",
+ "clippy::equatable_if_let",
+ "clippy::exit",
+ "clippy::expl_impl_clone_on_copy",
+ "clippy::explicit_deref_methods",
+ "clippy::explicit_into_iter_loop",
+ "clippy::explicit_iter_loop",
+ "clippy::fallible_impl_from",
+ "clippy::filter_map_next",
+ "clippy::flat_map_option",
+ "clippy::float_cmp_const",
+ "clippy::fn_params_excessive_bools",
+ "clippy::fn_to_numeric_cast_any",
+ "clippy::from_iter_instead_of_collect",
+ "clippy::get_unwrap",
+ "clippy::if_let_mutex",
+ "clippy::implicit_clone",
+ "clippy::imprecise_flops",
+ "clippy::index_refutable_slice",
+ "clippy::inefficient_to_string",
+ "clippy::infinite_loop",
+ "clippy::into_iter_without_iter",
+ "clippy::invalid_upcast_comparisons",
+ "clippy::iter_not_returning_iterator",
+ "clippy::iter_on_empty_collections",
+ "clippy::iter_on_single_items",
+ "clippy::iter_over_hash_type",
+ "clippy::iter_without_into_iter",
+ "clippy::large_digit_groups",
+ "clippy::large_include_file",
+ "clippy::large_stack_arrays",
+ "clippy::large_stack_frames",
+ "clippy::large_types_passed_by_value",
+ "clippy::let_underscore_untyped",
+ "clippy::let_unit_value",
+ "clippy::linkedlist",
+ "clippy::lossy_float_literal",
+ "clippy::macro_use_imports",
+ "clippy::manual_assert",
+ "clippy::manual_clamp",
+ "clippy::manual_instant_elapsed",
+ "clippy::manual_let_else",
+ "clippy::manual_ok_or",
+ "clippy::manual_string_new",
+ "clippy::map_err_ignore",
+ "clippy::map_flatten",
+ "clippy::map_unwrap_or",
+ "clippy::match_on_vec_items",
+ "clippy::match_same_arms",
+ "clippy::match_wild_err_arm",
+ "clippy::match_wildcard_for_single_variants",
+ "clippy::mem_forget",
+ "clippy::mismatched_target_os",
+ "clippy::mismatching_type_param_order",
+ "clippy::missing_assert_message",
+ "clippy::missing_enforced_import_renames",
+ "clippy::missing_errors_doc",
+ "clippy::missing_safety_doc",
+ "clippy::mut_mut",
+ "clippy::mutex_integer",
+ "clippy::needless_borrow",
+ "clippy::needless_continue",
+ "clippy::needless_for_each",
+ "clippy::needless_pass_by_ref_mut",
+ "clippy::needless_pass_by_value",
+ "clippy::negative_feature_names",
+ "clippy::nonstandard_macro_braces",
+ "clippy::option_option",
+ "clippy::path_buf_push_overwrite",
+ "clippy::ptr_as_ptr",
+ "clippy::ptr_cast_constness",
+ "clippy::pub_without_shorthand",
+ "clippy::rc_mutex",
+ "clippy::readonly_write_lock",
+ "clippy::redundant_type_annotations",
+ "clippy::ref_option_ref",
+ "clippy::ref_patterns",
+ "clippy::rest_pat_in_fully_bound_structs",
+ "clippy::same_functions_in_if_condition",
+ "clippy::semicolon_if_nothing_returned",
+ "clippy::should_panic_without_expect",
+ "clippy::significant_drop_tightening",
+ "clippy::single_match_else",
+ "clippy::str_to_string",
+ "clippy::string_add_assign",
+ "clippy::string_add",
+ "clippy::string_lit_as_bytes",
+ "clippy::string_lit_chars_any",
+ "clippy::string_to_string",
+ "clippy::suspicious_command_arg_space",
+ "clippy::suspicious_xor_used_as_pow",
+ "clippy::todo",
+ "clippy::too_many_lines",
+ "clippy::trailing_empty_array",
+ "clippy::trait_duplication_in_bounds",
+ "clippy::tuple_array_conversions",
+ "clippy::unchecked_duration_subtraction",
+ "clippy::undocumented_unsafe_blocks",
+ "clippy::unimplemented",
+ "clippy::uninhabited_references",
+ "clippy::uninlined_format_args",
+ "clippy::unnecessary_box_returns",
+ "clippy::unnecessary_safety_doc",
+ "clippy::unnecessary_struct_initialization",
+ "clippy::unnecessary_wraps",
+ "clippy::unnested_or_patterns",
+ "clippy::unused_peekable",
+ "clippy::unused_rounding",
+ "clippy::unused_self",
+ "clippy::unwrap_used",
+ "clippy::useless_transmute",
+ "clippy::verbose_file_reads",
+ "clippy::wildcard_dependencies",
+ "clippy::wildcard_imports",
+ "clippy::zero_sized_map_values",
+ "elided_lifetimes_in_paths",
+ "future_incompatible",
+ "nonstandard_style",
+ "rust_2018_idioms",
+ "rust_2021_prelude_collisions",
+ "rustdoc::missing_crate_level_docs",
+ "semicolon_in_expressions_from_macros",
+ "trivial_casts",
+ "trivial_numeric_casts",
+ "unsafe_op_in_unsafe_fn", # `unsafe_op_in_unsafe_fn` may become the default in future Rust versions: https://github.com/rust-lang/rust/issues/71668
+ "unused_extern_crates",
+ "unused_import_braces",
+ "unused_lifetimes",
+ "unused_qualifications",
+]
+
+allow = [
+ "clippy::manual_range_contains", # this one is just worse imho
+]

LICENSE-APACHE

@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

LICENSE-MIT

@@ -0,0 +1,25 @@
+Copyright (c) 2024 Rerun Technologies AB <[email protected]>
+
+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.

README.md

@@ -0,0 +1,36 @@
+# Rerun template repository
+Template for our private and public repos, containing CI, CoC, etc
+
+When creating a new Rerun repository, use this as a template, then modify it as it makes sense.
+
+This template should be the default for any repository of any kind, including:
+* Rust projects
+* C++ projects
+* Python projects
+* Other stuff
+
+This template includes
+* License files
+* Code of Conduct
+* Helpers for checking and linting Rust code
+ - `cargo-cranky`
+ - `cargo-deny`
+ - `rust-toolchain`
+* CI for:
+ - Spell checking
+ - Link checking
+ - Rust checks
+
+
+## How to use
+Start by clicking "Use this template" at https://github.com/rerun-io/rerun_template/ or follow [these instructions](https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template).
+
+Then follow these steps:
+* Search and replace `rerun_template` with the name of the repository
+* Run `scripts/template_update.py init --languages cpp,rust,python` to delete files you don't need (give the languages you need support for)
+* Search for `TODO` and fill in all those places
+* Replace this `README.md` with something better
+* Commit!
+
+In the future you can always update this repository with the latest changes from the template by running:
+* `scripts/template_update.py update --languages cpp,rust,python`

bacon.toml

@@ -0,0 +1,70 @@
+# This is a configuration file for the bacon tool
+# More info at https://github.com/Canop/bacon
+
+default_job = "cranky"
+
+[jobs]
+
+[jobs.cranky]
+command = [
+ "cargo",
+ "cranky",
+ "--all-targets",
+ "--all-features",
+ "--color=always",
+]
+need_stdout = false
+watch = ["tests", "benches", "examples"]
+
+[jobs.check]
+command = [
+ "cargo",
+ "check",
+ "--all-targets",
+ "--all-features",
+ "--color=always",
+]
+need_stdout = false
+watch = ["tests", "benches", "examples"]
+
+[jobs.test]
+command = ["cargo", "test", "--color=always"]
+need_stdout = true
+watch = ["tests"]
+
+[jobs.doc]
+command = ["cargo", "doc", "--color=always", "--all-features", "--no-deps"]
+need_stdout = false
+
+# if the doc compiles, then it opens in your browser and bacon switches
+# to the previous job
+[jobs.doc-open]
+command = [
+ "cargo",
+ "doc",
+ "--color=always",
+ "--all-features",
+ "--no-deps",
+ "--open",
+]
+need_stdout = false
+on_success = "back" # so that we don't open the browser at each change
+
+# You can run your application and have the result displayed in bacon,
+# *if* it makes sense for this crate. You can run an example the same
+# way. Don't forget the `--color always` part or the errors won't be
+# properly parsed.
+[jobs.run]
+command = ["cargo", "run", "--color=always"]
+need_stdout = true
+
+# You may define here keybindings that would be specific to
+# a project, for example a shortcut to launch a specific job.
+# Shortcuts to internal functions (scrolling, toggling, etc.)
+# should go in your personal prefs.toml file instead.
+[keybindings]
+i = "job:initial"
+c = "job:cranky"
+d = "job:doc-open"
+t = "job:test"
+r = "job:run"

clippy.toml

@@ -0,0 +1,79 @@
+# Copied from https://github.com/rerun-io/rerun_template
+#
+# There is also a scripts/clippy_wasm/clippy.toml which forbids some methods that are not available in wasm.
+
+# -----------------------------------------------------------------------------
+# Section identical to scripts/clippy_wasm/clippy.toml:
+
+msrv = "1.76"
+
+allow-unwrap-in-tests = true
+
+# https://doc.rust-lang.org/nightly/clippy/lint_configuration.html#avoid-breaking-exported-api
+# We want suggestions, even if it changes public API.
+avoid-breaking-exported-api = false
+
+excessive-nesting-threshold = 8
+
+max-fn-params-bools = 1
+
+# https://rust-lang.github.io/rust-clippy/master/index.html#/large_include_file
+max-include-file-size = 1000000
+
+# https://rust-lang.github.io/rust-clippy/master/index.html#/large_stack_frames
+stack-size-threshold = 512000
+
+too-many-lines-threshold = 200
+
+# -----------------------------------------------------------------------------
+
+# https://rust-lang.github.io/rust-clippy/master/index.html#disallowed_macros
+disallowed-macros = ['dbg']
+
+# https://rust-lang.github.io/rust-clippy/master/index.html#disallowed_methods
+disallowed-methods = [
+ { path = "egui_extras::TableBody::row", reason = "`row` doesn't scale. Use `rows` instead." },
+ { path = "glam::Vec2::normalize", reason = "normalize() can create NaNs. Use try_normalize or normalize_or_zero" },
+ { path = "glam::Vec3::normalize", reason = "normalize() can create NaNs. Use try_normalize or normalize_or_zero" },
+ { path = "sha1::Digest::new", reason = "SHA1 is cryptographically broken" },
+ { path = "std::env::temp_dir", reason = "Use the tempdir crate instead" },
+ { path = "std::panic::catch_unwind", reason = "We compile with `panic = 'abort'`" },
+ { path = "std::thread::spawn", reason = "Use `std::thread::Builder` and name the thread" },
+
+ # There are many things that aren't allowed on wasm,
+ # but we cannot disable them all here (because of e.g. https://github.com/rust-lang/rust-clippy/issues/10406)
+ # so we do that in `scripts/clippy_wasm/clippy.toml` instead.
+]
+
+# https://rust-lang.github.io/rust-clippy/master/index.html#disallowed_names
+disallowed-names = []
+
+# https://rust-lang.github.io/rust-clippy/master/index.html#disallowed_types
+disallowed-types = [
+ { path = "ring::digest::SHA1_FOR_LEGACY_USE_ONLY", reason = "SHA1 is cryptographically broken" },
+
+ { path = "std::sync::Condvar", reason = "Use parking_lot instead" },
+ { path = "std::sync::Mutex", reason = "Use parking_lot instead" },
+ { path = "std::sync::RwLock", reason = "Use parking_lot instead" },
+
+ # "std::sync::Once", # enabled for now as the `log_once` macro uses it internally
+]
+
+# Allow-list of words for markdown in dosctrings https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
+doc-valid-idents = [
+ # You must also update the same list in `scripts/clippy_wasm/clippy.toml`!
+ "GitHub",
+ "GLB",
+ "GLTF",
+ "iOS",
+ "macOS",
+ "NaN",
+ "OBJ",
+ "OpenGL",
+ "PyPI",
+ "sRGB",
+ "sRGBA",
+ "WebGL",
+ "WebSocket",
+ "WebSockets",
+]

deny.toml

@@ -0,0 +1,85 @@
+# Copied from https://github.com/rerun-io/rerun_template
+#
+# https://github.com/EmbarkStudios/cargo-deny
+#
+# cargo-deny checks our dependency tree for copy-left licenses,
+# duplicate dependencies, and rustsec advisories (https://rustsec.org/advisories).
+#
+# Install: `cargo install cargo-deny`
+# Check: `cargo deny check`.
+
+
+# Note: running just `cargo deny check` without a `--target` can result in
+# false positives due to https://github.com/EmbarkStudios/cargo-deny/issues/324
+[graph]
+targets = [
+ { triple = "aarch64-apple-darwin" },
+ { triple = "i686-pc-windows-gnu" },
+ { triple = "i686-pc-windows-msvc" },
+ { triple = "i686-unknown-linux-gnu" },
+ { triple = "wasm32-unknown-unknown" },
+ { triple = "x86_64-apple-darwin" },
+ { triple = "x86_64-pc-windows-gnu" },
+ { triple = "x86_64-pc-windows-msvc" },
+ { triple = "x86_64-unknown-linux-gnu" },
+ { triple = "x86_64-unknown-linux-musl" },
+ { triple = "x86_64-unknown-redox" },
+]
+all-features = true
+
+
+[advisories]
+version = 2
+ignore = [
+ "RUSTSEC-2023-0081", # TODO(#5998): unmaintained crate "safemem" pulled in by "cargo-run-wasm"
+]
+
+
+[bans]
+multiple-versions = "deny"
+wildcards = "allow" # We use them for examples
+deny = []
+skip = []
+skip-tree = []
+
+
+[licenses]
+version = 2
+private = { ignore = true }
+confidence-threshold = 0.93 # We want really high confidence when inferring licenses from text
+allow = [
+ "Apache-2.0 WITH LLVM-exception", # https://spdx.org/licenses/LLVM-exception.html
+ "Apache-2.0", # https://tldrlegal.com/license/apache-license-2.0-(apache-2.0)
+ "BSD-2-Clause", # https://tldrlegal.com/license/bsd-2-clause-license-(freebsd)
+ "BSD-3-Clause", # https://tldrlegal.com/license/bsd-3-clause-license-(revised)
+ "BSL-1.0", # https://tldrlegal.com/license/boost-software-license-1.0-explained
+ "CC0-1.0", # https://creativecommons.org/publicdomain/zero/1.0/
+ "ISC", # https://www.tldrlegal.com/license/isc-license
+ "LicenseRef-UFL-1.0", # See https://github.com/emilk/egui/issues/2321
+ "MIT-0", # https://choosealicense.com/licenses/mit-0/
+ "MIT", # https://tldrlegal.com/license/mit-license
+ "MPL-2.0", # https://www.mozilla.org/en-US/MPL/2.0/FAQ/ - see Q11. Used by webpki-roots on Linux.
+ "OFL-1.1", # https://spdx.org/licenses/OFL-1.1.html
+ "OpenSSL", # https://www.openssl.org/source/license.html - used on Linux
+ "Unicode-DFS-2016", # https://spdx.org/licenses/Unicode-DFS-2016.html
+ "Zlib", # https://tldrlegal.com/license/zlib-libpng-license-(zlib)
+]
+exceptions = []
+
+[[licenses.clarify]]
+name = "webpki"
+expression = "ISC"
+license-files = [{ path = "LICENSE", hash = 0x001c7e6c }]
+
+[[licenses.clarify]]
+name = "ring"
+expression = "MIT AND ISC AND OpenSSL"
+license-files = [{ path = "LICENSE", hash = 0xbd0eed23 }]
+
+
+[sources]
+unknown-registry = "deny"
+unknown-git = "deny"
+
+[sources.allow-org]
+github = ["emilk", "rerun-io"]

lychee.toml

@@ -0,0 +1,111 @@
+# Copied from https://github.com/rerun-io/rerun_template
+
+################################################################################
+# Config for the link checker lychee.
+#
+# Download & learn more at:
+# https://github.com/lycheeverse/lychee
+#
+# Example config:
+# https://github.com/lycheeverse/lychee/blob/master/lychee.example.toml
+#
+# Run `lychee . --dump` to list all found links that are being checked.
+#
+# Note that by default lychee will only check markdown and html files,
+# to check any other files you have to point to them explicitly, e.g.:
+# `lychee **/*.rs`
+# To make things worse, `exclude_path` is ignored for these globs,
+# so local runs with lots of gitignored files will be slow.
+# (https://github.com/lycheeverse/lychee/issues/1405)
+#
+# This unfortunately doesn't list anything for non-glob checks.
+################################################################################
+
+# Maximum number of concurrent link checks.
+# Workaround for "too many open files" error on MacOS, see https://github.com/lycheeverse/lychee/issues/1248
+max_concurrency = 32
+
+# Check links inside `<code>` and `<pre>` blocks as well as Markdown code blocks.
+include_verbatim = true
+
+# Proceed for server connections considered insecure (invalid TLS).
+insecure = true
+
+# Exclude these filesystem paths from getting checked.
+exclude_path = [
+ # Unfortunately lychee doesn't yet read .gitignore https://github.com/lycheeverse/lychee/issues/1331
+ # The following entries are there because of that:
+ ".git",
+ "__pycache__",
+ "_deps/",
+ ".pixi",
+ "build",
+ "target_ra",
+ "target_wasm",
+ "target",
+ "venv",
+]
+
+# Exclude URLs and mail addresses from checking (supports regex).
+exclude = [
+ # Skip speculative links
+ '.*?speculative-link',
+
+ # Strings with replacements.
+ '/__VIEWER_VERSION__/', # Replacement variable __VIEWER_VERSION__.
+ '/\$', # Replacement variable $.
+ '/GIT_HASH/', # Replacement variable GIT_HASH.
+ '\{\}', # Ignore links with string interpolation.
+ '\$relpath\^', # Relative paths as used by rerun_cpp's doc header.
+ '%7B.+%7D', # Ignore strings that look like ready to use links but contain a replacement strings. The URL escaping is for '{.+}' (this seems to be needed for html embedded urls since lychee assumes they use this encoding).
+ '%7B%7D', # Ignore links with string interpolation, escaped variant.
+
+ # Local links that require further setup.
+ 'http://127.0.0.1',
+ 'http://localhost',
+ 'recording:/', # rrd recording link.
+ 'ws:/',
+ 're_viewer.js', # Build artifact that html is linking to.
+
+ # Api endpoints.
+ 'https://fonts.googleapis.com/', # Font API entrypoint, not a link.
+ 'https://fonts.gstatic.com/', # Font API entrypoint, not a link.
+ 'https://tel.rerun.io/', # Analytics endpoint.
+
+ # Avoid rate limiting.
+ 'https://crates.io/crates/.*', # Avoid crates.io rate-limiting
+ 'https://github.com/rerun-io/rerun/commit/\.*', # Ignore links to our own commits (typically in changelog).
+ 'https://github.com/rerun-io/rerun/pull/\.*', # Ignore links to our own pull requests (typically in changelog).
+
+ # Intentionally faked links.
+ 'file://foo',
+ 'http://foo.com/',
+ 'https://link.to',
+ 'https://static.rerun.io/my_screenshot/',
+
+ # Link fragments and data links in examples.
+ 'https://raw.githubusercontent.com/googlefonts/noto-emoji/', # URL fragment.
+ 'https://static.rerun.io/rgbd_dataset', # Base data link for rgbd dataset.
+ 'https://storage.googleapis.com/', # Storage API entrypoint, not a link.
+
+ # Not accessible from CI.
+ '.github/workflows/.*.yml', # GitHub action workflows cause issues on CI.
+ 'https://stackoverflow.com/.', # Stackoverflow links are no longer accessible from CI.
+ 'https://www.tensorflow.org/', # tensorflow.org apparently blocks CI.
+ 'https://9p.io/sys/doc/lexnames.html', # Works locally but on ci we get: `Failed: Network error: error:0A000152:SSL routines:final_renegotiate:unsafe legacy renegotiation disabled:ssl/statem/extensions.c:946:`
+
+ # Need GitHub login.
+ 'https://github.com/rerun-io/landing',
+ 'https://github.com/rerun-io/documentation',
+
+ # Temporarily down or not accessible.
+ 'https://cs.nyu.edu/~silberman/datasets/nyu_depth_v2.html', # Nyud links are down every now and then.
+ 'https://eigen.tuxfamily.org/', # Website down https://gitlab.com/libeigen/eigen/-/issues/2804
+ 'https://github.com/rerun-io/rerun/releases/download/prerelease', # Pre-release downloads may go down while a pre-release updates or pre-release CI partially breaks.
+
+ # Works but is really slow at times:
+ 'https://openaccess.thecvf.com/content/CVPR2023/html/Du_Learning_To_Render_Novel_Views_From_Wide-Baseline_Stereo_Pairs_CVPR_2023_paper.html',
+ 'https://anaconda.org/conda-forge/arrow-cpp',
+
+ #'^file:///', # Ignore local file links. They need to be tested, but it's useful for external links we have to ping.
+]

pixi.toml

@@ -0,0 +1,69 @@
+# Pixi is a package management tool for developers.
+# Before running a task, pixi ensures that all listed dependencies are installed first.echop
+#
+# Pixi is not required for rerun, but it is a convenient way to install the
+# dependencies required for this example.
+#
+# https://prefix.dev/docs/pixi/overview
+#
+# Use `pixi task list` to list the available tasks,
+# and `pixi run TASK` to run it (e.g. `pixi run example`).
+
+[project]
+name = "rerun_template" # TODO
+authors = ["rerun.io <[email protected]>"]
+channels = ["conda-forge"]
+description = "rerun_template" # TODO
+homepage = "https://rerun.io"
+license = "MIT OR Apache-2.0"
+
+platforms = ["linux-64", "linux-aarch64", "osx-arm64", "osx-64", "win-64"]
+readme = "README.md"
+repository = "https://github.com/rerun-io/rerun_template" # TODO
+version = "0.1.0"
+
+
+[tasks]
+# ------------------------------------------------------------------------------------------
+# C++ stuff:
+# Note: extra CLI argument after `pixi run TASK` are passed to the task cmd.
+
+# Clean C++ build artifacts
+clean = { cmd = "rm -rf build bin CMakeFiles/" }
+print-env = { cmd = "echo $PATH" }
+prepare = "cmake -G 'Ninja' -B build -S . -DCMAKE_BUILD_TYPE=RelWithDebInfo"
+
+# Build C++ example
+build = { cmd = "cmake --build build --config RelWithDebInfo --target all", depends_on = [
+ "prepare",
+] }
+
+# Run C++ example
+example = { cmd = "build/rerun_template", depends_on = ["build"] }
+
+# Format C++ code
+cpp-fmt = { cmd = "clang-format -i src/*.[hc]pp" }
+
+# Check formatting of C++ code
+cpp-fmt-check = { cmd = "clang-format --dry-run --Werror -i src/*.[hc]pp" }
+
+# ------------------------------------------------------------------------------------------
+# Python stuff:
+
+# Run first ruff fix, then ruff format, order is important see also https://twitter.com/charliermarsh/status/1717229721954799727
+py-fmt = "ruff check --fix --config pyproject.toml . && ruff format --config pyproject.toml ."
+py-fmt-check = "ruff check --config pyproject.toml . && ruff format --check --config pyproject.toml"
+py-lint = "mypy --install-types --non-interactive --no-warn-unused-ignore"
+
+[dependencies]
+# C++ build-tools:
+cmake = "3.27.6"
+clang-tools = ">=15,<16" # clang-format
+cxx-compiler = "1.6.0.*"
+ninja = "1.11.1"
+
+# Python stuff:
+mypy = "1.8.0"
+ruff = "0.3.7"
+
+types-requests = ">=2.31,<3" # mypy type hint stubs for generate_changelog.py

pyproject.toml

@@ -0,0 +1,70 @@
+# Copied from https://github.com/rerun-io/rerun_template
+
+[tool.ruff]
+# https://beta.ruff.rs/docs/configuration/
+
+target-version = "py38"
+
+# Enable unsafe fixes to allow ruff to apply fixes that may change the behavior of the code.
+# This is needed because otherwise ruff will not be able to trim whitespaces in (codegened) docstrings.
+unsafe-fixes = true
+
+# Allow preview lints to be enabled (like `PLW1514` to force `encoding` on open).
+preview = true
+# But we only want to opt-in to certain preview rules!
+lint.explicit-preview-rules = true
+
+extend-exclude = [
+ # Automatically generated test artifacts
+ "venv/",
+ "target/",
+]
+
+lint.ignore = [
+ # Missing docstring in public function - TODO(emilk): enable for SDK but not for examples
+ "D1",
+
+ # No blank lines allowed after function docstring.
+ "D202",
+
+ # npydocstyle: http://www.pydocstyle.org/en/stable/error_codes.html
+ # numpy convention with a few additional lints
+ "D107",
+ "D203",
+ "D212",
+ "D401",
+ "D402",
+ "D415",
+ "D416",
+
+ # Ruff can't fix this error on its own (yet)
+ # Having ruff check this causes errors that prevent the code-formatting process from completing.
+ "E501",
+
+ # allow relative imports
+ "TID252",
+
+ "UP007", # We need this, or `ruff format` will convert `Union[X, Y]` to `X | Y` which break on Python 3.8
+]
+
+line-length = 120
+lint.select = [
+ "D", # pydocstyle codes https://www.pydocstyle.org/en/latest/error_codes.html
+ "E", # pycodestyle error codes: https://pycodestyle.pycqa.org/en/latest/intro.html#error-codes
+ "F", # Flake8 error codes https://flake8.pycqa.org/en/latest/user/error-codes.html
+ "I", # Isort
+ "TID", # flake8-tidy-imports
+ "W", # pycodestyle warning codes: https://pycodestyle.pycqa.org/en/latest/intro.html#error-codes
+ "UP", # pyupgrade (ensures idomatic code for supported python version)
+ "PLW1514", # Force setting `encoding` for open calls. This is in order to prevent issues when opening utf8 files on windows where the default encoding may depend on the active locale. https://docs.astral.sh/ruff/rules/unspecified-encoding/
+]
+
+lint.unfixable = [
+ "PLW1514", # Automatic fix for `encoding` doesn't do what we want - it queries the locale for the preferred encoding which is exactly what we want to avoid.
+]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401", "F403"]
+
+[tool.ruff.lint.isort]
+required-imports = ["from __future__ import annotations"]

rust-toolchain

@@ -0,0 +1,10 @@
+# If you see this, run "rustup self update" to get rustup 1.23 or newer.
+
+# NOTE: above comment is for older `rustup` (before TOML support was added),
+# which will treat the first line as the toolchain name, and therefore show it
+# to the user in the error, instead of "error: invalid channel name '[toolchain]'".
+
+[toolchain]
+channel = "1.76.0"
+components = ["rustfmt", "clippy"]
+targets = ["wasm32-unknown-unknown"]

scripts/clippy_wasm/clippy.toml

@@ -0,0 +1,75 @@
+# Copied from https://github.com/rerun-io/rerun_template
+
+# This is used by the CI so we can forbid some methods that are not available in wasm.
+#
+# We cannot forbid all these methods in the main `clippy.toml` because of
+# https://github.com/rust-lang/rust-clippy/issues/10406
+
+# -----------------------------------------------------------------------------
+# Section identical to the main clippy.toml:
+
+msrv = "1.76"
+
+allow-unwrap-in-tests = true
+
+# https://doc.rust-lang.org/nightly/clippy/lint_configuration.html#avoid-breaking-exported-api
+# We want suggestions, even if it changes public API.
+avoid-breaking-exported-api = false
+
+excessive-nesting-threshold = 8
+
+max-fn-params-bools = 1
+
+# https://rust-lang.github.io/rust-clippy/master/index.html#/large_include_file
+max-include-file-size = 1000000
+
+too-many-lines-threshold = 200
+
+# -----------------------------------------------------------------------------
+
+# https://rust-lang.github.io/rust-clippy/master/index.html#disallowed_methods
+disallowed-methods = [
+ { path = "crossbeam::channel::Receiver::into_iter", reason = "Cannot block on Web" },
+ { path = "crossbeam::channel::Receiver::iter", reason = "Cannot block on Web" },
+ { path = "crossbeam::channel::Receiver::recv_timeout", reason = "Cannot block on Web" },
+ { path = "crossbeam::channel::Receiver::recv", reason = "Cannot block on Web" },
+ { path = "poll_promise::Promise::block_and_take", reason = "Cannot block on Web" },
+ { path = "poll_promise::Promise::block_until_ready_mut", reason = "Cannot block on Web" },
+ { path = "poll_promise::Promise::block_until_ready", reason = "Cannot block on Web" },
+ { path = "rayon::spawn", reason = "Cannot spawn threads on wasm" },
+ { path = "std::sync::mpsc::Receiver::into_iter", reason = "Cannot block on Web" },
+ { path = "std::sync::mpsc::Receiver::iter", reason = "Cannot block on Web" },
+ { path = "std::sync::mpsc::Receiver::recv_timeout", reason = "Cannot block on Web" },
+ { path = "std::sync::mpsc::Receiver::recv", reason = "Cannot block on Web" },
+ { path = "std::thread::spawn", reason = "Cannot spawn threads on wasm" },
+ { path = "std::time::Duration::elapsed", reason = "use `web-time` crate instead for wasm/web compatibility" },
+ { path = "std::time::Instant::now", reason = "use `web-time` crate instead for wasm/web compatibility" },
+ { path = "std::time::SystemTime::now", reason = "use `web-time` or `time` crates instead for wasm/web compatibility" },
+]
+
+# https://rust-lang.github.io/rust-clippy/master/index.html#disallowed_types
+disallowed-types = [
+ { path = "instant::SystemTime", reason = "Known bugs. Use web-time." },
+ { path = "std::thread::Builder", reason = "Cannot spawn threads on wasm" },
+ # { path = "std::path::PathBuf", reason = "Can't read/write files on web" }, // Used in build.rs files (which is fine).
+]
+
+# Allow-list of words for markdown in dosctrings https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
+doc-valid-idents = [
+ # You must also update the same list in the root `clippy.toml`!
+ "..",
+ "GitHub",
+ "GLB",
+ "GLTF",
+ "iOS",
+ "macOS",
+ "NaN",
+ "OBJ",
+ "OpenGL",
+ "PyPI",
+ "sRGB",
+ "sRGBA",
+ "WebGL",
+ "WebSocket",
+ "WebSockets",
+]

scripts/generate_changelog.py

@@ -0,0 +1,191 @@
+#!/usr/bin/env python3
+# Copied from https://github.com/rerun-io/rerun_template
+
+"""
+Summarizes recent PRs based on their GitHub labels.
+
+The result can be copy-pasted into CHANGELOG.md,
+though it often needs some manual editing too.
+"""
+
+from __future__ import annotations
+
+import argparse
+import multiprocessing
+import os
+import re
+import sys
+from dataclasses import dataclass
+from typing import Any, Optional
+
+import requests
+from git import Repo # pip install GitPython
+from tqdm import tqdm
+
+OWNER = "rerun-io"
+REPO = "rerun_template" # TODO: Change this to the name of the repo
+INCLUDE_LABELS = False # It adds quite a bit of visual noise
+OFFICIAL_RERUN_DEVS = [
+ "abey79",
+ "emilk",
+ "jleibs",
+ "jprochazk",
+ "nikolausWest",
+ "teh-cmc",
+ "Wumpf",
+]
+
+
+@dataclass
+class PrInfo:
+ gh_user_name: str
+ pr_title: str
+ labels: list[str]
+
+
+@dataclass
+class CommitInfo:
+ hexsha: str
+ title: str
+ pr_number: Optional[int]
+
+
+def get_github_token() -> str:
+ token = os.environ.get("GH_ACCESS_TOKEN", "")
+ if token != "":
+ return token
+
+ home_dir = os.path.expanduser("~")
+ token_file = os.path.join(home_dir, ".githubtoken")
+
+ try:
+ with open(token_file, encoding="utf8") as f:
+ token = f.read().strip()
+ return token
+ except Exception:
+ pass
+
+ print("ERROR: expected a GitHub token in the environment variable GH_ACCESS_TOKEN or in ~/.githubtoken")
+ sys.exit(1)
+
+
+# Slow
+def fetch_pr_info_from_commit_info(commit_info: CommitInfo) -> Optional[PrInfo]:
+ if commit_info.pr_number is None:
+ return None
+ else:
+ return fetch_pr_info(commit_info.pr_number)
+
+
+# Slow
+def fetch_pr_info(pr_number: int) -> Optional[PrInfo]:
+ url = f"https://api.github.com/repos/{OWNER}/{REPO}/pulls/{pr_number}"
+ gh_access_token = get_github_token()
+ headers = {"Authorization": f"Token {gh_access_token}"}
+ response = requests.get(url, headers=headers)
+ json = response.json()
+
+ # Check if the request was successful (status code 200)
+ if response.status_code == 200:
+ labels = [label["name"] for label in json["labels"]]
+ gh_user_name = json["user"]["login"]
+ return PrInfo(gh_user_name=gh_user_name, pr_title=json["title"], labels=labels)
+ else:
+ print(f"ERROR {url}: {response.status_code} - {json['message']}")
+ return None
+
+
+def get_commit_info(commit: Any) -> CommitInfo:
+ match = re.match(r"(.*) \(#(\d+)\)", commit.summary)
+ if match:
+ title = str(match.group(1))
+ pr_number = int(match.group(2))
+ return CommitInfo(hexsha=commit.hexsha, title=title, pr_number=pr_number)
+ else:
+ return CommitInfo(hexsha=commit.hexsha, title=commit.summary, pr_number=None)
+
+
+def remove_prefix(text: str, prefix: str) -> str:
+ if text.startswith(prefix):
+ return text[len(prefix) :]
+ return text # or whatever
+
+
+def print_section(crate: str, items: list[str]) -> None:
+ if 0 < len(items):
+ print(f"#### {crate}")
+ for line in items:
+ print(f"* {line}")
+ print()
+
+
+def main() -> None:
+ parser = argparse.ArgumentParser(description="Generate a changelog.")
+ parser.add_argument("--commit-range", help="e.g. 0.1.0..HEAD", required=True)
+ args = parser.parse_args()
+
+ repo = Repo(".")
+ commits = list(repo.iter_commits(args.commit_range))
+ commits.reverse() # Most recent last
+ commit_infos = list(map(get_commit_info, commits))
+
+ pool = multiprocessing.Pool()
+ pr_infos = list(
+ tqdm(
+ pool.imap(fetch_pr_info_from_commit_info, commit_infos),
+ total=len(commit_infos),
+ desc="Fetch PR info commits",
+ )
+ )
+
+ prs = []
+ unsorted_commits = []
+
+ for commit_info, pr_info in zip(commit_infos, pr_infos):
+ hexsha = commit_info.hexsha
+ title = commit_info.title
+ title = title.rstrip(".").strip() # Some PR end with an unnecessary period
+ pr_number = commit_info.pr_number
+
+ if pr_number is None:
+ # Someone committed straight to main:
+ summary = f"{title} [{hexsha[:7]}](https://github.com/{OWNER}/{REPO}/commit/{hexsha})"
+ unsorted_commits.append(summary)
+ else:
+ # We prefer the PR title if available
+ title = pr_info.pr_title if pr_info else title
+ labels = pr_info.labels if pr_info else []
+
+ if "exclude from changelog" in labels:
+ continue
+ if "typo" in labels:
+ # We get so many typo PRs. Let's not flood the changelog with them.
+ continue
+
+ summary = f"{title} [#{pr_number}](https://github.com/{OWNER}/{REPO}/pull/{pr_number})"
+
+ if INCLUDE_LABELS and 0 < len(labels):
+ summary += f" ({', '.join(labels)})"
+
+ if pr_info is not None:
+ gh_user_name = pr_info.gh_user_name
+ if gh_user_name not in OFFICIAL_RERUN_DEVS:
+ summary += f" (thanks [@{gh_user_name}](https://github.com/{gh_user_name})!)"
+
+ prs.append(summary)
+
+ # Clean up:
+ for i in range(len(prs)):
+ line = prs[i]
+ line = line[0].upper() + line[1:] # Upper-case first letter
+ prs[i] = line
+
+ print()
+ print(f"Full diff at https://github.com/rerun-io/{REPO}/compare/{args.commit_range}")
+ print()
+ print_section("PRs", prs)
+ print_section("Unsorted commits", unsorted_commits)
+
+
+if __name__ == "__main__":
+ main()

scripts/template_update.py

@@ -0,0 +1,164 @@
+#!/usr/bin/env python3
+# Copied from https://github.com/rerun-io/rerun_template
+
+"""
+The script has two purposes.
+
+After using `rerun_template` as a template, run this to clean out things you don't need.
+Use `scripts/template_update.py init --languages cpp,rust,python` for this.
+
+Update an existing repository with the latest changes from the template.
+Use `scripts/template_update.py update --languages cpp,rust,python` for this.
+
+In either case, make sure the list of languages matches the languages you want to support.
+You can also use `--dry-run` to see what would happen without actually changing anything.
+"""
+
+from __future__ import annotations
+
+import argparse
+import os
+import shutil
+import tempfile
+
+from git import Repo
+
+OWNER = "rerun-io"
+
+# Files requires by C++, but not by both Python or Rust.
+CPP_FILES = {
+ ".clang-format",
+ ".github/workflows/cpp.yml",
+ "CMakeLists.txt",
+ "pixi.lock", # Not needed by Rust
+ "pixi.toml", # Not needed by Rust
+ "src/main.cpp",
+ "src/",
+}
+
+# Files requires by Python, but not by both C++ or Rust
+PYTHON_FILES = {
+ ".github/workflows/python.yml",
+ ".mypy.ini",
+ "pixi.lock", # Not needed by Rust
+ "pixi.toml", # Not needed by Rust
+ "pyproject.toml",
+}
+
+# Files requires by Rust, but not by both C++ or Python
+RUST_FILES = {
+ ".github/workflows/rust.yml",
+ "bacon.toml",
+ "Cargo.lock",
+ "Cargo.toml",
+ "clippy.toml",
+ "Cranky.toml",
+ "deny.toml",
+ "rust-toolchain",
+ "scripts/clippy_wasm/",
+ "scripts/clippy_wasm/clippy.toml",
+ "src/lib.rs",
+ "src/main.rs",
+ "src/",
+}
+
+
+def parse_languages(lang_str: str) -> set[str]:
+ languages = lang_str.split(",") if lang_str else []
+ for lang in languages:
+ assert lang in ["cpp", "python", "rust"], f"Unsupported language: {lang}"
+ return set(languages)
+
+
+def calc_deny_set(languages: set[str]) -> set[str]:
+ """The set of files to delete/ignore."""
+ files_to_delete = CPP_FILES | PYTHON_FILES | RUST_FILES
+ if "cpp" in languages:
+ files_to_delete -= CPP_FILES
+ if "python" in languages:
+ files_to_delete -= PYTHON_FILES
+ if "rust" in languages:
+ files_to_delete -= RUST_FILES
+ return files_to_delete
+
+
+def init(languages: set[str], dry_run: bool) -> None:
+ print("Removing all language-specific files not needed for languages {languages}.")
+ files_to_delete = calc_deny_set(languages)
+ delete_files_and_folder(files_to_delete, dry_run)
+
+
+def delete_files_and_folder(paths: set[str], dry_run: bool) -> None:
+ repo_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
+ for path in paths:
+ full_path = os.path.join(repo_path, path)
+ if os.path.exists(full_path):
+ if os.path.isfile(full_path):
+ print(f"Removing file {full_path}…")
+ if not dry_run:
+ os.remove(full_path)
+ elif os.path.isdir(full_path):
+ print(f"Removing folder {full_path}…")
+ if not dry_run:
+ shutil.rmtree(full_path)
+
+
+def update(languages: set[str], dry_run: bool) -> None:
+ files_to_ignore = calc_deny_set(languages)
+ repo_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
+
+ with tempfile.TemporaryDirectory() as temp_dir:
+ Repo.clone_from("https://github.com/rerun-io/rerun_template.git", temp_dir)
+ for root, dirs, files in os.walk(temp_dir):
+ for file in files:
+ src_path = os.path.join(root, file)
+ rel_path = os.path.relpath(src_path, temp_dir)
+
+ if rel_path.startswith(".git/"):
+ continue
+ if rel_path.startswith("src/"):
+ continue
+
+ if rel_path in {"README.md", "pixi.lock", "Cargo.lock"}:
+ continue
+
+ if rel_path not in files_to_ignore:
+ dest_path = os.path.join(repo_path, rel_path)
+
+ print(f"Updating {rel_path}…")
+ if not dry_run:
+ os.makedirs(os.path.dirname(dest_path), exist_ok=True)
+ shutil.copy2(src_path, dest_path)
+
+
+def main() -> None:
+ parser = argparse.ArgumentParser(description="Handle the Rerun template.")
+ subparsers = parser.add_subparsers(dest="command")
+
+ init_parser = subparsers.add_parser("init", help="Initialize a new checkout of the template.")
+ init_parser.add_argument(
+ "--languages", default="", nargs="?", const="", help="The languages to support (e.g. `cpp,python,rust`)."
+ )
+ init_parser.add_argument("--dry-run", action="store_true", help="Don't actually delete any files.")
+
+ update_parser = subparsers.add_parser(
+ "update", help="Update all existing Rerun repositories with the latest changes from the template"
+ )
+ update_parser.add_argument(
+ "--languages", default="", nargs="?", const="", help="The languages to support (e.g. `cpp,python,rust`)."
+ )
+ update_parser.add_argument("--dry-run", action="store_true", help="Don't actually delete any files.")
+
+ args = parser.parse_args()
+
+ if args.command == "init":
+ init(parse_languages(args.languages), args.dry_run)
+ elif args.command == "update":
+ update(parse_languages(args.languages), args.dry_run)
+ else:
+ parser.print_help()
+ exit(1)
+
+
+if __name__ == "__main__":
+ main()

src/lib.rs

@@ -0,0 +1 @@
+

src/main.cpp

@@ -0,0 +1,8 @@
+#include <cstdio>
+
+#include <rerun.hpp>
+
+int main(int argc, const char* argv[]) {
+ printf("Hello, World!\n");
+ return 0;
+}

src/main.rs

@@ -0,0 +1,3 @@
+fn main() {
+ println!("Hello, rerun_template!");
+}