orrery 0.2.0

A diagram language for creating component and sequence diagrams
Documentation 
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
63
64
65
66
67
68
69
70
71
72

# Orrery Library

A Rust library for parsing, layouting, and rendering diagram descriptions written in the Orrery DSL.

## Installation

Add to your `Cargo.toml`:

```toml
[dependencies]
orrery = "0.1.0"
```

## Quick Start

```rust
use std::path::Path;

use orrery::{DiagramBuilder, InMemorySourceProvider, config::AppConfig};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let source = r#"
        diagram component;
        
        frontend: Rectangle [fill_color="lightblue"];
        backend: Rectangle [fill_color="lightgreen"];
        database: Rectangle;
        
        frontend -> backend: "API";
        backend -> database: "SQL";
    "#;

    // Set up a source provider with the diagram source
    let mut provider = InMemorySourceProvider::new();
    provider.add_file("diagram.orr", source);

    // Create a builder with default configuration and provider
    let builder = DiagramBuilder::new(AppConfig::default(), &provider);

    // Parse the source code into a semantic diagram
    let diagram = builder.parse(Path::new("diagram.orr"))?;

    // Render the semantic diagram to SVG
    let svg = builder.render_svg(&diagram)?;

    std::fs::write("output.svg", &svg)?;
    Ok(())
}
```

## Custom Configuration

```rust
use orrery::{DiagramBuilder, InMemorySourceProvider, config::AppConfig};

let provider = InMemorySourceProvider::new();
let config = AppConfig::default();
let builder = DiagramBuilder::new(config, &provider);
```

## Examples

See the [examples directory](../../examples/) for more diagram samples.

## Documentation

- [Language Specification](../../docs/specifications/specification.md)
- [API Documentation](https://docs.rs/orrery)

## License

Licensed under either of Apache License 2.0 or MIT license at your option.