sphinx-nbblog

v0.3.0

A small Sphinx extension to enable tags and archive in documentation such as for a blog. For more information about how to use this package see README

Latest version published 6 months ago

License: MIT

PyPI

GitHub

Package Health Score

78 / 100

security
No known security issues
popularity
Small
maintenance
Sustainable
community
Active

Popularity

Small

GitHub Stars: 39.8K
Forks: 3.07K
Contributors: 410

Direct Usage Popularity

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

Security

No known security issues

Security and license risk for latest version

Release Date: Jun 28, 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

MIT

Security Policy

We found a way for you to contribute to the project! Looks like sphinx-nbblog 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: 62
Open PR: 9
Last Release: 6 months ago
Last Commit: 15 days ago

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

We found that sphinx-nbblog 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-nbblog 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-nbblog 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.9

Age: 1 year
Latest Release: 6 months ago
Dependencies: 2 Direct
Versions: 6
Maintainers: 0
Wheels: OS Independent

Readme

Sphinx nbblog

A small Sphinx extension to enable tags and archive in documentation such as for a blog.

Table of Contents

Installation

pip install sphinx-nbblog

Usage

Add sphinx-nbblog somewhere in the extensions list in conf.py

extensions = [
    ...
    "sphinx_nbblog",
]

In an .rst file or in a .ipynb raw rst cell:

.. nbblog::
   :abstract: what is this about
   :date: 2023-09-23
   :tags: yes, no, maybe

In another file, such as archive.rst

Archive
=======

.. archive::

The abstract currently does nothing but at some point I will probably make it visible in the archive page.

Development

I use Hatch, pyenv, and LunarVim

hatch run lvim

Test

After installing the python versions with pyenv, run:

hatch run test:test

License

sphinx-nbblog is distributed under the terms of the MIT license.

Notes

This project is based on sphinx-tags

sphinx-nbblog dependencies

nbsphinx sphinx

FAQs

What is sphinx-nbblog?

A small Sphinx extension to enable tags and archive in documentation such as for a blog. Visit Snyk Advisor to see a full health score report for sphinx-nbblog, including popularity, security, maintenance & community analysis.

Is sphinx-nbblog popular?

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

Is sphinx-nbblog well maintained?

We found indications that sphinx-nbblog 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-nbblog safe to use?

The python package sphinx-nbblog 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 22 December-2024, at 02: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

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 nbblog

Installation

Usage

Development

Test

License

Notes

sphinx-nbblog dependencies

FAQs

What is sphinx-nbblog?

Is sphinx-nbblog popular?

Is sphinx-nbblog well maintained?

Is sphinx-nbblog 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