sphinx-automodapi

v0.18.0

Sphinx extension for auto-generating API documentation for entire modules For more information about how to use this package see README

Latest version published 3 months ago

License: BSD-3-Clause

PyPI

GitHub

Package Health Score

75 / 100

security
No known security issues
popularity
Recognized
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

autodoc
40

Popularity

Recognized

GitHub Stars: 66
Forks: 46
Contributors: 40

Direct Usage Popularity

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

Security

No known security issues

Security and license risk for latest version

Release Date: Sep 13, 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
0
M
0
L

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

License

BSD-3-Clause

Security Policy

We found a way for you to contribute to the project! Looks like sphinx-automodapi 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

Sustainable

Commit Frequency

Open Issues: 47
Open PR: 5
Last Release: 3 months ago
Last Commit: 25 days ago

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

We found that sphinx-automodapi 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

Sustainable

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

With more than 10 contributors for the sphinx-automodapi 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.8

Age: 8 years
Latest Release: 3 months ago
Dependencies: 0 Direct
Versions: 19
Maintainers: 0
Wheels: OS Independent

Readme

About

This is a Sphinx extension to automatically generate API pages for whole modules. It was originally developed for the Astropy project but is now available as a standalone package since it can be used for any other package. The documentation can be found on ReadTheDocs.

Running tests

To run the tests, you can either do:

pytest sphinx_automodapi

or if you have tox installed:

tox -e test

Development status

Due to the limitations of FOSS development model, the Astropy Project does not have enough bandwidth to add new features or fixes to this package beyond what is necessary for the project itself. Therefore, we apologize for any inconvenience caused by unresolved open issues and unmerged stale pull requests. If you have any questions or concerns, please contact the project via . Thank you for your interest in this package!

FAQs

What is sphinx-automodapi?

Sphinx extension for auto-generating API documentation for entire modules. Visit Snyk Advisor to see a full health score report for sphinx-automodapi, including popularity, security, maintenance & community analysis.

Is sphinx-automodapi popular?

The python package sphinx-automodapi receives a total of 30,249 weekly downloads. As such, sphinx-automodapi popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is sphinx-automodapi well maintained?

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

Is sphinx-automodapi safe to use?

The python package sphinx-automodapi 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 26 December-2024, at 08:06 (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