{"id":16961088,"url":"https://github.com/adamsbytes/notifierr","last_synced_at":"2025-10-11T16:46:01.662Z","repository":{"id":38204514,"uuid":"471810513","full_name":"adamsbytes/notifierr","owner":"adamsbytes","description":"An API server to send SMS messages based on webhooks from Radarr/Sonarr.","archived":false,"fork":false,"pushed_at":"2023-10-02T08:52:05.000Z","size":104,"stargazers_count":1,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-28T19:15:23.785Z","etag":null,"topics":["api-server","automation","radarr","sonarr"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/notifierr/","language":"Python","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/adamsbytes.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2022-03-19T20:55:43.000Z","updated_at":"2022-05-04T19:06:46.000Z","dependencies_parsed_at":"2024-10-13T22:51:05.300Z","dependency_job_id":"4c363772-dad2-4a26-a20e-8ada938141a5","html_url":"https://github.com/adamsbytes/notifierr","commit_stats":{"total_commits":56,"total_committers":3,"mean_commits":"18.666666666666668","dds":0.0892857142857143,"last_synced_commit":"0381c30ce1e29d50ca4c587132cf87791fbeb4b1"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/adamsbytes/notifierr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamsbytes%2Fnotifierr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamsbytes%2Fnotifierr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamsbytes%2Fnotifierr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamsbytes%2Fnotifierr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adamsbytes","download_url":"https://codeload.github.com/adamsbytes/notifierr/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamsbytes%2Fnotifierr/sbom","scorecard":{"id":165522,"data":{"date":"2025-08-11","repo":{"name":"github.com/adamsbytes/notifierr","commit":"0381c30ce1e29d50ca4c587132cf87791fbeb4b1"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.4,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/18 approved changesets -- score normalized to 0","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":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/pypi-publish.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":"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":"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/pypi-publish.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/adamsbytes/notifierr/pypi-publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pypi-publish.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/adamsbytes/notifierr/pypi-publish.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pypi-publish.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/adamsbytes/notifierr/pypi-publish.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pypi-publish.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/adamsbytes/notifierr/pypi-publish.yml/main?enable=pin","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 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":"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":"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":"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: 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":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact 0.1.13 not signed: https://api.github.com/repos/adamsbytes/notifierr/releases/62279572","Warn: release artifact 0.1.11 not signed: https://api.github.com/repos/adamsbytes/notifierr/releases/62258876","Warn: release artifact 0.1.13 does not have provenance: https://api.github.com/repos/adamsbytes/notifierr/releases/62279572","Warn: release artifact 0.1.11 does not have provenance: https://api.github.com/repos/adamsbytes/notifierr/releases/62258876"],"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":3,"reason":"branch protection is not maximal on development and all release branches","details":["Info: 'allow deletion' disabled on branch 'main'","Info: 'force pushes' disabled on branch 'main'","Warn: branch 'main' does not require approvers","Warn: codeowners review is not required on branch 'main'","Warn: no status checks found to merge onto 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 14 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-16T14:43:16.934Z","repository_id":38204514,"created_at":"2025-08-16T14:43:16.934Z","updated_at":"2025-08-16T14:43:16.934Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279007975,"owners_count":26084369,"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","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"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-server","automation","radarr","sonarr"],"created_at":"2024-10-13T22:50:59.181Z","updated_at":"2025-10-11T16:46:01.642Z","avatar_url":"https://github.com/adamsbytes.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# notifierr\nnotifierr is an SMS notification service used in conjunction with Radarr/Sonarr to send SMS notifications when movies and TV shows are available to watch.\n\n## Installation\nThe easiest way to install notifierr is with pip\n```sh\npython3 -m pip install notifierr\n```\n\nYou can also clone the repository directly and run setup.py manually\n```sh\ngit clone https://github.com/adamsbytes/notifierr.git\ncd notifierr\npython3 setup.py install\n```\n\n## Usage\n\n### Configuring the Server\nYou must edit `notifierr/config.py` with your own values before starting the API server. You'll also need to set some environment variables, depending on which SMS provider you're using.\n\n#### *Twilio SMS provider*\nThe following environment variables are required and can be found in your Twilio console:\n\n`TWILIO_ACCOUNT_SID`: Twilio account SID\n\n`TWILIO_AUTH_TOKEN`: Twilio auth token\n\n`TWILIO_FROM_NUMBER`: the Twilio phone number you want to send messages from\n\n\n### Starting the Server\n\n__NOTE__: pip installs may need to add `~/.local/bin` to their PATH\n\nFor pip installs:\n```sh\nnotifierr --host 0.0.0.0 --port 8181\n```\n\nTo manually start the server:\n```sh\n$appdir/cli.py --host 0.0.0.0 --port 8181\n```\n\n### Available API endpoints\n\n`GET /version`: responds with the running version of notifierr\n\n`POST /message/movie/{uid}`: sends a detailed notification message for new movies (Radarr) to the phone numbers associated with uid\n\n`POST /message/tv/{uid}`: sends a detailed notification message for new TV episodes (Sonarr) to the phone numbers associated with uid\n\n## Configuring Radarr/Sonarr\n\n### A high level overview\n\nThe app uses the UID portion of `http://ip:8181/message/tv/UID` to select which phone numbers to use for the message. These are configured in the app's `config.py` file.\n\nTo have granular control over which numbers are messaged about which downloads, use **Tags** in Radarr/Sonarr!\n\nFor example, to let Dave know when his favorite show is ready, put his number in the `config.py` with any UID you'd like. Tag Dave's show with a unique tag, then create a notification that triggers with that same tag and use a URL containing Dave's UID at the end.\n\n### A step by step walkthrough\n\nOnce notifierr is running, in Radarr/Sonarr, visit Settings \u003e Connect and create a new Connection.\n\nFor the connection type, select `Webhook`\n\nFor the notification triggers, choose `On Download` or `On Import` (depending on the option available)\n\nFor the URL, enter `http://notifierr-ip-address:8181/message/tv/$uid`, replacing `$uid` with the UID you entered in `config.py` to correspond with the numbers who should receive the message\n\nFor the method, select `POST`\n\nPress `Test` to validate the connection, then press `Save`.\n\n### A picture is worth a thousand words\n\n#### Radarr Configuration Picture\n![A picture of the webhook configuration screen in Radarr](images/webhook-setup-radarr.png)\n\n#### Sonarr Configuration Picture\n![A picture of the webhook configuration screen in Radarr](images/webhook-setup-sonarr.png)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamsbytes%2Fnotifierr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadamsbytes%2Fnotifierr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamsbytes%2Fnotifierr/lists"}