sphinx_design

v0.5.0

A sphinx extension for designing beautiful, view size responsive web components. For more information about how to use this package see README

Latest version published 2 months ago

License: MIT

PyPI

GitHub

Package Health Score

88 / 100

security
No known security issues
popularity
Popular
maintenance
Healthy
community
Active

Explore Similar Packages

Popularity

Popular

Total Weekly Downloads (215,747)

GitHub Stars: 155
Forks: 50
Contributors: 20

Direct Usage Popularity

The PyPI package sphinx_design receives a total of 215,747 downloads a week. As such, we scored sphinx_design popularity level to be Popular.

Based on project statistics from the GitHub repository for the PyPI package sphinx_design, we found that it has been starred 155 times.

The download numbers shown are the average weekly downloads from the last 6 weeks.

Security

No known security issues

Security and license risk for latest version

Release Date: Jul 27, 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_design 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

Healthy

Commit Frequency

Open Issues: 39
Open PR: 7
Last Release: 2 months ago
Last Commit: 29 days ago

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

We found that sphinx_design demonstrates a positive version release cadence with at least one new version released in the past 3 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: No
Code of Conduct: Yes
Contributors: 20
Funding: No

With more than 10 contributors for the sphinx_design 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: 2 years
Latest Release: 2 months ago
Dependencies: 0 Direct
Versions: 19
Maintainers: 2
Wheels: OS Independent

Readme

sphinx-design

A sphinx extension for designing beautiful, view size responsive web components.

Created with inspiration from Bootstrap (v5), Material Design and Material-UI design frameworks.

Usage

Simply pip install sphinx-design and add the extension to your conf.py:

extensions = ["sphinx_design"]

Supported browsers

Chrome >= 60
Firefox >= 60
Firefox ESR
iOS >= 12
Safari >= 12
Explorer >= 12

(Mirrors: )

Theme support

View the documentation in multiple themes:

Comparison to sphinx-panels

This package is an iteration on sphinx-panels and intends to replace it. See Migrating from sphinx-panels for more information.

Development

It is recommended to use tox to run the tests and document builds. Run tox -va to see all the available tox environments.

To run linting, formatting and SASS compilation, use pre-commit. pre-commit run --all css will run the SASS compiler, for which you will need node and npm installed, or you can directly run npm run css.

TODO

note design goal; to be flexible, but limit the amount of directive nesting required. This factors in to
- card header/footer syntax? (don't really want to have to use separate directives for these, hence ^^^/+++ syntax)
- auto-wrap grid-item and tab-item, if not already inside grid or tab-set?

grids items cannot contain headers; is this in anyway possible with docutils structure?

naming of directives/roles: standard prefix?

why are cards setup with "word-wrap: break-word;"?

handle latex

Use autoprefixer when compiling SASS (see )

horizontal card (grid row inside card, picture on left)

subtitle for card (see )

rtd PRs not working

FAQs

What is sphinx_design?

A sphinx extension for designing beautiful, view size responsive web components. Visit Snyk Advisor to see a full health score report for sphinx_design, including popularity, security, maintenance & community analysis.

Is sphinx_design popular?

The python package sphinx_design receives a total of 215,747 weekly downloads. As such, sphinx_design popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is sphinx_design well maintained?

We found that sphinx_design demonstrated a healthy version release cadence and project activity. It has a community of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is sphinx_design safe to use?

The python package sphinx_design 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 28 September-2023, at 08:47 (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