Package Health Score

58 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Active

Popularity

Small

Total Weekly Downloads (10)

GitHub Stars: 34.72K
Forks: 13.3K
Contributors: 80

Direct Usage Popularity

The PyPI package check-docstring receives a total of 10 downloads a week. As such, we scored check-docstring popularity level to be Small.

Based on project statistics from the GitHub repository for the PyPI package check-docstring, we found that it has been starred 34,723 times.

The download numbers shown are the average weekly downloads from the last 6 weeks.

Security

No known security issues

Security and license risk for latest version

Release Date: Nov 19, 2021
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like check-docstring is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 198
Open PR: 121
Last Release: 2 years ago
Last Commit: 1 month ago

Further analysis of the maintenance status of check-docstring based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for check-docstring is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 80
Funding: No

With more than 10 contributors for the check-docstring repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.6.*

Age: 2 years
Latest Release: 2 years ago
Dependencies: N/A
Versions: 1
Maintainers: 1
Wheels: No

Readme

BD RD Docstring Checker

Usage

check_docstring PATH

where PATH can be a file or a directory. All Python scripts will be collected and checked.

Docstring Convention

Google style docstring ref1 ref2 ref3

def example_function(param1, param2):
    """
    This is an example of a function docstring.
    More descriptions go here.

    Args:
        param1 (int): The first parameter.
            Second line has to be indented.
        param2 (str): The second parameter.

    Returns:
        bool: True if successful, False otherwise.

    Raises:
        AttributeError: The ``Raises`` section is a list of all exceptions
            that are relevant to the interface.
        ValueError: If `param2` is equal to `param1`.
    """

    if param1 == param2:
        raise ValueError('param1 may not be equal to param2')
    return True

Last updated: 2021/11/19

FAQs

What is check-docstring?

BD RD docstring format checker. Visit Snyk Advisor to see a full health score report for check-docstring, including popularity, security, maintenance & community analysis.

Is check-docstring popular?

The python package check-docstring receives a total of 10 weekly downloads. As such, check-docstring popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is check-docstring well maintained?

We found indications that check-docstring is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is check-docstring safe to use?

The python package check-docstring was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 30 May-2023, at 13:33 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

check-docstring

BD RD docstring format checker. For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Popularity

Total Weekly Downloads (10)

Direct Usage Popularity

Security

Security and license risk for latest version

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

BD RD Docstring Checker

Usage

Docstring Convention

FAQs

What is check-docstring?

Is check-docstring popular?

Is check-docstring well maintained?

Is check-docstring safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Total Weekly Downloads (10)

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

BD RD Docstring Checker

Usage

Docstring Convention

FAQs

What is check-docstring?

Is check-docstring popular?

Is check-docstring well maintained?

Is check-docstring safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues