{"id":20390341,"url":"https://github.com/timvisee/yaml-wrapper","last_synced_at":"2025-04-12T11:21:31.564Z","repository":{"id":8117298,"uuid":"9533596","full_name":"timvisee/yaml-wrapper","owner":"timvisee","description":"A YAML wrapper for Java to make it much easier to use these configuration files","archived":false,"fork":false,"pushed_at":"2022-12-14T20:44:50.000Z","size":197,"stargazers_count":7,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-26T06:11:16.201Z","etag":null,"topics":["config","java","wrapper","yaml-configuration","yaml-wrapper"],"latest_commit_sha":null,"homepage":"https://timvisee.com/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/timvisee.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["timvisee"],"custom":["https://timvisee.com/donate"],"patreon":"timvisee","ko_fi":"timvisee"}},"created_at":"2013-04-18T22:49:58.000Z","updated_at":"2022-01-08T02:49:54.000Z","dependencies_parsed_at":"2023-01-11T17:18:19.014Z","dependency_job_id":null,"html_url":"https://github.com/timvisee/yaml-wrapper","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvisee%2Fyaml-wrapper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvisee%2Fyaml-wrapper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvisee%2Fyaml-wrapper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvisee%2Fyaml-wrapper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timvisee","download_url":"https://codeload.github.com/timvisee/yaml-wrapper/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248558129,"owners_count":21124223,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["config","java","wrapper","yaml-configuration","yaml-wrapper"],"created_at":"2024-11-15T03:24:25.766Z","updated_at":"2025-04-12T11:21:31.544Z","avatar_url":"https://github.com/timvisee.png","language":"Java","funding_links":["https://github.com/sponsors/timvisee","https://timvisee.com/donate","https://patreon.com/timvisee","https://ko-fi.com/timvisee"],"categories":[],"sub_categories":[],"readme":"[![Build status on Travis CI](https://travis-ci.org/timvisee/yaml-wrapper.svg?branch=master)](https://travis-ci.org/timvisee/yaml-wrapper)\n\n# YAML Wrapper\nA YAML wrapper for Java to make it much easier to use these configuration files.\n\n## Features\n* Load/save YAML from/to a file or string.\n* Get, set and check YAML keys and/or sections in the preferred data type.\n* Easily format/parse lists or objects.\n* Use a default value if the requested key doesn't exist.\n* Set a base YAML configuration to use as fallback, if a key doesn't exist.\n* Use _isolated_ sub-sections of a YAML configuration, as if you're using a full YAML file.\n* Various useful helper methods to streamline your YAML configuration usage.\n\n## What is this YAML wrapper\nThis YAML wrapper library makes using YAML configurations very easy in your Java project.\nThe wrapper uses the SnakeYaml library as it's backend for interacting with YAML files,\nand provides a nice, clean and easy to use set of classes as abstraction.\nThis library is perfect to use for your own project if you'd like to implement YAML configuration file support.\n\n## Usage\nTo use the YAML wrapper library in your own project, you must include it as dependency.\nThe library can be added to your project by using Maven, or it can be done manually by adding the library JAR-file. See below.\n\n### Usage with Maven\nInclude the following repository and dependency in your Maven configuration to use the YAML wrapper in your own project.\n```\n\u003crepositories\u003e\n    \u003c!-- Xephi repository --\u003e\n    \u003crepository\u003e\n        \u003cid\u003exephi-repo\u003c/id\u003e\n        \u003curl\u003ehttps://repo.codemc.org/repository/maven-public/\u003c/url\u003e\n    \u003c/repository\u003e\n\u003c/repositories\u003e\n\n\u003cdependencies\u003e\n    \u003c!-- YAML wrapper library --\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003ecom.timvisee\u003c/groupId\u003e\n        \u003cartifactId\u003eyamlwrapper\u003c/artifactId\u003e\n        \u003cversion\u003e1.1.1\u003c/version\u003e\n    \u003c/dependency\u003e\n\u003c/dependencies\u003e\n```\n\n### Usage without Maven\nTo download the JAR-file see the [Download](#download) section.\nThis JAR-file should be added as _library_ to your own project, in order to use it.\n\n## Download\n|File|Build Status|Download|\n|:---|:---:|:---|\n|JAR library|Latest successful|[Download](https://ci.xephi.fr/job/YamlWrapper/lastSuccessfulBuild/artifact/target/)|\n|ZIP with JAR library|Latest successful|[Download](https://ci.xephi.fr/job/YamlWrapper/lastSuccessfulBuild/artifact/target/*zip*/target.zip)|\n\nAll JAR-files for the YAML wrapper library can be found and downloaded from on our [Jenkins](https://ci.xephi.fr/job/YamlWrapper/) page.\nIt is recommended however, to compile your own JAR-file using Maven whenever that's possible.\n\n## Example\nA runnable usage example is included in the [Example.java](src/main/java/com/timvisee/yamlwrapper/example/Example.java) file.\n\n## Builds\nThe project is currently being built automatically using the CI services in the table below.\n\n|Service|Platform|Branch|Build Status| |\n|:---:|:---:|:---:|:---|---|\n|Jenkins|Linux|master|[![Build status on Jenkins](https://img.shields.io/jenkins/s/https/ci.xephi.fr/job/YamlWrapper.svg)](http://ci.xephi.fr/job/YamlWrapper/)|[View status](http://ci.xephi.fr/job/YamlWrapper/)|\n|Travis CI|Linux|master|[![Build status on Travis CI](https://travis-ci.org/timvisee/yaml-wrapper.svg?branch=master)](https://travis-ci.org/timvisee/yaml-wrapper)|[View status](https://travis-ci.org/timvisee/yaml-wrapper)|\n|Travis CI|Linux|last commit|[![Build status on Travis CI](https://travis-ci.org/timvisee/yaml-wrapper.svg)](https://travis-ci.org/timvisee/yaml-wrapper)|[View status](https://travis-ci.org/timvisee/yaml-wrapper)|\n\n## Contributing\n1. Fork the project.\n2. Create a branch: `git checkout -b my-feature-branch`\n3. Commit your changes: `git commit -m \"Add new specific feature\"`\n4. Push to the branch: `git push origin my-feature-branch`\n5. Open a [Pull Request](https://github.com/timvisee/yaml-wrapper/compare).\n6. Enjoy a refreshing Diet Coke and wait.\n\n## License\nThis project is released under the GNU GPL-3.0 license. Check out the [LICENSE](LICENSE) file for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimvisee%2Fyaml-wrapper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimvisee%2Fyaml-wrapper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimvisee%2Fyaml-wrapper/lists"}