Kedro

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.

If this is your project, please show your badge status on your project page! The badge status looks like this: Badge level for project 6711 is passing Here is how to embed it:

These are the Gold level criteria. You can also view the Passing or Silver level criteria.

        

 Basics 2/5

  • Identification

    Kedro is an open-source Python framework for creating reproducible, maintainable and modular data science code. It borrows concepts from software engineering and applies them to machine-learning code; applied concepts include modularity, separation of concerns and versioning.

  • Prerequisites


    The project MUST achieve a silver level badge. [achieve_silver]

  • Project oversight


    Mradi LAZIMA uwe na "bus factor" ya 2 au zaidi. (URL required) [bus_factor]

    output of Truck-Factor is TF=6

    TF = 6 (coverage = 49.67%)
    TF authors (Developer;Files;Percentage):
    tsanikgr;121;19.90
    Jo Stichbury;120;19.74
    Lorena Balan;77;12.66
    Merel Theisen;62;10.20
    Dmitrii Deriabin;35;5.76
    Lim H;30;4.93
    

    https://github.com/kedro-org/kedro/issues/3597#issuecomment-2497086034



    Mradi LAZIMA uwe na angalau wachangiaji wawili wasiohusika. (URL required) [contributors_unassociated]

  • Other


    The project MUST include a license statement in each source file. This MAY be done by including the following inside a comment near the beginning of each file: SPDX-License-Identifier: [SPDX license expression for project]. [license_per_file]

    License statement is not yet included in every source file.


  • Public version-controlled source repository


    The project's source repository MUST use a common distributed version control software (e.g., git or mercurial). [repo_distributed]

    Repository on GitHub, which uses git. git is distributed.



    The project MUST clearly identify small tasks that can be performed by new or casual contributors. (URL required) [small_tasks]

    The project MUST require two-factor authentication (2FA) for developers for changing a central repository or accessing sensitive data (such as private vulnerability reports). This 2FA mechanism MAY use mechanisms without cryptographic mechanisms such as SMS, though that is not recommended. [require_2FA]


    The project's two-factor authentication (2FA) SHOULD use cryptographic mechanisms to prevent impersonation. Short Message Service (SMS) based 2FA, by itself, does NOT meet this criterion, since it is not encrypted. [secure_2FA]

  • Coding standards


    Mradi LAZIMA uandike mahitaji yake ya kukagua msimbo, pamoja na jinsi ukaguzi wa nambari unafanywa, nini lazima ichunguzwe, na nini kinachohitajika ili ikubalike. (URL required) [code_review_standards]

    Automatic checks are in place for static code analysis and code style, see https://github.com/kedro-org/kedro/actions/workflows/all-checks.yml



    The project MUST have at least 50% of all proposed modifications reviewed before release by a person other than the author, to determine if it is a worthwhile modification and free of known issues which would argue against its inclusion [two_person_review]

    Every pull request must be reviewed and approved by 2 people other than the author


  • Working build system


    The project MUST have a reproducible build. If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). (URL required) [build_reproducible]

    The software has no build step.


  • Automated test suite


    A test suite MUST be invocable in a standard way for that language. (URL required) [test_invocation]

    The test suite runs in every commit of every pull request, see https://github.com/kedro-org/kedro/actions/workflows/all-checks.yml



    The project MUST implement continuous integration, where new or changed code is frequently integrated into a central code repository and automated tests are run on the result. (URL required) [test_continuous_integration]

    Continuous Integration happens on GitHub Actions, see https://github.com/kedro-org/kedro/actions/workflows/all-checks.yml



    The project MUST have FLOSS automated test suite(s) that provide at least 90% statement coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. [test_statement_coverage90]

    The test suite mandates 100 % coverage, measured with coverage.py



    The project MUST have FLOSS automated test suite(s) that provide at least 80% branch coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. [test_branch_coverage80]

    The test suite mandates 100 % coverage, measured with coverage.py


  • Use basic good cryptographic practices

    Note that some software does not need to use cryptographic mechanisms. If your project produces software that (1) includes, activates, or enables encryption functionality, and (2) might be released from the United States (US) to outside the US or to a non-US-citizen, you may be legally required to take a few extra steps. Typically this just involves sending an email. For more information, see the encryption section of Understanding Open Source Technology & US Export Controls.

    The software produced by the project MUST support secure protocols for all of its network communications, such as SSHv2 or later, TLS1.2 or later (HTTPS), IPsec, SFTP, and SNMPv3. Insecure protocols such as FTP, HTTP, telnet, SSLv3 or earlier, and SSHv1 MUST be disabled by default, and only enabled if the user specifically configures it. If the software produced by the project does not support network communications, select "not applicable" (N/A). [crypto_used_network]

    The software relies on fsspec for most of its network communications (data I/O).



    The software produced by the project MUST, if it supports or uses TLS, support at least TLS version 1.2. Note that the predecessor of TLS was called SSL. If the software does not use TLS, select "not applicable" (N/A). [crypto_tls12]

    The software does not use TLS.


  • Secured delivery against man-in-the-middle (MITM) attacks


    The project website, repository (if accessible via the web), and download site (if separate) MUST include key hardening headers with nonpermissive values. (URL required) [hardened_site]

    // X-Content-Type-Options was not set to "nosniff". // One or more of the required security hardening headers is missing.


  • Other security issues


    The project MUST have performed a security review within the last 5 years. This review MUST consider the security requirements and security boundary. [security_review]


    Hardening mechanisms MUST be used in the software produced by the project so that software defects are less likely to result in security vulnerabilities. (URL required) [hardening]

    The software does not interact with the network by itself and doesn't have a build nor compilation step.


  • Dynamic code analysis


    The project MUST apply at least one dynamic analysis tool to any proposed major production release of the software produced by the project before its release. [dynamic_analysis]

    The software uses MyPy, bandit, and other dynamic analysis tools that run on its Continuous Integration



    The project SHOULD include many run-time assertions in the software it produces and check those assertions during dynamic analysis. [dynamic_analysis_enable_assertions]

    Assertions are included (albeit sparingly, given that they can be disabled in certain modes of execution, e.g. python -O)



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 Yetunde Dada and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Yetunde Dada.
Entry created on 2022-11-17 11:48:49 UTC, last updated on 2024-11-25 07:34:04 UTC. Last achieved passing badge on 2022-11-17 12:46:29 UTC.

Back