{"id":38767488,"url":"https://github.com/blues/note-python","last_synced_at":"2026-01-17T12:01:34.004Z","repository":{"id":43833441,"uuid":"172786900","full_name":"blues/note-python","owner":"blues","description":"Python API for Notecard","archived":false,"fork":false,"pushed_at":"2025-12-06T04:50:35.000Z","size":771,"stargazers_count":18,"open_issues_count":7,"forks_count":6,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-12-26T17:50:42.037Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","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/blues.png","metadata":{"files":{"readme":"README.md","changelog":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-02-26T20:39:39.000Z","updated_at":"2025-11-27T12:36:36.000Z","dependencies_parsed_at":"2022-09-02T23:40:46.117Z","dependency_job_id":"dacc9215-9193-4ebb-b594-c4b9618ea505","html_url":"https://github.com/blues/note-python","commit_stats":{"total_commits":131,"total_committers":9,"mean_commits":"14.555555555555555","dds":"0.16793893129770987","last_synced_commit":"239c1b0fcc04738ccf30d765e0611085de260dd4"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"purl":"pkg:github/blues/note-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blues%2Fnote-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blues%2Fnote-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blues%2Fnote-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blues%2Fnote-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blues","download_url":"https://codeload.github.com/blues/note-python/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blues%2Fnote-python/sbom","scorecard":{"id":244868,"data":{"date":"2025-08-11","repo":{"name":"github.com/blues/note-python","commit":"349406976c4a4c08072497d5b701b8c5b71a6293"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5,"checks":[{"name":"Code-Review","score":2,"reason":"Found 1/5 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":"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":"Maintained","score":10,"reason":"24 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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/hil-circuitpython.yml:1","Warn: no topLevel permission defined: .github/workflows/hil-micropython.yml:1","Warn: no topLevel permission defined: .github/workflows/manual-run.yml:1","Warn: no topLevel permission defined: .github/workflows/python-ci.yml:1","Warn: no topLevel permission defined: .github/workflows/python-package.yml:1","Warn: no topLevel permission defined: .github/workflows/python-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":"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/hil-circuitpython.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/blues/note-python/hil-circuitpython.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/hil-micropython.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/blues/note-python/hil-micropython.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-ci.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/blues/note-python/python-ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-ci.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/blues/note-python/python-ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-publish.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/blues/note-python/python-publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-publish.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/blues/note-python/python-publish.yml/main?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/hil-circuitpython.yml:132","Warn: pipCommand not pinned by hash: .github/workflows/hil-micropython.yml:73","Warn: pipCommand not pinned by hash: .github/workflows/python-ci.yml:51","Warn: pipCommand not pinned by hash: .github/workflows/python-ci.yml:52","Warn: pipCommand not pinned by hash: .github/workflows/python-publish.yml:22","Warn: pipCommand not pinned by hash: .github/workflows/python-publish.yml:23","Info:   0 out of   6 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   6 pipCommand 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":"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: 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":-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":"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":"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"}}]},"last_synced_at":"2025-08-17T07:23:17.998Z","repository_id":43833441,"created_at":"2025-08-17T07:23:17.999Z","updated_at":"2025-08-17T07:23:17.999Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28508464,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T11:50:55.898Z","status":"ssl_error","status_checked_at":"2026-01-17T11:50:55.569Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6: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":"2026-01-17T12:01:28.865Z","updated_at":"2026-01-17T12:01:33.934Z","avatar_url":"https://github.com/blues.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# note-python\n\nPython library for communicating with the Blues Wireless Notecard over serial\nor I²C.\n\n![Build](https://github.com/blues/note-python/workflows/Python%20package/badge.svg)\n[![Coverage Status](https://coveralls.io/repos/github/blues/note-python/badge.svg?branch=main)](https://coveralls.io/github/blues/note-python?branch=main)\n![Python Version Support](https://img.shields.io/pypi/pyversions/note-python)\n![PyPi Version](https://img.shields.io/pypi/v/note-python)\n![Wheel Support](https://img.shields.io/pypi/wheel/note-python)\n\nThis library allows you to control a Notecard by coding in Python and works in\na desktop setting, on Single-Board Computers like the Raspberry Pi, and on\nMicrocontrollers with MicroPython or CircuitPython support.\n\n## Installation\n\nWith `pip` via PyPi:\n\n```bash\npip install note-python\n```\n\nor\n\n\n```bash\npip3 install note-python\n```\n\nFor use with MicroPython or CircuitPython, copy the contents of the `notecard`\ndirectory into the `lib/notecard` directory of your device.\n\n## Usage\n\n```python\nimport notecard\n```\n\nThe `note-python` library requires a pointer to a serial or i2c object that you\ninitialize and pass into the library. This object differs based on platform, so\nconsult the [examples](examples/) directory for platform-specific guidance.\n\n### Serial Configuration\n\n\n#### Linux and Raspberry Pi\n```python\n# Use PySerial on a Linux desktop or Raspberry Pi\nimport serial\nport = serial.Serial(\"/dev/serial0\", 9600)\n\ncard = notecard.OpenSerial(port)\n```\n\n#### macOS and Windows\n\n```python\n# Use PySerial on a desktop\nimport serial\n#macOS\nport = serial.Serial(port=\"/dev/tty.usbmodemNOTE1\",\n                     baudrate=9600)\n# Windows\n# port = serial.Serial(port=\"COM4\",\n#                     baudrate=9600)\n\ncard = notecard.OpenSerial(port)\n```\n\n\n### I2C Configuration\n\n```python\n# Use python-periphery on a Linux desktop or Raspberry Pi\nfrom periphery import I2C\nport = I2C(\"/dev/i2c-1\")\n\ncard = notecard.OpenI2C(port, 0, 0)\n```\n\n### Sending Notecard Requests\n\nWhether using Serial or I2C, sending Notecard requests and reading responses\nfollows the same pattern:\n\n1. Create a JSON object that adheres to the Notecard API.\n2. Call `Transaction` on a `Notecard` object and pass in the request JSON\nobject.\n3. Make sure the response contains the data you need\n\n```python\n# Construct a JSON Object to add a Note to the Notecard\nreq = {\"req\": \"note.add\"}\nreq[\"body\"] = {\"temp\": 18.6}\n\nrsp = card.Transaction(req)\nprint(rsp) # {\"total\":1}\n```\n\n### Using the Library Fluent API\n\nThe `notecard` class allows complete access to the Notecard API via manual JSON\nobject construction and the `Transaction` method. Alternatively, you can import\none or more Fluent API helpers to work with common aspects of the Notecard API\nwithout having to author JSON objects, by hand. **Note** that not all aspects of\nthe Notecard API are available using these helpers. For a complete list of\nsupported helpers, visit the [API](API.md) doc.\n\nHere's an example that uses the `hub` helper to set the Notecard Product UID\nin CircuitPython:\n\n```python\nimport board\nimport busio\n\nimport notecard\nfrom notecard import card, hub, note\n\nport = busio.I2C(board.SCL, board.SDA)\nnCard = notecard.OpenI2C(port, 0, 0, debug=True)\n\nproductUID = \"com.blues.brandon.tester\"\nrsp = hub.set(nCard, productUID, mode=\"continuous\", sync=True)\n\nprint(rsp) # {}\n```\n\n## Documentation\n\nThe documentation for this library can be found\n[here](https://dev.blues.io/tools-and-sdks/python-library/).\n\n## Examples\n\nThe [examples](examples/) directory contains examples for using this\nlibrary with:\n\n- [Serial](examples/notecard-basics/serial_example.py)\n- [I2C](examples/notecard-basics/i2c_example.py)\n- [RaspberryPi](examples/notecard-basics/rpi_example.py)\n- [CircuitPython](examples/notecard-basics/cpy_example.py)\n- [MicroPython](examples/notecard-basics/mpy_example.py)\n\n## Contributing\n\nWe love issues, fixes, and pull requests from everyone. By participating in\nthis project, you agree to abide by the Blues Inc [code of conduct].\n\nFor details on contributions we accept and the process for contributing, see\nour [contribution guide](CONTRIBUTING.md).\n\n## Development Setup\n\nIf you're planning to contribute to this repo, please be sure to run the tests, linting and style checks before submitting a PR.\n\n1. Install Pipenv if you haven't already:\n   ```bash\n   pip install pipenv\n   ```\n\n2. Clone the repository and install dependencies:\n   ```bash\n   git clone https://github.com/blues/note-python.git\n   cd note-python\n   pipenv install --dev\n   ```\n\n3. Activate the virtual environment:\n   ```bash\n   pipenv shell\n   ```\n\n4. Run the tests:\n   ```bash\n   make test\n   ```\n\n5. Run linting and style checks:\n   ```bash\n   make precommit\n   ```\n\n## Installing the `pre-commit` Hook\n\nPlease run\n\n`pre-commit install`\n\nBefore committing to this repo. It will catch a lot of common errors that you can fix locally.\n\nYou may also run the pre-commit checks before committing with\n\n`pre-commit run`\n\nNote that `pre-commit run` only considers staged changes, so be sure all\nchanges are staged before running this.\n\n## More Information\n\nFor additional Notecard SDKs and Libraries, see:\n\n* [note-c](https://github.com/blues/note-c) for Standard C support\n* [note-go](https://github.com/blues/note-go) for Go\n* [note-arduino](https://github.com/blues/note-arduino) for Arduino\n\n## To learn more about Blues Wireless, the Notecard and Notehub, see:\n\n* [blues.com](https://blues.com)\n* [notehub.io][Notehub]\n* [wireless.dev](https://wireless.dev)\n\n## License\n\nCopyright (c) 2019 Blues Inc. Released under the MIT license. See\n[LICENSE](LICENSE) for details.\n\n[code of conduct]: https://blues.github.io/opensource/code-of-conduct\n[Notehub]: https://notehub.io\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblues%2Fnote-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblues%2Fnote-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblues%2Fnote-python/lists"}