https://github.com/monstermichl/ninja-bear
All your constants in one place
https://github.com/monstermichl/ninja-bear
python yaml
Last synced: 5 months ago
JSON representation
All your constants in one place
- Host: GitHub
- URL: https://github.com/monstermichl/ninja-bear
- Owner: monstermichl
- License: mit
- Created: 2024-10-30T07:14:29.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-23T15:33:14.000Z (over 1 year ago)
- Last Synced: 2025-09-15T17:55:40.412Z (9 months ago)
- Topics: python, yaml
- Language: Python
- Homepage:
- Size: 424 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ninja-bear 🥷🐻
Have you ever had to deal with several components, written in different languages, in which each had its own files to define your project's constants, like REST endpoints, valid parameters, valid values, ... and every time something changed, all those constants needed to be updated too, to keep things working?
*ninja-bear - All your constants in one place*. Configure your constants in YAML, generate for all required languages.
## Concept
All constants are defined in a YAML file. This file specifies the constant-names, their values, for which languages to generate source files for and many other options (if required). It is then passed to ninja-bear which takes care of generating the corresponding source files. To achieve a high amount of flexibility, a plugin-based approach is used in which each plugin (language, distributor) is an independend Python module, to let developers define their own languages/distributors without the need to modify ninja-bear directly.
## Installation
```bash
pip install ninja-bear
```
## Example
Lets have a look at a simple example to see what *ninja-bear* can do for you.
The example YAML file contains a property named *greeting* with the value "Hello World". Constant-files shall be generated for [TypeScript](https://pypi.org/project/ninja-bear-language-typescript/), [Python](https://pypi.org/project/ninja-bear-language-python/) and [C](https://pypi.org/project/ninja-bear-language-c/) (using the corresponding plugins). In case of *C*, the value shall be changed to *"Hello Mars"* and the file shall be distributed to Git using the [ninja-bear-distributor-git](https://pypi.org/project/ninja-bear-distributor-git/) plugin.
For detailed configuration information, please check [test-config.yaml](https://github.com/monstermichl/ninja-bear/blob/main/example/test-config.yaml). All possible values are described there.
### Input (readme-config.yaml)
```yaml
# -----------------------------------------------------------------------------
# This section defines languages and properties which are usually the settings
# that you'll use the most.
# -----------------------------------------------------------------------------
languages:
- language: typescript
property_naming: screaming-snake
export: esm
- language: python
file_naming: snake
property_naming: screaming-snake
- language: c
file_naming: snake
property_naming: pascal
transformers:
- mars-transformer
distributors:
- git-distributor
properties:
- type: string
name: greeting
value: Hello World
# -----------------------------------------------------------------------------
# This sections defines the available transformers and distributors. They are
# are used if property values need to be transformed before they get written
# or if specific language constants shall be distributed. To use a transformer
# and/or a distributor, its alias needs to be used in the language section
# (refer to c-example).
# -----------------------------------------------------------------------------
transformers:
- transformer: |
value = 'Hello Mars'
as: mars-transformer
distributors:
- distributor: git
as: git-distributor
```
### Execute ninja-bear
```bash
# -d is used to distribute the C-file to Git.
ninja-bear -c readme-config.yaml -d
```
### Output (readme-config.ts)
```typescript
export const ReadmeConfig = {
GREETING: 'Hello World',
} as const;
```
### Output (readme_config.py)
```python
from dataclasses import dataclass
@dataclass(frozen=True)
class ReadmeConfig:
GREETING = 'Hello World'
```
### Output (readme_config.h)
```c
#ifndef README_CONFIG_H
#define README_CONFIG_H
const struct {
char Greeting[11];
} ReadmeConfig = {
"Hello Mars",
};
#endif /* README_CONFIG_H */
```
## Usage
### Commandline
```bash
ninja-bear -c test-config.yaml -o generated
```
### Script
```python
from ninja_bear import Orchestrator
# Create Orchestrator instance from file.
orchestrator = Orchestrator.read_config('test-config.yaml')
# Write constants to 'generated' directory.
orchestrator.write('generated')
# Distribute constants (if required).
orchestrator.distribute()
```
## Create a plugin
To create a new plugin, clone the repository, run the [create_plugin.py](https://github.com/monstermichl/ninja-bear/blob/main/misc/plugins/create_plugin.py) script and select the corresponding plugin type. The script guides you through the required steps and creates a new folder (e.g. ninja-bear-language-examplescript), which contains all necessary files to get started. All files that require some implementation contain the comment **"TODO: Implement"**. The method comments contain information about what to implement. To install and test the plugin, scripts can be found in the *helpers* directory.
## Example list of available plugins
A short list of available plugins for ninja-bear. There are probably more. For a better overview please refer to [pypi.org](https://pypi.org/search/?q=%22ninja-bear-*%22).
### Languages
- [ninja-bear-language-c](https://pypi.org/project/ninja-bear-language-c/)
- [ninja-bear-language-go](https://pypi.org/project/ninja-bear-language-go/)
- [ninja-bear-language-java](https://pypi.org/project/ninja-bear-language-java/)
- [ninja-bear-language-javascript](https://pypi.org/project/ninja-bear-language-javascript/)
- [ninja-bear-language-python](https://pypi.org/project/ninja-bear-language-python/)
- [ninja-bear-language-shell](https://pypi.org/project/ninja-bear-language-shell/)
- [ninja-bear-language-typescript](https://pypi.org/project/ninja-bear-language-typescript/)
### Distributors
- [ninja-bear-language-fs](https://pypi.org/project/ninja-bear-distributor-fs/)
- [ninja-bear-language-git](https://pypi.org/project/ninja-bear-distributor-git/)