{"id":13595117,"url":"https://github.com/ayrat555/frankenstein","last_synced_at":"2026-04-07T18:01:39.347Z","repository":{"id":37540937,"uuid":"347372284","full_name":"ayrat555/frankenstein","owner":"ayrat555","description":"Telegram bot API client for Rust","archived":false,"fork":false,"pushed_at":"2026-02-11T16:52:53.000Z","size":1265,"stargazers_count":340,"open_issues_count":8,"forks_count":34,"subscribers_count":5,"default_branch":"master","last_synced_at":"2026-02-12T01:20:04.739Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://crates.io/crates/frankenstein","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"wtfpl","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ayrat555.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-03-13T13:02:58.000Z","updated_at":"2026-02-11T20:06:04.000Z","dependencies_parsed_at":"2023-10-15T17:01:01.605Z","dependency_job_id":"2ec8421c-c541-4a9a-becc-c11bba2d500b","html_url":"https://github.com/ayrat555/frankenstein","commit_stats":{"total_commits":175,"total_committers":13,"mean_commits":"13.461538461538462","dds":"0.22857142857142854","last_synced_commit":"e6d77efb841302b7d8eb6dfc3235c211a5807503"},"previous_names":[],"tags_count":71,"template":false,"template_full_name":null,"purl":"pkg:github/ayrat555/frankenstein","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayrat555%2Ffrankenstein","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayrat555%2Ffrankenstein/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayrat555%2Ffrankenstein/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayrat555%2Ffrankenstein/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ayrat555","download_url":"https://codeload.github.com/ayrat555/frankenstein/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayrat555%2Ffrankenstein/sbom","scorecard":{"id":220747,"data":{"date":"2025-08-11","repo":{"name":"github.com/ayrat555/frankenstein","commit":"ee56b316016ac544f1533e0aeb9ed0d54adf96d5"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.7,"checks":[{"name":"Maintained","score":10,"reason":"14 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":7,"reason":"Found 23/30 approved changesets -- score normalized to 7","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":"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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/rust.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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/rust.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/ayrat555/frankenstein/rust.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rust.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/ayrat555/frankenstein/rust.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/rust.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/ayrat555/frankenstein/rust.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rust.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/ayrat555/frankenstein/rust.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rust.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/ayrat555/frankenstein/rust.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/rust.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/ayrat555/frankenstein/rust.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/rust.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/ayrat555/frankenstein/rust.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rust.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/ayrat555/frankenstein/rust.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rust.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/ayrat555/frankenstein/rust.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/rust.yml:95: update your workflow using https://app.stepsecurity.io/secureworkflow/ayrat555/frankenstein/rust.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rust.yml:99: update your workflow using https://app.stepsecurity.io/secureworkflow/ayrat555/frankenstein/rust.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rust.yml:101: update your workflow using https://app.stepsecurity.io/secureworkflow/ayrat555/frankenstein/rust.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/rust.yml:150: update your workflow using https://app.stepsecurity.io/secureworkflow/ayrat555/frankenstein/rust.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/rust.yml:157: update your workflow using https://app.stepsecurity.io/secureworkflow/ayrat555/frankenstein/rust.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rust.yml:161: update your workflow using https://app.stepsecurity.io/secureworkflow/ayrat555/frankenstein/rust.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rust.yml:163: update your workflow using https://app.stepsecurity.io/secureworkflow/ayrat555/frankenstein/rust.yml/master?enable=pin","Info:   0 out of   9 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   7 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":"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENCE:0","Info: FSF or OSI recognized license: Do What The F*ck You Want To Public License: LICENCE: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":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"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 30 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"}},{"name":"Vulnerabilities","score":2,"reason":"8 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: RUSTSEC-2024-0384","Warn: Project is vulnerable to: RUSTSEC-2023-0050","Warn: Project is vulnerable to: RUSTSEC-2024-0436","Warn: Project is vulnerable to: GHSA-4p46-pwfr-66x6","Warn: Project is vulnerable to: RUSTSEC-2025-0009","Warn: Project is vulnerable to: GHSA-c86p-w88r-qvqr","Warn: Project is vulnerable to: GHSA-rr8g-9fpq-6wmg","Warn: Project is vulnerable to: RUSTSEC-2025-0023"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-17T02:25:37.875Z","repository_id":37540937,"created_at":"2025-08-17T02:25:37.875Z","updated_at":"2025-08-17T02:25:37.875Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31522574,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T16:28:08.000Z","status":"ssl_error","status_checked_at":"2026-04-07T16:28:06.951Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2024-08-01T16:01:44.296Z","updated_at":"2026-04-07T18:01:39.331Z","avatar_url":"https://github.com/ayrat555.png","language":"Rust","funding_links":[],"categories":["Rust","Telegram Libraries","Bots"],"sub_categories":["Rust","Bot Libs"],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"frankenstein_logo.png\" alt=\"frankenstein\" height=\"300px\"\u003e\u003c/p\u003e\n\n# Frankenstein\n\nTelegram bot API client for Rust.\n\nIt's a complete wrapper for Telegram bot API, and it's up-to-date with version 9.6 of the API.\n\nFrankenstein's data structures (Rust structs and enums) are mapped one-to-one from Telegram bot API types and method parameters.\n\n## Installation\n\nRun `cargo add frankenstein` or add the following to your `Cargo.toml`.\n\n```toml\n[dependencies]\nfrankenstein = { version = \"0.49\", features = [] }\n```\n\nYou likely want to use either a blocking or an async client. Enable it via the [Features](#features).\n\n## Features\n\nWithout enabling any additional features this crate will only ship with Telegram types.\n\n- blocking (synchronous)\n  - `client-ureq` - a blocking HTTP API client based on `ureq`\n  - `trait-sync` - a blocking API trait, it's included in the `client-ureq` feature. It may be useful for people who want to create a custom blocking client (for example, replacing an HTTP client)\n- async\n  - `client-reqwest` - an async HTTP API client based on `reqwest`. This client partially supports wasm32, but file uploads are currently not supported there.\n  - `trait-async` - an async API trait, it's used in the `client-reqwest`. It may be useful for people who want to create a custom async client\n\nFor example for the async client add the following line to your `Cargo.toml` file:\n\n```toml\nfrankenstein = { version = \"0.49\", features = [\"client-reqwest\"] }\n```\n\n## Usage\n\nExamples in this section use the blocking client (`frankenstein::Api`), but async examples would look the same (just replace `frankenstein::Api` with `frankenstein::AsyncApi`)\n\n### Data structures\n\nAll types described in the API docs have direct counterparts in the Frankenstein. For example, in the docs there is [the user type](https://core.telegram.org/bots/api#user):\n\n```plaintext\nid\tInteger\tUnique identifier for this user or bot. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.\nis_bot\tBoolean\tTrue, if this user is a bot\nfirst_name\tString\tUser's or bot's first name\nlast_name\tString\tOptional. User's or bot's last name\nusername\tString\tOptional. User's or bot's username\nlanguage_code\tString\tOptional. IETF language tag of the user's language\ncan_join_groups\tBoolean\tOptional. True, if the bot can be invited to groups. Returned only in getMe.\ncan_read_all_group_messages\tBoolean\tOptional. True, if privacy mode is disabled for the bot. Returned only in getMe.\nsupports_inline_queries\tBoolean\tOptional. True, if the bot supports inline queries. Returned only in getMe.\n```\n\nIn Frankenstein, it's described like this:\n\n```rust\npub struct User {\n    pub id: u64,\n    pub is_bot: bool,\n    pub first_name: String,\n    pub last_name: Option\u003cString\u003e,\n    pub username: Option\u003cString\u003e,\n    pub language_code: Option\u003cString\u003e,\n    pub can_join_groups: Option\u003cbool\u003e,\n    pub can_read_all_group_messages: Option\u003cbool\u003e,\n    pub supports_inline_queries: Option\u003cbool\u003e,\n}\n```\n\nOptional fields are described as `Option`.\n\nEvery struct can be created with the associated builder. Only required fields are required to set, optional fields are set to `None` when not provided:\n\n```rust\nuse frankenstein::methods::SendMessageParams;\nlet send_message_params = SendMessageParams::builder()\n    .chat_id(1337)\n    .text(\"hello\")\n    .build();\n```\n\n### Making requests\n\n```rust,no_run\n#![cfg(feature = \"client-ureq\")]\nuse frankenstein::TelegramApi;\nuse frankenstein::client_ureq::Bot;\nuse frankenstein::methods::{GetUpdatesParams, SendMessageParams};\nuse frankenstein::types::AllowedUpdate;\n\nlet token = \"123:ABC\";\nlet bot = Bot::new(token);\n\n// Send a message\nlet send_message_params = SendMessageParams::builder()\n    .chat_id(1337)\n    .text(\"hello\")\n    .build();\nlet result = bot.send_message(\u0026send_message_params);\n\n// or get the updates (= interactions with the bot)\nlet update_params = GetUpdatesParams::builder()\n    .allowed_updates(vec![AllowedUpdate::Message])\n    .build();\nlet result = bot.get_updates(\u0026update_params);\n```\n\nEvery function returns a `Result` with a successful response or failed response.\n\nSee more examples in the [`examples`](https://github.com/ayrat555/frankenstein/tree/0.40.2/examples) directory.\n\n### Uploading files\n\nSome methods in the API allow uploading files. In the Frankenstein for this `FileUpload` enum is used:\n\n```rust\npub enum FileUpload {\n    InputFile(InputFile),\n    String(String),\n}\n\npub struct InputFile {\n    path: std::path::PathBuf\n}\n```\n\nIt has two variants:\n\n- `FileUpload::String` is used to pass the ID of the already uploaded file\n- `FileUpload::InputFile` is used to upload a new file using multipart upload.\n\n### Documentation\n\nFrankenstein implements all Telegram bot API methods. To see which parameters you should pass, check the [official Telegram Bot API documentation](https://core.telegram.org/bots/api#available-methods) or [docs.rs/frankenstein](https://docs.rs/frankenstein/0.49.0/frankenstein/trait.TelegramApi.html#provided-methods)\n\nYou can check out real-world bots created using this library:\n\n- [El Monitorro](https://github.com/ayrat555/el_monitorro) - RSS/Atom/JSON feed reader.\n- [subvt-telegram-bot](https://github.com/helikon-labs/subvt-backend/tree/main/subvt-telegram-bot) - A Telegram bot for the validators of the [Polkadot](https://polkadot.network/) and [Kusama](https://kusama.network/).\n- [wdr-maus-downloader](https://github.com/EdJoPaTo/wdr-maus-downloader) - checks for a new episode of the WDR Maus and downloads it.\n- [weather_bot_rust](https://github.com/pxp9/weather_bot_rust) - A Telegram bot that provides weather info around the world.\n\n## Contributing\n\n1. [Fork it!](https://github.com/ayrat555/frankenstein/fork)\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\n## Author\n\nAyrat Badykov (@ayrat555)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fayrat555%2Ffrankenstein","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fayrat555%2Ffrankenstein","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fayrat555%2Ffrankenstein/lists"}