A simple dsl for creating mermaid graphs!
Project description
Siren
Siren is a simple DSL for creating Mermaid graphs YAML.
Have a look at the docs here:
Latest Release | Downloads |
---|---|
if you are interested in creating a Fable library like this on your own you can use the template Fable.Multiverse!
Contribution
If you have any ideas on how to improve the library, please feel free to contribute! The best way to get in contact is using the issues!
Local Development
Requirements
Because this library targets multiple programming languages we need to support all of them:
- nodejs and npm
- verify with
node --version
(Tested with v20.10.0) - verify with
npm --version
(Tested with v9.2.0)
- verify with
- .NET SDK
- verify with
dotnet --version
(Tested with 8.0.205)
- verify with
- Python
- verify with
py --version
(Tested with 3.11.9, known to work only for >=3.11)
- verify with
Setup
This needs to be done on a fresh download once. Paths for python venv executable might be different depending on the OS.
dotnet tool restore
npm install
py -m venv ./.venv
.\.venv\Scripts\Activate.ps1
python -m pip install -U pip setuptools
python -m pip install poetry
python -m poetry install --no-root
Testing
First activate python virtual environment (.\.venv\Scripts\Activate.ps1
).
.\build.cmd test
or specify target
.\build.cmd test [f#, c#, js [native], py [native]]
Publish
Requires API keys for Nuget and PyPi.
The following command will run all tests, bundle and then start publishing!
.\build.cmd publish pipeline
or only publish specific targets, without test and bundle
.\build.cmd publish [npm, pypi, nuget]
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file siren_dsl-0.3.2.tar.gz
.
File metadata
- Download URL: siren_dsl-0.3.2.tar.gz
- Upload date:
- Size: 133.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.11.9 Windows/10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40d98f0e2b41b17951d5c5dddf8bef7d60485d58f19e9933efe6f57441a9697f |
|
MD5 | e6e565d0e4a232c965f31c29ae972206 |
|
BLAKE2b-256 | 99713bec41130dd7d604e872ffe3908fc95e624b01f0acd14477dc4d16a055e9 |
File details
Details for the file siren_dsl-0.3.2-py3-none-any.whl
.
File metadata
- Download URL: siren_dsl-0.3.2-py3-none-any.whl
- Upload date:
- Size: 155.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.11.9 Windows/10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6d6766fe0698d5cf5ec79806f8040e78f8fffa7bea21fb538581d9e7ad28be74 |
|
MD5 | 23b56378df480e8408435fd3c55ee6bd |
|
BLAKE2b-256 | ab942dd20a59d9b0692a7749d38ca19e563952cea2b24ed2870a664dde8b816e |