maliput-sdk 0.1.0

Vendor for maliput libraries.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

# maliput-rs

Provides a Rust API for maliput.

## Packages

* [`maliput-sdk`](./maliput-sdk/): Brings binaries of maliput ecosystem to cargo workspace.
* [`maliput-sys`](./maliput-sys/): Provides ffi Rust bindings for the [`maliput`](https://github.com/maliput/maliput) API.
* [`maliput`](./maliput/): Provides a Rustacean API for maliput on top of `maliput-sys`.

## Prerequisites

* OS: Ubuntu 20.04
* Bazel

## Installation


```
cargo build
```


## Usage

TODO

## Executables

### maliput-sdk

 - Print libraries being vendored
   ```sh
   cargo run --bin maliput-sdk
   ```

 - Get location of maliput_malidrive's plugin library:
   ```sh
   cargo run --bin maliput_malidrive_plugin_path
   ```

## Examples

### maliput-sys

 - Load `maliput::api::RoadNetwork` and perform some basic queries
    ```
    cargo run --example create_rn
    ```

## Developer Guidelines

1. A `devcontainer` is provided to easy setup the workspace. Refer to [.devcontainer](.devcontainer/README.md)

2. `pre-commit` is configured at this repository. Execute pre-commit locally before creating a pull request.
    ```
    pre-commit run --all-files
    ```
    _Note: For installing `pre-commit` tool: `pip3 install pre-commit`_

3. A hook will automatically added to run `pre-commit` every time a `git commit` call is made.
  In order to skip this behavior you can `PRE_COMMIT_ALLOW_NO_CONFIG=1 git commit`.