https://github.com/thediveo/osrelease
A slightly pedantic os-release parser.
https://github.com/thediveo/osrelease
Last synced: 6 months ago
JSON representation
A slightly pedantic os-release parser.
- Host: GitHub
- URL: https://github.com/thediveo/osrelease
- Owner: thediveo
- License: apache-2.0
- Created: 2021-10-22T18:00:27.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-01-06T20:42:33.000Z (6 months ago)
- Last Synced: 2025-01-06T21:31:00.962Z (6 months ago)
- Language: Go
- Homepage:
- Size: 39.1 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# A Pedantic `os-release` Parser
[](https://img.shields.io/github/license/thediveo/osrelease)
[](https://img.shields.io/github/license/thediveo/osrelease)
[](https://goreportcard.com/report/github.com/thediveo/osrelease)
`osrelease` is a Go module implementing a slightly pedantic parser for the
os-release file format, as specified in
[os-release(5)](https://www.freedesktop.org/software/systemd/man/os-release.html).
This implementation actually _parses_ quoted assignment values for escape
sequences in _correct sequence_, instead of simply doing blind
search-and-replaces (which can result in unexpected results).
Oh, and this module has _tests_.
There's a reason why we call it the "_pedantic_" parser after all.
For devcontainer instructions, please see the [section "DevContainer"
below](#devcontainer).
## Usage
Simply get the OS identification variables using `osrelease.New()`. That's all.
```go
package main
import "github.com/thediveo/osrelease"
func main() {
vars := osrelease.New()
for name, value := range vars {
println(name, "=", value)
}
}
```
## DevContainer
> [!CAUTION]
>
> Do **not** use VSCode's "~~Dev Containers: Clone Repository in Container
> Volume~~" command, as it is utterly broken by design, ignoring
> `.devcontainer/devcontainer.json`.
1. `git clone https://github.com/thediveo/enumflag`
2. in VSCode: Ctrl+Shift+P, "Dev Containers: Open Workspace in Container..."
3. select `enumflag.code-workspace` and off you go...
## Supported Go Versions
`native` supports versions of Go that are noted by the [Go release
policy](https://golang.org/doc/devel/release.html#policy), that is, major
versions _N_ and _N_-1 (where _N_ is the current major version).
## Contributing
Please see [CONTRIBUTING.md](CONTRIBUTING.md).
## Copyright and License
`osrelease` is Copyright 2021, 2025 Harald Albrecht, and licensed under the
Apache License, Version 2.0.