An open API service indexing awesome lists of open source software.

https://github.com/tribecamp/yamlcredits

📜 Small tool for generating a CREDITS.md from YAML files.
https://github.com/tribecamp/yamlcredits

credits python tribecamp yaml yamlcredits

Last synced: 3 months ago
JSON representation

📜 Small tool for generating a CREDITS.md from YAML files.

Awesome Lists containing this project

README

          

# YAMLCredits

📜 Small tool for generating a CREDITS.md from YAML files.

## Installation

### Using pip

```python
pip install yamlcredits
```

### From source

```bash
git clone git@github.com:tribecamp/yamlcredits
# or: git clone https://github.com/tribecamp/yamlcredits
pip install -r requirements.txt
```

## Usage

### Output to stdout

```bash
yamlcredits path/to/config.yml
```

### Output to a file

```bash
yamlcredits path/to/config.yml > CREDITS.md
```

## Credits

Kees van Voorthuizen [(@keesvv)](https://github.com/keesvv) – original author

Sting Alleman [(@stingalleman)](https://github.com/stingalleman) – added additional usage example

## License

[MIT](./LICENSE)