{"id":18131492,"url":"https://github.com/crownedgrouse/steam","last_synced_at":"2026-05-18T03:35:43.591Z","repository":{"id":71843148,"uuid":"52210996","full_name":"crownedgrouse/steam","owner":"crownedgrouse","description":"Search Tags in Erlang Application or Module","archived":false,"fork":false,"pushed_at":"2018-05-29T09:54:23.000Z","size":71,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-11T20:41:17.695Z","etag":null,"topics":["debian","erlang","facets","tags"],"latest_commit_sha":null,"homepage":null,"language":"Erlang","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crownedgrouse.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"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":"2016-02-21T14:44:09.000Z","updated_at":"2019-07-15T20:47:17.000Z","dependencies_parsed_at":null,"dependency_job_id":"a7a7bf50-8a12-4fcb-9cb3-af1ff2cfa6a0","html_url":"https://github.com/crownedgrouse/steam","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/crownedgrouse/steam","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crownedgrouse%2Fsteam","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crownedgrouse%2Fsteam/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crownedgrouse%2Fsteam/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crownedgrouse%2Fsteam/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crownedgrouse","download_url":"https://codeload.github.com/crownedgrouse/steam/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crownedgrouse%2Fsteam/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33163780,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-17T22:39:12.733Z","status":"online","status_checked_at":"2026-05-18T02:00:06.436Z","response_time":71,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["debian","erlang","facets","tags"],"created_at":"2024-11-01T12:07:40.075Z","updated_at":"2026-05-18T03:35:43.556Z","avatar_url":"https://github.com/crownedgrouse.png","language":"Erlang","funding_links":[],"categories":[],"sub_categories":[],"readme":"# steam\nSearch Tags in Erlang Application or Module\n\n## Overview ##\n`steam` is a module detecting Debian package tags on Erlang projects. \n\nDebian package tags are used because of their completeness compared to many other distributions. However those tags can be easily transcoded to anothers if needed.\n\nReference is [Debtags](https://debtags.debian.org/reports/facets).\n\nAll relevant tags for Erlang projects are automatically detected from abstract code, except tags of facet `use`.\nThis subjective facet cannot be detected for now and to be declared by projects maintainers.\n\n## Contributing ##\n\nContributions are welcome. Please use pull-requests.\n\n### In steam project ###\nFacet `use` (The general purpose of the software) is to be informed by Erlang projects maintainer in `src/steam_use.hrl`. \n\nNote : only pull requests coming from owner of project will be accepted for this facet `use`.\n\n### In your own project ###\nAlternatively, and prefered way, you can tune steam tags by adding attribute in your own project code.\n\nSimply add a `steam` attribute in top of your main project file, as a list containing optional tuples :\n\n- Tuple `tag` contains a list of tags to add to steam analyze. Note that _ALL_ tags must already exists in steam project or none will be added.\nYou can verify this by getting the whole list with `steam:tags()` function.\n- Tuple `untag` contains a list of tags to remove from steam analyze. This should be used only to repair a false positive until a fix in steam code is done.\n\n```\n-steam([{tag,['use::analysing']}, % Add tag(s) (must ALL exists)\n\t\t{untag,[]}                % Remove any unwanted tag(s)\n\t   ]).\n```\n\n## API ##\n\n### Search tags in a project ###\n\nExtracting Debian tags use `steam:tags/1`. \n\nArgument is the path to the Erlang project root directory.\n\nReturns `{ok, ListOfTags}` or `{error, Reason}`.\n\n```\n1\u003e steam:tags(\"/path/to/root/project/directory/\").\n{ok,['implemented-in::erlang','protocol::ip',\n     'protocol::ssh','scope::suite','use::organizing']}\n\n```\n\n### Listing facets ###\nDebian tag classification use [Facets](https://debtags.debian.org/reports/facets).\n\nListing facets used in tags : `steam:facets().`\n\nListing all potential facets : `steam:facets(all).`\n\n### Listing tags ###\n\nListing available tags : `steam:tags().`\n\n## Quick Start ##\n\n```\ngit clone git://github.com/crownedgrouse/steam.git\ncd steam\nmake\nerl -pa `pwd`/ebin\n```\nor\n```\ngit clone git://github.com/crownedgrouse/steam.git\ncd steam\nmake shell\n```\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrownedgrouse%2Fsteam","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrownedgrouse%2Fsteam","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrownedgrouse%2Fsteam/lists"}