Skip to content

Commit b9d70cd

Browse files
emilkWumpf
emilk
and
Wumpf
authored
Prepare crates for publishing (#1197)
* Link to the CODE_OF_CONDUCT.md * Add publish=true to the crates that are going to be published * Add authors.workspace = true * Add readme, repository, and homepage to all published crates * Each crate must have its own README.md * Document re_memory better * Update descriptions and README.md:s for all the different crates * Missing license field for re_viewer * tweak re_memory/README.md Co-authored-by: Andreas Reich <andreas@rerun.io> * Expand some README.md:s --------- Co-authored-by: Andreas Reich <andreas@rerun.io>
1 parent 93c6052 commit b9d70cd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+317
-123
lines changed

‎ARCHITECTURE.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ This document describes the technical architecture of Rerun.
33

44
## See also
55
* [`BUILD.md`](BUILD.md)
6+
* [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md)
67
* [`CODE_STYLE.md`](CODE_STYLE.md)
78
* [`CONTRIBUTING.md`](CONTRIBUTING.md)
89
* [`RELEASES.md`](RELEASES.md)

‎BUILD.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ This is a guide to how to build Rerun.
44

55
## See also
66
* [`ARCHITECTURE.md`](ARCHITECTURE.md)
7+
* [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md)
78
* [`CODE_STYLE.md`](CODE_STYLE.md)
89
* [`CONTRIBUTING.md`](CONTRIBUTING.md)
910
* [`RELEASES.md`](RELEASES.md)

‎CODE_OF_CONDUCT.md

-1
Original file line numberDiff line numberDiff line change
@@ -130,4 +130,3 @@ For answers to common questions about this code of conduct, see the FAQ at
130130
[Mozilla CoC]: https://github.com/mozilla/diversity
131131
[FAQ]: https://www.contributor-covenant.org/faq
132132
[translations]: https://www.contributor-covenant.org/translations
133-

‎CODE_STYLE.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## See also
44
* [`ARCHITECTURE.md`](ARCHITECTURE.md)
55
* [`BUILD.md`](BUILD.md)
6+
* [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md)
67
* [`CONTRIBUTING.md`](CONTRIBUTING.md)
78
* [`RELEASES.md`](RELEASES.md)
89

‎CONTRIBUTING.md

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ This is written for anyone who wants to contribute to the Rerun repository.
55
## See also
66
* [`ARCHITECTURE.md`](ARCHITECTURE.md)
77
* [`BUILD.md`](BUILD.md)
8+
* [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md)
89
* [`CODE_STYLE.md`](CODE_STYLE.md)
910
* [`RELEASES.md`](RELEASES.md)
1011

‎Cargo.toml

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ members = [
1111
]
1212

1313
[workspace.package]
14-
version = "0.1.0"
14+
authors = ["rerun.io <opensource@rerun.io>"]
1515
edition = "2021"
16-
rust-version = "1.67"
17-
license = "MIT OR Apache-2.0"
1816
homepage = "http://rerun.io"
19-
readme = "README.md"
17+
license = "MIT OR Apache-2.0"
2018
repository = "https://github.com/rerun-io/rerun"
19+
rust-version = "1.67"
20+
version = "0.1.0"
2121

2222
[workspace.dependencies]
2323
anyhow = "1.0"

‎README.md

+1
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ The Rerun open source project targets the needs of individual developers. The co
8080
# Development
8181
* [`ARCHITECTURE.md`](ARCHITECTURE.md)
8282
* [`BUILD.md`](BUILD.md)
83+
* [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md)
8384
* [`CODE_STYLE.md`](CODE_STYLE.md)
8485
* [`CONTRIBUTING.md`](CONTRIBUTING.md)
8586
* [`RELEASES.md`](RELEASES.md)

‎RELEASES.md

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ This document describes the current release and versioning strategy. This strate
55
## See also
66
* [`ARCHITECTURE.md`](ARCHITECTURE.md)
77
* [`BUILD.md`](BUILD.md)
8+
* [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md)
89
* [`CODE_STYLE.md`](CODE_STYLE.md)
910
* [`CONTRIBUTING.md`](CONTRIBUTING.md)
1011

‎crates/re_analytics/Cargo.toml

+8-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
[package]
22
name = "re_analytics"
3-
version.workspace = true
3+
authors.workspace = true
4+
description = "Rerun's analytics SDK"
45
edition.workspace = true
5-
rust-version.workspace = true
6+
homepage.workspace = true
67
license.workspace = true
7-
publish = false
8+
publish = true
9+
readme = "README.md"
10+
repository.workspace = true
11+
rust-version.workspace = true
12+
version.workspace = true
813

914

1015
[dependencies]

‎crates/re_analytics/README.md

+41-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,41 @@
1-
Rerun's analytics SDK.
1+
# Rerun's analytics SDK
2+
3+
We use [PostHog](https://posthog.com/) to collect anonymous usage statistics.
4+
5+
Usage data we do collect will be sent to and stored in servers within the EU.
6+
7+
You can audit the actual data being sent out by inspecting the Rerun data directory directly.
8+
Find out its location by running `rerun analytics config`.
9+
10+
11+
### Opting out
12+
Run `rerun analytics disable` to opt out of all usage data collection.
13+
14+
### What data is collected?
15+
The exact set of analytics events and parameters can be found here: <https://github.com/rerun-io/rerun/blob/main/crates/re_analytics/src/events.rs>
16+
17+
- We collect high level events about the usage of the Rerun Viewer. For example:
18+
- The event 'Viewer Opened' helps us estimate how often Rerun is used.
19+
- The event 'Data Source Connected' helps us understand if users tend to use live
20+
data sources or recordings most, which helps us prioritize features.
21+
- We associate events with:
22+
- Metadata about the Rerun build (version, target platform, etc).
23+
- A persistent random id that is used to associate events from
24+
multiple sessions together. To regenerate it run `rerun analytics clear`.
25+
- We may associate these events with a hashed `application_id` and `recording_id`,
26+
so that we can understand if users are more likely to look at few applications often,
27+
or tend to use Rerun for many temporary scripts. Again, this helps us prioritize.
28+
- We may for instance add events that help us understand how well the auto-layout works.
29+
30+
### What data is NOT collected?
31+
- No Personally Identifiable Information, such as user name or IP address, is collected.
32+
- This assumes you don't manually and explicitly associate your email with
33+
the analytics events using the analytics helper cli.
34+
(Don't do this, it's just meant for internal use for the Rerun team.)
35+
- No user data logged to Rerun is collected.
36+
- In some cases we collect secure hashes of user provided names (e.g. `application_id`),
37+
but take great care do this only when we have a clear understanding of why it's needed
38+
and it won't risk leaking anything potentially proprietary.
39+
40+
### Why do we collect data?
41+
- To improve the Rerun open source library.

‎crates/re_analytics/src/config_native.rs

+1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ pub enum ConfigError {
2929
pub struct Config {
3030
#[serde(rename = "analytics_enabled")]
3131
pub analytics_enabled: bool,
32+
3233
// NOTE: not a UUID on purpose, it is sometimes useful to use handcrafted IDs.
3334
#[serde(rename = "analytics_id")]
3435
pub analytics_id: String,

‎crates/re_analytics/src/config_web.rs

+1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ pub enum ConfigError {
2323
pub struct Config {
2424
#[serde(rename = "analytics_enabled")]
2525
pub analytics_enabled: bool,
26+
2627
// NOTE: not a UUID on purpose, it is sometimes useful to use handcrafted IDs.
2728
#[serde(rename = "analytics_id")]
2829
pub analytics_id: String,

‎crates/re_analytics/src/lib.rs

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
//! Rerun's analytics SDK.
2+
//!
3+
//! All the event we collect analytics about can be found in [`events`].
24
35
use std::borrow::Cow;
46
use std::collections::HashMap;
@@ -14,7 +16,7 @@ use time::OffsetDateTime;
1416
pub enum EventKind {
1517
/// Append a new event to the time series associated with this analytics ID.
1618
///
17-
/// Used e.g. to send an event everytime the app start.
19+
/// Used e.g. to send an event every time the app start.
1820
Append,
1921

2022
/// Update the permanent state associated with this analytics ID.

‎crates/re_arrow_store/Cargo.toml

+8-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
[package]
22
name = "re_arrow_store"
3-
version.workspace = true
3+
authors.workspace = true
4+
description = "An in-memory time series database for Rerun log data, based on Apache Arrow"
45
edition.workspace = true
5-
rust-version.workspace = true
6+
homepage.workspace = true
67
license.workspace = true
7-
publish = false
8+
publish = true
9+
readme = "README.md"
10+
repository.workspace = true
11+
rust-version.workspace = true
12+
version.workspace = true
813

914

1015
[features]

‎crates/re_data_store/Cargo.toml

+8-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
[package]
22
name = "re_data_store"
3-
version.workspace = true
3+
authors.workspace = true
4+
description = "In-memory storage of Rerun log data, indexed for fast fast queries."
45
edition.workspace = true
5-
rust-version.workspace = true
6+
homepage.workspace = true
67
license.workspace = true
7-
publish = false
8+
publish = true
9+
readme = "README.md"
10+
repository.workspace = true
11+
rust-version.workspace = true
12+
version.workspace = true
813

914

1015
[features]

‎crates/re_data_store/README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
In-memory storage of log data, indexed for fast fast queries. Used by `re_viewer`.
1+
# re_data_store
2+
3+
In-memory storage of Rerun log data, indexed for fast fast queries.

‎crates/re_error/Cargo.toml

+8-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
[package]
22
name = "re_error"
3-
version.workspace = true
3+
authors.workspace = true
4+
description = "Helpers for handling errors."
45
edition.workspace = true
5-
rust-version.workspace = true
6+
homepage.workspace = true
67
license.workspace = true
7-
publish = false
8+
publish = true
9+
readme = "README.md"
10+
repository.workspace = true
11+
rust-version.workspace = true
12+
version.workspace = true
813

914

1015
[dev-dependencies]

‎crates/re_error/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1+
# re_error
2+
13
Helpers for handling errors.

‎crates/re_format/Cargo.toml

+9-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
[package]
22
name = "re_format"
3-
version.workspace = true
3+
authors.workspace = true
4+
description = "Miscellaneous tools to format and parse numbers, durations, etc."
45
edition.workspace = true
5-
rust-version.workspace = true
6+
homepage.workspace = true
67
license.workspace = true
7-
publish = false
8+
publish = true
9+
readme = "README.md"
10+
repository.workspace = true
11+
rust-version.workspace = true
12+
version.workspace = true
13+
814

915
[dependencies]
1016
arrow2.workspace = true

‎crates/re_format/README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
Miscellaneous formatting tools.
1+
# re_format
2+
3+
Miscellaneous tools to format and parse numbers, durations, etc.

‎crates/re_format/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Miscellaneous formatting tools.
1+
//! Miscellaneous tools to format and parse numbers, durations, etc.
22
33
pub mod arrow;
44

‎crates/re_int_histogram/Cargo.toml

+8-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
[package]
22
name = "re_int_histogram"
3-
version.workspace = true
3+
authors.workspace = true
4+
description = "A histogram with `i64` keys and `u32` counts, supporting both sparse and dense uses."
45
edition.workspace = true
5-
rust-version.workspace = true
6+
homepage.workspace = true
67
license.workspace = true
7-
publish = false
8+
publish = true
9+
readme = "README.md"
10+
repository.workspace = true
11+
rust-version.workspace = true
12+
version.workspace = true
813

914

1015
[dependencies]

‎crates/re_int_histogram/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# re_int_histogram
2+
13
A histogram with `i64` keys and `u32` counts, supporting both sparse and dense uses.
24

35
It supports high-level summaries of the histogram, so that you can quickly get a birds-eye view of the data without having to visit every point in the histogram.

‎crates/re_log/Cargo.toml

+8-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
[package]
22
name = "re_log"
3-
version.workspace = true
3+
authors.workspace = true
4+
description = "Helpers for setting up and doing text logging in the Rerun crates."
45
edition.workspace = true
5-
rust-version.workspace = true
6+
homepage.workspace = true
67
license.workspace = true
7-
publish = false
8+
publish = true
9+
readme = "README.md"
10+
repository.workspace = true
11+
rust-version.workspace = true
12+
version.workspace = true
813

914

1015
[dependencies]

‎crates/re_log/README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
Helpers for handling errors.
1+
# re_log
2+
3+
Helpers for setting up and doing text logging in the Rerun crates.

‎crates/re_log_types/Cargo.toml

+8-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
[package]
22
name = "re_log_types"
3-
version.workspace = true
3+
authors.workspace = true
4+
description = "The different types that make up the rerun log format."
45
edition.workspace = true
5-
rust-version.workspace = true
6+
homepage.workspace = true
67
license.workspace = true
7-
publish = false
8+
publish = true
9+
readme = "README.md"
10+
repository.workspace = true
11+
rust-version.workspace = true
12+
version.workspace = true
813

914

1015
[features]

‎crates/re_log_types/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1+
# re_log_types
2+
13
The different types that make up the rerun log format.

‎crates/re_log_types/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Types used for the log data.
1+
//! The different types that make up the rerun log format.
22
//!
33
//! ## Feature flags
44
#![doc = document_features::document_features!()]

‎crates/re_memory/Cargo.toml

+8-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
[package]
22
name = "re_memory"
3-
version.workspace = true
3+
authors.workspace = true
4+
description = "Run-time memory tracking and profiling."
45
edition.workspace = true
5-
rust-version.workspace = true
6+
homepage.workspace = true
67
license.workspace = true
7-
publish = false
8+
publish = true
9+
readme = "README.md"
10+
repository.workspace = true
11+
rust-version.workspace = true
12+
version.workspace = true
813

914

1015
[dependencies]

‎crates/re_memory/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Run-time memory tracking and profiling.
1+
# Run-time memory tracking and profiling.
2+
3+
Includes an opt-in sampling profiler for allocation callstacks.
4+
Each time memory is allocated there is a chance a callstack will be collected.
5+
This information is tracked until deallocation.
6+
You can thus get information about what callstacks lead to the most live allocations,
7+
giving you a very useful memory profile of your running app, with minimal overhead.

0 commit comments

Comments
 (0)