dora-rs
/
dora
Not watched
1
0
Fork 0
Code
Releases 124 Wiki evaluate Activity
Issues 0 Pull Requests 0 Datasets Model Cloudbrain HPC
Browse Source

add documentation and description to all crates 

test rc 2 version

fix version typo
tags/v0.2.0-rc-6
haixuanTao 2 years ago
parent
bb4aa9ef93
commit
f9719fbbdd
23 changed files with 83 additions and 44 deletions
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. +1
    -0
      .github/workflows/release.yml
  2. +28
    -28
      Cargo.lock
  3. +16
    -16
      Cargo.toml
  4. +2
    -0
      apis/c++/node/Cargo.toml
  5. +2
    -0
      apis/c++/operator/Cargo.toml
  6. +2
    -0
      apis/c/node/Cargo.toml
  7. +1
    -0
      apis/c/operator/Cargo.toml
  8. +2
    -0
      apis/python/node/Cargo.toml
  9. +2
    -0
      apis/python/operator/Cargo.toml
  10. +1
    -0
      apis/rust/operator/macros/Cargo.toml
  11. +2
    -0
      apis/rust/operator/types/Cargo.toml
  12. +2
    -0
      binaries/cli/Cargo.toml
  13. +2
    -0
      binaries/coordinator/Cargo.toml
  14. +2
    -0
      binaries/daemon/Cargo.toml
  15. +2
    -0
      binaries/runtime/Cargo.toml
  16. +2
    -0
      libraries/communication-layer/pub-sub/Cargo.toml
  17. +2
    -0
      libraries/communication-layer/request-reply/Cargo.toml
  18. +2
    -0
      libraries/core/Cargo.toml
  19. +2
    -0
      libraries/extensions/download/Cargo.toml
  20. +2
    -0
      libraries/extensions/telemetry/metrics/Cargo.toml
  21. +2
    -0
      libraries/extensions/telemetry/tracing/Cargo.toml
  22. +2
    -0
      libraries/extensions/zenoh-logger/Cargo.toml
  23. +2
    -0
      libraries/shared-memory-server/Cargo.toml

+ 1
- 0
.github/workflows/release.yml View File

@@ -30,6 +30,7 @@ jobs:
-p dora-coordinator -p dora-cli -p dora-daemon"
- name: "Publish packages on `crates.io`"
if: runner.os == 'Linux'
run: |
# Publish libraries crates
cargo publish -p dora-message --token ${{ secrets.CARGO_REGISTRY_TOKEN }}


+ 28
- 28
Cargo.lock View File

@@ -256,7 +256,7 @@ checksum = "8c3c1a368f70d6cf7302d78f8f7093da241fb8e8807c05cc9e51a125895a6d5b"

