Package Health Score

59 / 100

security
Security review needed
popularity
Recognized
maintenance
Inactive
community
Sustainable

Popularity

Recognized

GitHub Stars: 120
Forks: 35
Contributors: 10

Direct Usage Popularity

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

Security

Security review needed

Security and license risk for latest version

Release Date: Mar 23, 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

We found a way for you to contribute to the project! Looks like sphinx-press-theme 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: 23
Open PR: 1
Last Release: 9 months ago
Last Commit: 9 months ago

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

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

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Sustainable

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

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like sphinx-press-theme 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.6.*, ==3.7.*, ==3.8.*, ==3.9.*

Age: 6 years
Latest Release: 9 months ago
Dependencies: 0 Direct
Versions: 15
Maintainers: 0
Wheels: OS Independent

Readme

sphinx_press_theme

A modern responsive theme for python's Sphinx documentation generator.

See it in action on Press Theme own website

This theme is based on VuePress. It uses Vue.js & Stylus managed by vite.

Press theme is still in BETA. Contributions are welcome.

Install

First install the theme:

$ pip install sphinx_press_theme

Sphinx version compatibility

Sphinx	Press Theme
7.X	latest
4.X	0.8.0
3.X	0.6.1
2.X	0.5.1

Usage

On Sphinx project's conf.py: set the theme name to press.

html_theme = "press"

See details on configuration.

Development

First build web assets:

cd ui
npm install
npm run build

Sphinx theme has a soft link to built assets... Install theme locally with pip install -e ..

docs folder contains theme's own documentantion.

cd docs
make clean html

Release

Set version on:

setup.py
sphinx_press_theme/__init__.py
sphinx_press_theme/theme.conf
docs/source/conf.py
ui/package.json

Website

To update website:

cd ../press_site
rsync -rvi ../sphinx_press_theme/docs/build/html/ .
git add --all

FAQs

What is sphinx-press-theme?

A Sphinx-doc theme based on Vuepress. Visit Snyk Advisor to see a full health score report for sphinx-press-theme, including popularity, security, maintenance & community analysis.

Is sphinx-press-theme popular?

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

Is sphinx-press-theme well maintained?

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

Is sphinx-press-theme safe to use?

While scanning the latest version of sphinx-press-theme, 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 22 December-2024, at 19:09 (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-press-theme

A Sphinx-doc theme based on Vuepress For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

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_press_theme

Install

Usage

Development

Release

Website

FAQs

What is sphinx-press-theme?

Is sphinx-press-theme popular?

Is sphinx-press-theme well maintained?

Is sphinx-press-theme 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

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_press_theme

Install

Usage

Development

Release

Website

FAQs

What is sphinx-press-theme?

Is sphinx-press-theme popular?

Is sphinx-press-theme well maintained?

Is sphinx-press-theme 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