Skip to content

Commit ce991b3

Browse files
committed
docs: updated to latest project structure
1 parent 3aa33d3 commit ce991b3

1 file changed

Lines changed: 23 additions & 7 deletions

File tree

README.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ To enable additional features::
1919

2020
```toml
2121
[dependencies]
22-
tucana = { version = "<version>", features = ["sagittarius", "aquila"] }
22+
tucana = { version = "<version>", features = ["sagittarius_rails", "aquila"] }
2323
```
2424

2525
### Ruby
@@ -33,7 +33,7 @@ gem 'tucana', '<version>'
3333
Don't forget to initialize the required feature:
3434
```ruby
3535
# For Sagittarius
36-
Tucana.load_protocol(:sagittarius)
36+
Tucana.load_protocol(:sagittarius_rails)
3737

3838
# For Aquila
3939
Tucana.load_protocol(:aquila)
@@ -47,10 +47,20 @@ See: [NPM](https://www.npmjs.com/package/@code0-tech/tucana)
4747
npm i @code0-tech/tucana
4848
```
4949

50+
### Python
51+
52+
See: [PyPI](https://pypi.org/project/tucana/)
53+
54+
```console
55+
pip install tucana
56+
```
57+
5058
## Project Structure
5159

52-
The project is organized with services functioning as servers. Each protocol in the Sagittarius folder corresponds to
53-
services that Sagittarius must implement as a server.
60+
The project is organized with services functioning as servers. Each protocol in the Aquila folder corresponds to
61+
services that Aquila must implement as a server.
62+
63+
> Notice: Sagittarius has been splitted into a service without and with streams regarding issues due to the thread blocking implementation of Ruby gRPC
5464
5565
```ascii-tree
5666
.
@@ -59,13 +69,19 @@ services that Sagittarius must implement as a server.
5969
│ ├── module - Module service for Taurus to send over datatypes, functions and flow types
6070
│ ├── runtime_status - Service for runtime status (handles information about Draco and Taurus)
6171
│ └── runtime_usage - Service for runtime usage (handles execution time of a flow)
62-
├── sagittarius
72+
├── sagittarius_gateway
73+
│ ├── flow - Flow service (handles flow updates)
74+
│ ├── module - Module service to receive datatypes, functions and flow types from aquila
75+
│ ├── runtime_status - Service for runtime status (handles information about Draco and Taurus)
76+
│ ├── runtime_usage - Service for runtime usage (handles execution time of a flow)
77+
│ └── test_execution - Service and Types for the test execution├── sagittarius
78+
├── sagittarius_rails
6379
│ ├── flow - Flow service (handles flow updates)
6480
│ ├── module - Module service to receive datatypes, functions and flow types from aquila
65-
│ ├── ping - Ping service (performs life checks)
6681
│ ├── runtime_status - Service for runtime status (handles information about Draco and Taurus)
6782
│ ├── runtime_usage - Service for runtime usage (handles execution time of a flow)
68-
│ └── test_execution - Service and Types for the test execution
83+
│ ├── test_execution - Service and Types for the test execution
84+
│ └── token - Service for verifing a runtime token
6985
└── shared
7086
├── data_type - Defines types for data types
7187
├── errors - Defines error object

0 commit comments

Comments
 (0)