Metadata-Version: 2.1
Name: flync
Version: 0.9.1
Summary: FLYNC language is a declarative, modular format for describing the configuration of automotive networks and applications. It captures key elements of the vehicle's E/E architecture—such as ECUs, SOME/IP interfaces, and system topology—in a structured and human-readable way.
Home-page: https://flync-language.com
License: Apache-2.0
Keywords: automotive,network,someip,topology,flync
Author: Iago Alvarez
Author-email: iago.alvarez@technica-engineering.de
Requires-Python: >=3.11,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: click (==8.3.1)
Requires-Dist: construct (==2.10.70)
Requires-Dist: importlib-metadata (>=8.6.1)
Requires-Dist: jinja2
Requires-Dist: myst-parser (>=5.0.0,<6.0.0)
Requires-Dist: prettytable
Requires-Dist: pydantic (==2.10.5)
Requires-Dist: pydantic-extra-types (>=2.11.0,<3.0.0)
Requires-Dist: pydantic_yaml (==1.6.0)
Requires-Dist: pyyaml (==6.0.3)
Requires-Dist: rich
Requires-Dist: semver (>=3.0,<4.0)
Requires-Dist: typer
Project-URL: Documentation, https://github.com/Technica-Engineering/FLYNC
Project-URL: Repository, https://github.com/Technica-Engineering/FLYNC
Description-Content-Type: text/markdown

# FLYNC Library


## Description
FLYNC (FLexible Yaml-based Network Configuration), an open-source, repository-native solution that turns vehicle network configuration into clean, version-controlled code.

The heart of FLYNC is a single, human-readable model schema together with a comprehensive SDK that lets you create, validate, and manipulate configurations programmatically.

By organizing system definitions in a central, version-controlled repository, this tool helps engineering teams manage complexity, enable reuse, and maintain consistency across domains.


## Key Features


### 🧩 Layered Configuration Validation
Purpose-built for automotive networks, the language models configurations across multiple abstraction layers, enabling early detection of inconsistencies and integration issues.


### ⚙️ Configuration-as-Code Paradigm
Bring modern software engineering practices to configuration management:

- **Git-based version** control and workflows
- **CI/CD pipeline integration** for automated validation
- **Traceability and reproducibility** across releases


### 🚀 Fast and Reliable Engine
Highly optimized validation and parsing logic allow the library to handle large-scale configurations with **high and predictable** performance.


### 👩‍💻 Developer-Friendly Design
Designed for usability and rapid adoption:

- Intuitive, readable syntax
- Clear and structured documentation
- Suitable for **domain experts, software & network engineers**


### 🌍 Open Source & Collaborative
Released under an open license to encourage:

- Community contributions
- Ecosystem integrations
- Extensibility for emerging automotive needs

Contributions and feedback are welcome.


### 🪶 Lightweight & Dependency-Free Core
A minimal dependency footprint makes the library easy to:

- Embed into existing tooling
- Distribute across environments
- Automate within automotive development pipelines


## Target Users
FLYNC is designed for:

- E/E architecture teams.
- Network and platform engineers.
- SDV DevOps and integration teams.
- Validation and test engineers.
- Toolchain and automation specialists.


## About the Project
FLYNC is open source under the Apache-2.0 license, and thrives on community input!
We welcome:

- Bug reports - Open an issue with a clear description and minimal reproducible example.
- Feature requests - Propose new models, validation rules, or SDK adaptions.
- Pull requests - Follow the standard GitHub flow: fork, feature branch, commit, PR.
- Documentation improvements - Keep the docs up-to-date and user-friendly.


## License
Apache License Version 2.0

