sphinx-autosummary-accessors

v2023.4.0

sphinx autosummary extension to properly format pandas or xarray accessors For more information about how to use this package see README

Latest version published 2 years ago

License: MIT

PyPI

GitHub

Package Health Score

51 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Sustainable

Popularity

Small

GitHub Stars: 13
Forks: 5
Contributors: 7

Direct Usage Popularity

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

Security

No known security issues

Security and license risk for latest version

Release Date: Apr 12, 2023
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

MIT

Security Policy

We found a way for you to contribute to the project! Looks like sphinx-autosummary-accessors 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: 1
Open PR: 4
Last Release: 2 years ago
Last Commit: 7 months ago

Further analysis of the maintenance status of sphinx-autosummary-accessors 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 sphinx-autosummary-accessors 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

Sustainable

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

This project has seen only 10 or less contributors.

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: 4 years
Latest Release: 2 years ago
Dependencies: 1 Direct
Versions: 7
Maintainers: 1
Wheels: OS Independent

Readme

sphinx-autosummary-accessors

A sphinx extension to properly document pandas or xarray accessors.

sphinx.ext.autosummary is able to create summary and object pages for objects and their methods, but it doesn't work well with accessor styled properties and methods (obj.accessor.attribute). pandas has accessor documentation built using sphinx.ext.autosummary templates, which xarray recently adopted by copying the templates and all related code.

To avoid even more duplicated code, and to make it easier for projects to document their custom accessors, this project aims to provide this functionality by way of a sphinx extension.

Most of the code was adapted from pandas.

Usage

Using it should be as simple as adding

import sphinx_autosummary_accessors

extensions = [
    ...,
    "sphinx_autosummary_accessors",
]
templates = ["_templates", ..., sphinx_autosummary_accessors.templates_path]

to your conf.py and using the appropriate template:

.. autosummary::
   :template: autosummary/accessor_method.rst

   Example.test.multiply

Documentation

For more information and examples, see the documentation.

sphinx-autosummary-accessors dependencies

sphinx

FAQs

What is sphinx-autosummary-accessors?

sphinx autosummary extension to properly format pandas or xarray accessors. Visit Snyk Advisor to see a full health score report for sphinx-autosummary-accessors, including popularity, security, maintenance & community analysis.

Is sphinx-autosummary-accessors popular?

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

Is sphinx-autosummary-accessors well maintained?

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

Is sphinx-autosummary-accessors safe to use?

The python package sphinx-autosummary-accessors 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 8 November-2024, at 03:23 (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

Package Health Score

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-autosummary-accessors

Usage

Documentation

sphinx-autosummary-accessors dependencies

FAQs

What is sphinx-autosummary-accessors?

Is sphinx-autosummary-accessors popular?

Is sphinx-autosummary-accessors well maintained?

Is sphinx-autosummary-accessors 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