[[package]]
name = "benchmark-example-node"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"dora-node-api",
"eyre",
@@ -269,7 +269,7 @@ dependencies = [

[[package]]
name = "benchmark-example-sink"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"dora-node-api",
"eyre",
@@ -525,7 +525,7 @@ dependencies = [

[[package]]
name = "communication-layer-pub-sub"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"flume",
"zenoh",
@@ -533,7 +533,7 @@ dependencies = [

[[package]]
name = "communication-layer-request-reply"
version = "0.2.0-rc"
version = "0.2.0-rc-2"

[[package]]
name = "concurrent-queue"
@@ -827,7 +827,7 @@ dependencies = [

[[package]]
name = "dora-cli"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"atty",
"clap 4.0.3",
@@ -845,7 +845,7 @@ dependencies = [

[[package]]
name = "dora-coordinator"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"ctrlc",
"dora-core",
@@ -868,7 +868,7 @@ dependencies = [

[[package]]
name = "dora-core"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"dora-message",
"eyre",
@@ -884,7 +884,7 @@ dependencies = [

[[package]]
name = "dora-daemon"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"async-trait",
"bincode",
@@ -909,7 +909,7 @@ dependencies = [

[[package]]
name = "dora-download"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"eyre",
"reqwest",
@@ -934,7 +934,7 @@ dependencies = [

[[package]]
name = "dora-message"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"capnp",
"capnpc",
@@ -944,7 +944,7 @@ dependencies = [

[[package]]
name = "dora-metrics"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"futures",
"opentelemetry",
@@ -955,7 +955,7 @@ dependencies = [

[[package]]
name = "dora-node-api"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"bincode",
"capnp",
@@ -977,7 +977,7 @@ dependencies = [

[[package]]
name = "dora-node-api-c"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"dora-node-api",
"eyre",
@@ -987,7 +987,7 @@ dependencies = [

[[package]]
name = "dora-node-api-cxx"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"cxx",
"cxx-build",
@@ -997,7 +997,7 @@ dependencies = [

[[package]]
name = "dora-node-api-python"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"dora-node-api",
"dora-operator-api-python",
@@ -1010,7 +1010,7 @@ dependencies = [

[[package]]
name = "dora-operator-api"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"dora-operator-api-macros",
"dora-operator-api-types",
@@ -1018,14 +1018,14 @@ dependencies = [

[[package]]
name = "dora-operator-api-c"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"dora-operator-api-types",
]

[[package]]
name = "dora-operator-api-cxx"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"cxx",
"cxx-build",
@@ -1034,7 +1034,7 @@ dependencies = [

[[package]]
name = "dora-operator-api-macros"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"proc-macro2",
"quote",
@@ -1043,7 +1043,7 @@ dependencies = [

[[package]]
name = "dora-operator-api-python"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"dora-node-api",
"eyre",
@@ -1054,14 +1054,14 @@ dependencies = [

[[package]]
name = "dora-operator-api-types"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"safer-ffi",
]

[[package]]
name = "dora-runtime"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"dora-core",
"dora-download",
@@ -1087,7 +1087,7 @@ dependencies = [

[[package]]
name = "dora-tracing"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"eyre",
"opentelemetry",
@@ -3173,7 +3173,7 @@ dependencies = [

[[package]]
name = "rust-dataflow-example-node"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"dora-node-api",
"eyre",
@@ -3184,14 +3184,14 @@ dependencies = [

[[package]]
name = "rust-dataflow-example-operator"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"dora-operator-api",
]

[[package]]
name = "rust-dataflow-example-sink"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"dora-node-api",
"eyre",
@@ -3474,7 +3474,7 @@ dependencies = [

[[package]]
name = "shared-memory-server"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"bincode",
"eyre",
@@ -4890,7 +4890,7 @@ dependencies = [

[[package]]
name = "zenoh-logger"
version = "0.2.0-rc"
version = "0.2.0-rc-2"
dependencies = [
"zenoh",
]


+ 16
- 16
Cargo.toml View File

@@ -23,25 +23,25 @@ members = [
]

[workspace.package]
version = "0.2.0-rc"
version = "0.2.0-rc-2"
description = "`dora` goal is to be a low latency, composable, and distributed data flow."
documentation = "https://dora-rs.github.io/dora"
documentation = "https://dora.carsmos.ai/dora/"

[workspace.dependencies]
dora-node-api = { version = "0.2.0-rc", path = "apis/rust/node", default-features = false }
dora-operator-api = { version = "0.2.0-rc", path = "apis/rust/operator", default-features = false }
dora-operator-api-macros = { version = "0.2.0-rc", path = "apis/rust/operator/macros" }
dora-operator-api-types = { version = "0.2.0-rc", path = "apis/rust/operator/types" }
dora-operator-api-python = { version = "0.2.0-rc", path = "apis/python/operator" }
dora-core = { version = "0.2.0-rc", path = "libraries/core" }
dora-tracing = { version = "0.2.0-rc", path = "libraries/extensions/telemetry/tracing" }
dora-metrics = { version = "0.2.0-rc", path = "libraries/extensions/telemetry/metrics" }
dora-download = { version = "0.2.0-rc", path = "libraries/extensions/download" }
shared-memory-server = { version = "0.2.0-rc", path = "libraries/shared-memory-server" }
communication-layer-request-reply = { version = "0.2.0-rc", path = "libraries/communication-layer/request-reply" }
dora-message = { version = "0.2.0-rc", path = "libraries/message" }
dora-runtime = { version = "0.2.0-rc", path = "binaries/runtime" }
dora-daemon = { version = "0.2.0-rc", path = "binaries/daemon" }
dora-node-api = { version = "0.2.0-rc-2", path = "apis/rust/node", default-features = false }
dora-operator-api = { version = "0.2.0-rc-2", path = "apis/rust/operator", default-features = false }
dora-operator-api-macros = { version = "0.2.0-rc-2", path = "apis/rust/operator/macros" }
dora-operator-api-types = { version = "0.2.0-rc-2", path = "apis/rust/operator/types" }
dora-operator-api-python = { version = "0.2.0-rc-2", path = "apis/python/operator" }
dora-core = { version = "0.2.0-rc-2", path = "libraries/core" }
dora-tracing = { version = "0.2.0-rc-2", path = "libraries/extensions/telemetry/tracing" }
dora-metrics = { version = "0.2.0-rc-2", path = "libraries/extensions/telemetry/metrics" }
dora-download = { version = "0.2.0-rc-2", path = "libraries/extensions/download" }
shared-memory-server = { version = "0.2.0-rc-2", path = "libraries/shared-memory-server" }
communication-layer-request-reply = { version = "0.2.0-rc-2", path = "libraries/communication-layer/request-reply" }
dora-message = { version = "0.2.0-rc-2", path = "libraries/message" }
dora-runtime = { version = "0.2.0-rc-2", path = "binaries/runtime" }
dora-daemon = { version = "0.2.0-rc-2", path = "binaries/daemon" }

[package]
name = "dora-examples"


+ 2
- 0
apis/c++/node/Cargo.toml View File

@@ -2,6 +2,8 @@
name = "dora-node-api-cxx"
version.workspace = true
edition = "2021"
documentation.workspace = true
description.workspace = true

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html



+ 2
- 0
apis/c++/operator/Cargo.toml View File

@@ -2,6 +2,8 @@
name = "dora-operator-api-cxx"
version.workspace = true
edition = "2021"
documentation.workspace = true
description.workspace = true

[lib]
crate-type = ["staticlib"]


+ 2
- 0
apis/c/node/Cargo.toml View File

@@ -3,6 +3,8 @@ name = "dora-node-api-c"
version.workspace = true
edition = "2021"
license = "Apache-2.0"
documentation.workspace = true
description.workspace = true

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html



+ 1
- 0
apis/c/operator/Cargo.toml View File

@@ -4,6 +4,7 @@ version.workspace = true
edition = "2021"
license = "Apache-2.0"
description = "C API implemetation for Dora Operator"
documentation.workspace = true

[build-dependencies]
dora-operator-api-types = { workspace = true }

+ 2
- 0
apis/python/node/Cargo.toml View File

@@ -3,6 +3,8 @@ version.workspace = true
name = "dora-node-api-python"
edition = "2021"
license = "Apache-2.0"
documentation.workspace = true
description.workspace = true

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html



+ 2
- 0
apis/python/operator/Cargo.toml View File

@@ -3,6 +3,8 @@ name = "dora-operator-api-python"
version.workspace = true
edition = "2021"
license = "Apache-2.0"
documentation.workspace = true
description.workspace = true

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html



+ 1
- 0
apis/rust/operator/macros/Cargo.toml View File

@@ -4,6 +4,7 @@ version.workspace = true
edition = "2021"
license = "Apache-2.0"
description = "Rust API Macros for Dora Operator"
documentation.workspace = true

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html



+ 2
- 0
apis/rust/operator/types/Cargo.toml View File

@@ -2,6 +2,8 @@
name = "dora-operator-api-types"
version.workspace = true
edition = "2021"
documentation.workspace = true
description.workspace = true

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html



+ 2
- 0
binaries/cli/Cargo.toml View File

@@ -2,6 +2,8 @@
name = "dora-cli"
version.workspace = true
edition = "2021"
documentation.workspace = true
description.workspace = true

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html



+ 2
- 0
binaries/coordinator/Cargo.toml View File

@@ -3,6 +3,8 @@ name = "dora-coordinator"
version.workspace = true
edition = "2021"
license = "Apache-2.0"
documentation.workspace = true
description.workspace = true

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html



+ 2
- 0
binaries/daemon/Cargo.toml View File

@@ -2,6 +2,8 @@
name = "dora-daemon"
version.workspace = true
edition = "2021"
documentation.workspace = true
description.workspace = true

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html



+ 2
- 0
binaries/runtime/Cargo.toml View File

@@ -3,6 +3,8 @@ name = "dora-runtime"
version.workspace = true
edition = "2021"
license = "Apache-2.0"
documentation.workspace = true
description.workspace = true

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html



+ 2
- 0
libraries/communication-layer/pub-sub/Cargo.toml View File

@@ -2,6 +2,8 @@
name = "communication-layer-pub-sub"
version.workspace = true
edition = "2021"
documentation.workspace = true
description.workspace = true

[features]
default = ["zenoh"]


+ 2
- 0
libraries/communication-layer/request-reply/Cargo.toml View File

@@ -2,6 +2,8 @@
name = "communication-layer-request-reply"
version.workspace = true
edition = "2021"
documentation.workspace = true
description.workspace = true


[package.metadata.docs.rs]


+ 2
- 0
libraries/core/Cargo.toml View File

@@ -3,6 +3,8 @@ name = "dora-core"
version.workspace = true
edition = "2021"
license = "Apache-2.0"
documentation.workspace = true
description.workspace = true

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html



+ 2
- 0
libraries/extensions/download/Cargo.toml View File

@@ -3,6 +3,8 @@ name = "dora-download"
version.workspace = true
edition = "2021"
license = "Apache-2.0"
documentation.workspace = true
description.workspace = true

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html



+ 2
- 0
libraries/extensions/telemetry/metrics/Cargo.toml View File

@@ -3,6 +3,8 @@ name = "dora-metrics"
version.workspace = true
edition = "2021"
license = "Apache-2.0"
documentation.workspace = true
description.workspace = true

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html



+ 2
- 0
libraries/extensions/telemetry/tracing/Cargo.toml View File

@@ -3,6 +3,8 @@ name = "dora-tracing"
version.workspace = true
edition = "2021"
license = "Apache-2.0"
documentation.workspace = true
description.workspace = true

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html



+ 2
- 0
libraries/extensions/zenoh-logger/Cargo.toml View File

@@ -3,6 +3,8 @@ name = "zenoh-logger"
version.workspace = true
edition = "2021"
license = "Apache-2.0"
documentation.workspace = true
description.workspace = true

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html



+ 2
- 0
libraries/shared-memory-server/Cargo.toml View File

@@ -3,6 +3,8 @@ name = "shared-memory-server"
version.workspace = true
edition = "2021"
license = "Apache-2.0"
documentation.workspace = true
description.workspace = true

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html



Write Preview
Loading…
Cancel
Save