Package Health Score

54 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Active

Explore Similar Packages

Popularity

Small

GitHub Stars: 66.53K
Forks: 2.42K
Contributors: 260

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package doc-fzf, we found that it has been starred 66,535 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Jul 25, 2019
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 1
H
1
M
0
L

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

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like doc-fzf 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: 239
Open PR: 60
Last Release: 5 years ago
Last Commit: 3 days ago

Further analysis of the maintenance status of doc-fzf 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 doc-fzf 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: No
Contributors: 260
Funding: Yes

A good and healthy external contribution signal for doc-fzf project, which invites more than one hundred open source maintainers to collaborate on the repository.

We found a way for you to contribute to the project! Looks like doc-fzf is missing a Code of Conduct.

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.5.*, ==3.6.*, ==3.7.*

Age: 5 years
Latest Release: 5 years ago
Dependencies: N/A
Versions: 7
Maintainers: 0
Wheels: No

Readme

Doc-FZF: Modular CLI Documentation Fuzzy Finder

Fuzzy Search documentation from the CLI and open them in the browser.

See it in action here https://terminalizer.com/view/2c3935cf1418

Disclaimer This tool was built to learn FZF capabilities. Feel free to use it or extend it.

Usage

doc-fzf ansible
doc-fzf ansible -q yum

Installation

pip3 install doc-fzf

Verify your installation:

doc-fzf -h

usage: doc-fzf.py [-h] [-q QUERY] module_name

doc-fzf.

positional arguments:
module_name  Name of the module to search

optional arguments:
-h, --help   show this help message and exit
-q QUERY     Query the docs

Extending Doc-FZF

doc-fzf is a modular application. It can load modules at runtime that scrap websites in any way you like.

Any module should always contain:

class name must always be Scrapper(FZFDoc)
self.documentation_url attribute
def get_documentation(self): function that must always return a tuple ("url", "description")

from doc_fzf.pyfzf import FZFDoc


class Scrapper(FZFDoc):
    def __init__(self):
        self.base_url = "https://docs.python.org/3"
        self.documentation_url = "{0}/py-modindex.html".format(self.base_url)
        FZFDoc.__init__(self, self.documentation_url)

    def get_documentation(self):
        """ Return a tuple of (url, description)
        """
        docs = get_online_documentation()
        for doc in docs:
            yield (doc.url, doc.description)

Here is the ansible documentation example

Road Map

[x] Module definition
[x] FZFDoc base class
[x] File system cache layer
[ ] Load modules at runtime

References

FAQs

What is doc-fzf?

Fuzzy Search documentation from the CLI. Visit Snyk Advisor to see a full health score report for doc-fzf, including popularity, security, maintenance & community analysis.

Is doc-fzf popular?

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

Is doc-fzf well maintained?

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

Is doc-fzf safe to use?

While scanning the latest version of doc-fzf, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 24 December-2024, at 02:14 (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

doc-fzf

Fuzzy Search documentation from the CLI For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Explore Similar Packages

Popularity

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

Doc-FZF: Modular CLI Documentation Fuzzy Finder

Usage

Installation

Extending Doc-FZF

Road Map

References

FAQs

What is doc-fzf?

Is doc-fzf popular?

Is doc-fzf well maintained?

Is doc-fzf 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

Explore Similar Packages

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

Doc-FZF: Modular CLI Documentation Fuzzy Finder

Usage

Installation

Extending Doc-FZF

Road Map

References

FAQs

What is doc-fzf?

Is doc-fzf popular?

Is doc-fzf well maintained?

Is doc-fzf 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