{"id":33938718,"url":"https://github.com/halcyonnouveau/roux","last_synced_at":"2026-04-09T05:32:08.611Z","repository":{"id":38275140,"uuid":"196697153","full_name":"halcyonnouveau/roux","owner":"halcyonnouveau","description":"Simple and (a)synchronous Reddit API wrapper for Rust.","archived":false,"fork":false,"pushed_at":"2026-01-05T12:02:31.000Z","size":345,"stargazers_count":108,"open_issues_count":10,"forks_count":45,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-01-20T13:58:43.912Z","etag":null,"topics":["api-wrapper","reddit","reddit-api","rust","wrapper"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/roux","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/halcyonnouveau.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2019-07-13T08:21:37.000Z","updated_at":"2025-12-28T05:02:56.000Z","dependencies_parsed_at":"2024-01-09T03:42:02.734Z","dependency_job_id":"827a5c0a-c57a-4beb-a3ec-a62936024595","html_url":"https://github.com/halcyonnouveau/roux","commit_stats":{"total_commits":183,"total_committers":28,"mean_commits":6.535714285714286,"dds":0.6174863387978142,"last_synced_commit":"f771ce7c080daa86291972661ad5a4a981e761a8"},"previous_names":[],"tags_count":44,"template":false,"template_full_name":null,"purl":"pkg:github/halcyonnouveau/roux","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/halcyonnouveau%2Froux","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/halcyonnouveau%2Froux/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/halcyonnouveau%2Froux/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/halcyonnouveau%2Froux/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/halcyonnouveau","download_url":"https://codeload.github.com/halcyonnouveau/roux/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/halcyonnouveau%2Froux/sbom","scorecard":{"id":453371,"data":{"date":"2025-08-11","repo":{"name":"github.com/halcyonnouveau/roux","commit":"3f4ee6ed820a4d18154df3d630aa32cf604a91e3"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.8,"checks":[{"name":"Code-Review","score":2,"reason":"Found 4/16 approved changesets -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":2,"reason":"3 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/main.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/halcyonnouveau/roux/main.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/halcyonnouveau/roux/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/halcyonnouveau/roux/main.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/halcyonnouveau/roux/main.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/halcyonnouveau/roux/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/halcyonnouveau/roux/main.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:70: update your workflow using https://app.stepsecurity.io/secureworkflow/halcyonnouveau/roux/main.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:72: update your workflow using https://app.stepsecurity.io/secureworkflow/halcyonnouveau/roux/main.yml/main?enable=pin","Info:   0 out of   3 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   5 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 18 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-19T08:48:26.199Z","repository_id":38275140,"created_at":"2025-08-19T08:48:26.199Z","updated_at":"2025-08-19T08:48:26.199Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31587800,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"online","status_checked_at":"2026-04-09T02:00:06.848Z","response_time":112,"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":["api-wrapper","reddit","reddit-api","rust","wrapper"],"created_at":"2025-12-12T15:03:41.301Z","updated_at":"2026-04-09T05:32:08.603Z","avatar_url":"https://github.com/halcyonnouveau.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"https://raw.githubusercontent.com/halcyonnouveau/roux/refs/heads/main/assets/roux.png\" alt=\"dutch oven\" style=\"max-width: 100%;\"\u003e\n\n# Roux\n\n[![Build](https://github.com/halcyonnouveau/roux/actions/workflows/main.yml/badge.svg)](https://github.com/halcyonnouveau/roux/actions/workflows/main.yml)\n[![Documentation](https://img.shields.io/badge/documentation-available-green.svg)](https://docs.rs/roux)\n[![Crate](https://img.shields.io/crates/v/roux.svg)](https://crates.io/crates/roux)\n![GitHub](https://img.shields.io/github/license/halcyonnouveau/roux.svg)\n\nRoux is a simple, (a)synchronous Reddit API wrapper implemented in Rust.\n\n## Usage\n\n### Using OAuth\n\nTo create an OAuth client with the Reddit API, use the `Reddit` class.\n\n```rust\nuse roux::Reddit;\nlet client = Reddit::new(\"USER_AGENT\", \"CLIENT_ID\", \"CLIENT_SECRET\")\n    .username(\"USERNAME\")\n    .password(\"PASSWORD\")\n    .login()\n    .await;\n\nlet me = client.unwrap();\n```\nIt is important that you pick a good user agent. The ideal format is `platform:program:version (by /u/yourname)`, e.g. `macos:roux:v2.0.0 (by /u/beanpup_py)`. This will authticate you as the user given in the username function.\n\n### Usage\n\nUsing the OAuth client, you can:\n\n#### Submit A Text Post\n\n```rust\nuse roux::Reddit;\nlet client = Reddit::new(\"USER_AGENT\", \"CLIENT_ID\", \"CLIENT_SECRET\")\n    .username(\"USERNAME\")\n    .password(\"PASSWORD\")\n    .login()\n    .await;\n\nlet me = client.unwrap();\nme.submit_text(\"TEXT_TITLE\", \"TEXT_BODY\", \"SUBREDDIT\").await?;\n```\n\n#### Submit A Link Post\n\n```rust\nuse roux::Reddit;\nlet client = Reddit::new(\"USER_AGENT\", \"CLIENT_ID\", \"CLIENT_SECRET\")\n    .username(\"USERNAME\")\n    .password(\"PASSWORD\")\n    .login()\n    .await;\n\nlet me = client.unwrap();\nme.submit_link(\"LINK_TITLE\", \"LINK\", \"SUBREDDIT\").await?;\n```\n\n### Read-Only Modules\n\nThere are also read-only modules that don't need authentication:\n\n- [Subreddits](https://docs.rs/roux/latest/roux/subreddit/index.html)\n- [Users](https://docs.rs/roux/latest/roux/user/index.html)\n\n## Blocking Client\n\nYou can use a blocking (synchronous) API instead of tokio by enabling the `blocking` feature.\n\n```toml\n[dependencies]\nroux = { version = \"2\", features = [\"blocking\"] }\n```\n\n```rust\nuse roux::Reddit;\nlet client = Reddit::new(\"USER_AGENT\", \"CLIENT_ID\", \"CLIENT_SECRET\")\n    .username(\"USERNAME\")\n    .password(\"PASSWORD\")\n    .login();\n\nlet me = client.unwrap();\nme.submit_link(\"LINK_TITLE\", \"LINK\", \"SUBREDDIT\");\n```\n\n## 3rd-Party Libraries\n\n- [`roux-stream`](https://github.com/torfsen/roux-stream) provides an API for continuously streaming new submissions and comments\n\n## Contributing\n\nRoux is not in active development but is still being maintained and currently covers the most common and useful endpoints. If you see something missing or encounter a bug, feel free to open an issue or create a pull request.\n\n## License\n\nRoux is licensed under the MIT license (see [LICENSE file](/LICENSE)).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhalcyonnouveau%2Froux","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhalcyonnouveau%2Froux","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhalcyonnouveau%2Froux/lists"}