{"id":21730070,"url":"https://github.com/nventive/helpdeskid","last_synced_at":"2025-04-13T00:14:37.588Z","repository":{"id":98348599,"uuid":"197398216","full_name":"nventive/HelpDeskId","owner":"nventive","description":"Generates identifiers that humans can exchange easily.","archived":false,"fork":false,"pushed_at":"2023-07-25T13:48:58.000Z","size":58,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-13T00:14:31.897Z","etag":null,"topics":["csharp","identifiers","netcore"],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nventive.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-17T13:46:31.000Z","updated_at":"2023-06-12T19:46:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"fb921be1-2911-4019-9149-aaa8e62b8dd8","html_url":"https://github.com/nventive/HelpDeskId","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nventive%2FHelpDeskId","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nventive%2FHelpDeskId/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nventive%2FHelpDeskId/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nventive%2FHelpDeskId/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nventive","download_url":"https://codeload.github.com/nventive/HelpDeskId/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248647274,"owners_count":21139086,"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":["csharp","identifiers","netcore"],"created_at":"2024-11-26T04:11:44.136Z","updated_at":"2025-04-13T00:14:37.582Z","avatar_url":"https://github.com/nventive.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HelpDeskId\n\nGenerates identifiers that humans can exchange easily.\n\nThe objective for this library is to be able to generate identifiers that can be communicated\nto humans in case of error.\nSome systems generate an Operation/Error Id (a GUID-like string), but it is usually\nrather cumbersome to communicate either orally or via a screenshot.\nThis allows you to generate identifiers in the form of triplets of common words (e.g. \"moon-shadow-list\").\n\n**Be aware though that these identifiers are not guaranteed to be unique. There are not a replacement for GUIDs.**\n\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)\n[![Build Status](https://dev.azure.com/nventive-public/nventive/_apis/build/status/nventive.HelpDeskId?branchName=master)](https://dev.azure.com/nventive-public/nventive/_build/latest?definitionId=2\u0026branchName=master)\n![Nuget](https://img.shields.io/nuget/v/HelpDeskId.svg)\n\n## Getting Started\n\nInstall the package:\n\n```\nInstall-Package HelpDeskId\n```\n\n```csharp\nvar generator = new HelpDeskIdGenerator();\n\n// Generate an id using the CultureInfo.CurrentCulture if available with a fallback to english words.\nvar helpDeskId = generator.GenerateReadableId(); // \"desk-plastic-record\"\n\n// Specify the source dictionary to use, in this case french words.\nhelpDeskId = generator.GenerateReadableId(CultureInfo.GetCultureInfo(\"fr\")); // \"essayer-debut-avancer\"\n```\n\n## Features\n\n- The number of words and the separator can be customized in the constructor:\n```csharp\nvar generator = new HelpDeskIdGenerator(numberOfWords: 2, separator: \"/\");\nvar helpDeskId = generator.GenerateReadableId(); // \"another/one\"\n```\n\n- Currently, only english (default) and french (\"fr\") source words are supported (PR welcomed!).\nThey represent common words in these languages, where swear words have been curated.\nThe list can be customized by providing a `IWordsProvider` implementation.\n\n## Changelog\n\nPlease consult the [CHANGELOG](CHANGELOG.md) for more information about version history.\n\n## License\n\nThis project is licensed under the Apache 2.0 license - see the [LICENSE](LICENSE) file for details.\n\n## Contributing\n\nPlease read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the process for contributing to this project.\n\nBe mindful of our [Code of Conduct](CODE_OF_CONDUCT.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnventive%2Fhelpdeskid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnventive%2Fhelpdeskid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnventive%2Fhelpdeskid/lists"}