bitmath

Projects that follow the best practices below can voluntarily self-certify and show that they've achieved an Open Source Security Foundation (OpenSSF) best practices badge.

There is no set of practices that can guarantee that software will never have defects or vulnerabilities; even formal methods can fail if the specifications or assumptions are wrong. Nor is there any set of practices that can guarantee that a project will sustain a healthy and well-functioning development community. However, following best practices can help improve the results of projects. For example, some practices enable multi-person review before release, which can both help find otherwise hard-to-find technical vulnerabilities and help build trust and a desire for repeated interaction among developers from different companies. To earn a badge, all MUST and MUST NOT criteria must be met, all SHOULD criteria must be met OR be unmet with justification, and all SUGGESTED criteria must be met OR unmet (we want them considered at least). If you want to enter justification text as a generic comment, instead of being a rationale that the situation is acceptable, start the text block with '//' followed by a space. Feedback is welcome via the GitHub site as issues or pull requests There is also a mailing list for general discussion.

We gladly provide the information in several locales, however, if there is any conflict or inconsistency between the translations, the English version is the authoritative version.
If this is your project, please show your baseline badge status on your project page! The baseline badge status looks like this: Baseline badge level for project 12749 is baseline-2 Here is how to embed the baseline badge:
You can show your baseline badge status by embedding this in your markdown file:
[![OpenSSF Baseline](https://www.bestpractices.dev/projects/12749/baseline)](https://www.bestpractices.dev/projects/12749)
or by embedding this in your HTML:
<a href="https://www.bestpractices.dev/projects/12749"><img src="https://www.bestpractices.dev/projects/12749/baseline"></a>


These are the Baseline Level 1 criteria. These criteria are from baseline version v2025.10.10 with updated criteria text from version v2026.02.19. Criteria that are new in version v2026.02.19 are labeled "future" and will begin to be enforced starting 2026-06-01. Please provide answers to the "future" criteria before that date.

Baseline Series: Baseline Level 1 Baseline Level 2 Baseline Level 3

        

 Basics

  • General

    Note that other projects may use the same name.

    Python module to work with file sizes like numbers - convert, compare, sort, and format across any prefix unit

    Please use SPDX license expression format; examples include "Apache-2.0", "BSD-2-Clause", "BSD-3-Clause", "GPL-2.0+", "LGPL-3.0+", "MIT", and "(BSD-2-Clause OR Ruby)". Do not include single quotes or double quotes.
    If there is more than one language, list them as comma-separated values (spaces optional) and sort them from most to least used. If there is a long list, please list at least the first three most common ones. If there is no language (e.g., this is a documentation-only or test-only project), use the single character "-". Please use a conventional capitalization for each language, e.g., "JavaScript".
    The Common Platform Enumeration (CPE) is a structured naming scheme for information technology systems, software, and packages. It is used in a number of systems and databases when reporting vulnerabilities.

 Controls 25/25 ●

  • Controls


    Enough for a badge!

    When a user attempts to read or modify a sensitive resource in the project's authoritative repository, the system MUST require the user to complete a multi-factor authentication process. [OSPS-AC-01.01]
    Enforce multi-factor authentication for the project's version control system, requiring collaborators to provide a second form of authentication when accessing sensitive data or modifying repository settings. Passkeys are acceptable for this control.

    GitHub requires 2FA as of March 2023.


    Enough for a badge!

    When a new collaborator is added, the version control system MUST require manual permission assignment, or restrict the collaborator permissions to the lowest available privileges by default. [OSPS-AC-02.01]
    Most public version control systems are configured in this manner. Ensure the project's version control system always assigns the lowest available permissions to collaborators by default when added, granting additional permissions only when necessary.

    ▎ The project relies on GitHub's default permission model, which assigns new ▎ collaborators read access only; any elevated permission requires an explicit ▎ manual grant by the repo owner.


    Enough for a badge!

    When a direct commit is attempted on the project's primary branch, an enforcement mechanism MUST prevent the change from being applied. [OSPS-AC-03.01]
    If the VCS is centralized, set branch protection on the primary branch in the project's VCS. Alternatively, use a decentralized approach, like the Linux kernel's, where changes are first proposed in another repository, and merging changes into the primary repository requires a specific separate act.

    ▎ Branch protection on master enforces 17 required status checks (full Python
    ▎ 3.9–3.13 × {macOS, Ubuntu, Windows} matrix + CodeQL + Bandit) with
    ▎ enforce_admins: true and required_linear_history: true. Direct pushes that fail
    ▎ any check are rejected, including pushes by administrators.


    Enough for a badge!

    When an attempt is made to delete the project's primary branch, the version control system MUST treat this as a sensitive activity and require explicit confirmation of intent. [OSPS-AC-03.02]
    Set branch protection on the primary branch in the project's version control system to prevent deletion.

    ▎ Branch protection on master has allow_deletions: false and enforce_admins: true,
    ▎ so the branch cannot be deleted by any account including the owner.


    Enough for a badge!

    When a CI/CD pipeline operates on untrusted metadata, those parameters MUST be sanitized and validated prior to use in the pipeline. [OSPS-BR-01.01]
    CI/CD pipelines should sanitize (quote, escape or exit on expected values) all metadata inputs which correspond to untrusted sources. This includes data such as branch names, commit messages, tags, pull request titles, and author information.

    ▎ An audit of every ${{ }} interpolation across all 5 workflows (bandit.yml,
    ▎ codeql.yml, publish.yml, python.yml, scorecard.yml) shows the only interpolated
    ▎ values are ${{ matrix.os }} and ${{ matrix.python-version }}, both
    ▎ workflow-defined constants. There is zero use of github.event.*,
    ▎ github.head_ref, github.ref_name, commit messages, PR titles, or branch names in
    ▎ shell contexts. Workflows:
    ▎ https://github.com/timlnx/bitmath/tree/master/.github/workflows


    Enough for a badge!

    (Future criterion) When a CI/CD pipeline operates on untrusted code snapshots, it MUST prevent access to privileged CI/CD credentials and assets. [OSPS-BR-01.03]
    CI/CD pipelines should isolate untrusted code snapshots from privileged credentials and assets. In particular, projects should be careful to ensure that workflows which build or execute code prior to review by a collaborator do not have access to CI/CD credentials.

    ▎ All PR-triggered workflows use pull_request (not pull_request_target), so PRs
    ▎ from forks execute in the fork's read-only context without access to repository
    ▎ secrets. The only workflow that holds secrets is publish.yml, which fires solely
    ▎ on release: published and uses PyPI Trusted Publishing (OIDC), so no long-lived
    ▎ credentials exist for untrusted code to exfiltrate.


    Enough for a badge!

    When the project lists a URI as an official project channel, that URI MUST be exclusively delivered using encrypted channels. [OSPS-BR-03.01]
    Configure the project's websites and version control systems to use encrypted channels such as SSH or HTTPS for data transmission. Ensure all tools and domains referenced in project documentation can only be accessed via encrypted channels.

    Project URLs use HTTPS exclusively.


    Enough for a badge!

    When the project lists a URI as an official distribution channel, that channel MUST be protected from adversary-in-the-middle attacks using cryptographically authenticated channels. [OSPS-BR-03.02]
    Artifacts distributed by the project should be distributed through channels which ensure integrity and authenticity. Use of HTTPS for downloads, signed releases, or distribution through trusted package managers are all acceptable methods to protect against adversary-in-the-middle attacks.

    ▎ bitmath is distributed exclusively via PyPI over HTTPS using PyPI's Trusted
    ▎ Publisher (OIDC) flow with sigstore-backed provenance, and via GitHub Releases
    ▎ at https://github.com/timlnx/bitmath/releases. Both channels provide
    ▎ cryptographic integrity protection.


    Enough for a badge!

    The project MUST prevent the unintentional storage of unencrypted sensitive data, such as secrets and credentials, in the version control system. [OSPS-BR-07.01]
    Configure .gitignore or equivalent to exclude files that may contain sensitive information. Use pre-commit hooks and automated scanning tools to detect and prevent the inclusion of sensitive data in commits.

    ▎ .gitignore excludes generated artifacts and common secret-bearing files. GitHub ▎ secret scanning and Dependabot security updates are enabled at the repository ▎ level. Bandit runs in CI (.github/workflows/bandit.yml) on every push and PR and ▎ weekly on a schedule, with zero open findings.


    Enough for a badge!

    When the project has made a release, the project documentation MUST include user guides for all basic functionality. [OSPS-DO-01.01]
    Create user guides or documentation for all basic functionality of the project, explaining how to install, configure, and use the project's features. If there are any known dangerous or destructive actions available, include highly-visible warnings.

    ▎ Comprehensive user documentation is published at https://bitmath.readthedocs.io/
    ▎ covering installation, every public unit type, parsing, formatting, arithmetic,
    ▎ capacity queries, and real-life examples. The README at
    ▎ https://github.com/timlnx/bitmath also includes a quick-start.


    Enough for a badge!

    When the project has made a release, the project documentation MUST include a guide for reporting defects. [OSPS-DO-02.01]
    It is recommended that projects use their VCS default issue tracker. If an external source is used, ensure that the project documentation and contributing guide clearly and visibly explain how to use the reporting system. It is recommended that project documentation also sets expectations for how defects will be triaged and resolved.

    ▎ GitHub Issues is enabled and is the canonical bug tracker:
    ▎ https://github.com/timlnx/bitmath/issues. The contribution guide at
    ▎ https://github.com/timlnx/bitmath/blob/master/.github/CONTRIBUTING.md describes
    ▎ how to file reports.


    Enough for a badge!

    While active, the project MUST have one or more mechanisms for public discussions about proposed changes and usage obstacles. [OSPS-GV-02.01]
    Establish one or more mechanisms for public discussions within the project, such as mailing lists, instant messaging, or issue trackers, to facilitate open communication and feedback.

    ▎ Public discussion happens on GitHub Issues and Pull Requests, both publicly
    ▎ readable. Issues: https://github.com/timlnx/bitmath/issues. PRs:
    ▎ https://github.com/timlnx/bitmath/pulls.


    Enough for a badge!

    While active, the project documentation MUST include an explanation of the contribution process. [OSPS-GV-03.01]
    Create a CONTRIBUTING.md or CONTRIBUTING/ directory to outline the contribution process including the steps for submitting changes, and engaging with the project maintainers.

    ▎ A contribution guide is published at
    ▎ https://github.com/timlnx/bitmath/blob/master/.github/CONTRIBUTING.md (GitHub
    ▎ auto-surfaces this on the Issues/PR creation pages) and is also rendered into
    ▎ the docsite at https://bitmath.readthedocs.io/en/latest/contributing.html.


    Enough for a badge!

    While active, the license for the source code MUST meet the OSI Open Source Definition or the FSF Free Software Definition. [OSPS-LE-02.01]
    Add a LICENSE file to the project's repo with a license that is an approved license by the Open Source Initiative (OSI), or a free license as approved by the Free Software Foundation (FSF). Examples of such licenses include the MIT, BSD 2-clause, BSD 3-clause revised, Apache 2.0, Lesser GNU General Public License (LGPL), and the GNU General Public License (GPL). Releasing to the public domain meets this control if there are no other encumbrances such as patents.

    ▎ bitmath is licensed under the MIT License, an OSI-approved and FSF-approved
    ▎ license. https://github.com/timlnx/bitmath/blob/master/LICENSE


    Enough for a badge!

    While active, the license for the released software assets MUST meet the OSI Open Source Definition or the FSF Free Software Definition. [OSPS-LE-02.02]
    If a different license is included with released software assets, ensure it is an approved license by the Open Source Initiative (OSI), or a free license as approved by the Free Software Foundation (FSF). Examples of such licenses include the MIT, BSD 2-clause, BSD 3-clause revised, Apache 2.0, Lesser GNU General Public License (LGPL), and the GNU General Public License (GPL). Note that the license for the released software assets may be different than the source code.

    ▎ The released wheel and sdist on PyPI are distributed under the same MIT License
    ▎ as the source. https://pypi.org/project/bitmath/


    Enough for a badge!

    While active, the license for the source code MUST be maintained in the corresponding repository's LICENSE file, COPYING file, or LICENSE/ directory. [OSPS-LE-03.01]
    Include the project's source code license in the project's LICENSE file, COPYING file, or LICENSE/ directory to provide visibility and clarity on the licensing terms. The filename MAY have an extension. If the project has multiple repositories, ensure that each repository includes the license file.

    ▎ The license text lives at https://github.com/timlnx/bitmath/blob/master/LICENSE
    ▎ in the repository root.


    Enough for a badge!

    While active, the license for the released software assets MUST be included in the released source code, or in a LICENSE file, COPYING file, or LICENSE/ directory alongside the corresponding release assets. [OSPS-LE-03.02]
    Include the project's released software assets license in the released source code, or in a LICENSE file, COPYING file, or LICENSE/ directory alongside the corresponding release assets to provide visibility and clarity on the licensing terms. The filename MAY have an extension. If the project has multiple repositories, ensure that each repository includes the license file.

    ▎ The Hatchling build backend (pyproject.toml) packages the LICENSE file into both ▎ the wheel and sdist published to PyPI.


    Enough for a badge!

    While active, the project's source code repository MUST be publicly readable at a static URL. [OSPS-QA-01.01]
    Use a common VCS such as GitHub, GitLab, or Bitbucket. Ensure the repository is publicly readable. Avoid duplication or mirroring of repositories unless highly visible documentation clarifies the primary source. Avoid frequent changes to the repository that would impact the repository URL. Ensure the repository is public.

    ▎ The source repository is publicly readable at the stable URL
    ▎ https://github.com/timlnx/bitmath. It has lived at this URL for over a decade
    ▎ and has no mirrors with conflicting authority.


    Enough for a badge!

    The version control system MUST contain a publicly readable record of all changes made, who made the changes, and when the changes were made. [OSPS-QA-01.02]
    Use a common VCS such as GitHub, GitLab, or Bitbucket to maintain a publicly readable commit history. Avoid squashing or rewriting commits in a way that would obscure the author of any commits.

    ▎ The full commit history is publicly readable at
    ▎ https://github.com/timlnx/bitmath/commits/master. Commits preserve author,
    ▎ committer, and timestamp; squash-merging that would obscure authorship is not
    ▎ used.


    Enough for a badge!

    When the package management system supports it, the source code repository MUST contain a dependency list that accounts for the direct language dependencies. [OSPS-QA-02.01]
    This may take the form of a package manager or language dependency file that enumerates all direct dependencies such as package.json, Gemfile, or go.mod.

    ▎ Runtime: bitmath has zero runtime dependencies (declared in pyproject.toml:
    ▎ https://github.com/timlnx/bitmath/blob/master/pyproject.toml). Development/test
    ▎ dependencies are listed in requirements.txt:
    ▎ https://github.com/timlnx/bitmath/blob/master/requirements.txt.


    Enough for a badge!

    Projects with multiple repositories MUST document a list of codebases that are part of the project. [OSPS-QA-04.01]
    Document any additional subproject code repositories produced by the project and compiled into a release. This documentation should include the status and intent of the respective codebase.

    ▎ bitmath is a single-repository project. No additional sub-project repositories ▎ exist.


    Enough for a badge!

    While active, the version control system MUST NOT contain generated executable artifacts. [OSPS-QA-05.01]
    Remove generated executable artifacts in the project's version control system. It is recommended that any scenario where a generated executable artifact appears critical to a process such as testing, it should be instead be generated at build time or stored separately and fetched during a specific well-documented pipeline step.

    ▎ git ls-files returns no .exe, .dll, .so, .dylib, .jar, .whl, .pyc, or other ▎ generated executable artifacts. Build outputs are excluded via .gitignore.


    Enough for a badge!

    While active, the version control system MUST NOT contain unreviewable binary artifacts. [OSPS-QA-05.02]
    Do not add any unreviewable binary artifacts to the project's version control system. This includes executable application binaries, library files, and similar artifacts. It does not include assets such as graphical images, sound or music files, and similar content typically stored in a binary format.

    ▎ Security contact and vulnerability disclosure process are published in
    ▎ https://github.com/timlnx/bitmath/blob/master/SECURITY.md, which GitHub surfaces
    ▎ in the repository's Security tab.


    Enough for a badge!

    While active, the project documentation MUST contain security contacts. [OSPS-VM-02.01]
    Create a security.md (or similarly-named) file that contains security contacts for the project.

    Security policy published in github standard way https://github.com/timlnx/bitmath/security/policy which pulls from the file in source control https://github.com/timlnx/bitmath/blob/master/SECURITY.md [vulnerability_report_process]


    Enough for a badge!

    (Obsolete criterion) When a CI/CD pipeline uses a branch name in its functionality, that name value MUST be sanitized and validated prior to use in the pipeline. [OSPS-BR-01.02]

    ▎ Marked obsolete in the OSPS criteria; superseded by OSPS-BR-01.01, which the ▎ project meets (see #5).



This data is available under the Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). This means that a Data Recipient may share the Data, with or without modifications, so long as the Data Recipient makes available the text of this agreement with the shared Data. Please credit Tim Case and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Tim Case.
Entry created on 2026-05-04 23:07:38 UTC, last updated on 2026-05-24 07:07:48 UTC. Last achieved passing badge on 2026-05-24 04:07:11 UTC.