Package Health Score

70 / 100

security
Security review needed
popularity
Small
maintenance
Sustainable
community
Active

Explore Similar Packages

Popularity

Small

GitHub Stars: 8.06K
Forks: 3.59K
Contributors: 410

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package sphinx-lfs-content, we found that it has been starred 8,056 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Apr 4, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
1
M
0
L

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

License

MIT

Security Policy

Yes

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

Sustainable

Commit Frequency

Open Issues: 362
Open PR: 43
Last Release: 9 months ago
Last Commit: 1 month ago

Further analysis of the maintenance status of sphinx-lfs-content based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that sphinx-lfs-content demonstrates a positive version release cadence with at least one new version released in the past 12 months.

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: Yes
Code of Conduct: No
Contributors: 410
Funding: Yes

A good and healthy external contribution signal for sphinx-lfs-content 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 sphinx-lfs-content 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.*

Age: 3 years
Latest Release: 9 months ago
Dependencies: N/A
Versions: 13
Maintainers: 3
Wheels: No

Readme

sphinx_lfs_content

Git LFS is a popular method to store large files like e.g. documentation assets in git repositories. Building such documentation on a system without Git LFS will typically result in broken documentation. sphinx_lfs_content is a minimalistic Sphinx extension that ensures that git-lfs is installed and otherwise installs it and fetches LFS content. It is motivated by the lack of LFS support on readthedocs.org.

Installation

The extension can be installed from PyPI using pip:

python -m pip install sphinx_lfs_content

If you use a requirements file to describe the dependencies of your documentation build, simply add sphinx_lfs_content to it.

How to use it

Add the following lines to your conf.py:

# The list of enabled extensions
extensions = [
    "sphinx_lfs_content",
]

That's all. The extension will check whether the system has git-lfs and download a version from the git-lfs GitHub page, verify its checksum and checkout any LFS content.

Additionally, a configuration value lfs_content_post_commands is available. It accepts a list of strings with commands that will be executed after the git-lfs checkout was performed. This can be used to resolve chicken-egg situations with other setup code.

Restrictions

The extension is very likely to only work on Linux right now, as it does not properly select the git-lfs archive to download.

FAQs

What is sphinx-lfs-content?

Ensure existence of LFS content in your LFS builds. Visit Snyk Advisor to see a full health score report for sphinx-lfs-content, including popularity, security, maintenance & community analysis.

Is sphinx-lfs-content popular?

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

Is sphinx-lfs-content well maintained?

We found indications that sphinx-lfs-content maintenance is sustainable demonstrating some project activity. We saw a total of 410 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is sphinx-lfs-content safe to use?

While scanning the latest version of sphinx-lfs-content, 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 1 December-2024, at 07:21 (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

sphinx-lfs-content

Ensure existence of LFS content in your LFS builds 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

sphinx_lfs_content

Installation

How to use it

Restrictions

FAQs

What is sphinx-lfs-content?

Is sphinx-lfs-content popular?

Is sphinx-lfs-content well maintained?

Is sphinx-lfs-content 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

sphinx_lfs_content

Installation

How to use it

Restrictions

FAQs

What is sphinx-lfs-content?

Is sphinx-lfs-content popular?

Is sphinx-lfs-content well maintained?

Is sphinx-lfs-content 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