Package Health Score

70 / 100

security
No known security issues
popularity
Recognized
maintenance
Sustainable
community
Limited

Popularity

Recognized

GitHub Stars: 48
Forks: 5
Contributors: 20

Direct Usage Popularity

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

Security

No known security issues

Security and license risk for latest version

Release Date: Aug 7, 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-prompt 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: 11
Open PR: 0
Last Release: 5 months ago
Last Commit: 21 days ago

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

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

Limited

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

With more than 10 contributors for the sphinx-prompt repository, this is possibly a sign for a growing and inviting community.

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

Age: 11 years
Latest Release: 5 months ago
Dependencies: 5 Direct
Versions: 14
Maintainers: 0
Wheels: OS Independent

Not sure how to use sphinx-prompt?

To help you get started, we've collected the most common ways that sphinx-prompt is being used within popular public projects.

sbrunner / sphinx-prompt / sphinx-prompt / __init__.py View on Github

if prompt in self.prompts:
            return ''
        else:
            index = self.next_index
            self.next_index = index + 1
            self.prompts[prompt] = index
            return """span.prompt{0:d}:before {{
  content: "{1!s} ";
}}
""".format(index, prompt)

    def get_prompt_class(self, prompt):
        return 'prompt{0:d}'.format(self.prompts[prompt])


cache = PromptCache()


class PromptDirective(rst.Directive):

    optional_arguments = 3
    has_content = True

    def run(self):
        self.assert_has_content()

        language = 'text'
        prompt = None
        modifiers = []

        if self.arguments:
            language = self.arguments[0]

View more ways to use sphinx-prompt

Sphinx Prompt

Initialize

In conf.py add extensions += ['sphinx_prompt'].

Syntax

A default prompt can be created using a prompt directive:

.. prompt::

The prompt can be further customized in one of two ways:

Using positional arguments:
```
.. prompt:: [ [ []]]

    
```

Using options:

.. prompt::
    :language: 
    :prompts: 
    :modifiers:

While these constructs generate the same output, the positional arguments cannot be used if you want to use a prompt that contains spaces. This is a limitation of reStructuredText.

Positional arguments can be mixed with options if they don't overlap (so if you pass prompts using options, you can only pass the language using positional arguments):

.. prompt:: bash
    :prompts: (cool_project) $

   python3 -m pip install --upgrade sphinx-prompt

Language

Supported language:

text (no pigments, default)
bash
batch
powershell
python
scala

Prompt(s)

If modifier is auto, a comma-separated list of prompts to find in the statements.

Else the prompt to add on each statements, for Python and Bash language the end \ is supported.

Defaults to empty, except for the shell languages listed below:

bash - $
batch - C:\>
powershell - PS C:\>

Examples

See:

Run tests and prospector

python3 -m pip install --user --upgrade poetry
poetry install
poetry run pytest
poetry run prospector

The code should be formatted with black add isort.

Create new release

git tag 
git push origin

Contributing

Install the pre-commit hooks:

pip install pre-commit
pre-commit install --allow-missing-config

sphinx-prompt dependencies

certifi docutils idna pygments urllib3

FAQs

What is sphinx-prompt?

Sphinx directive to add unselectable prompt. Visit Snyk Advisor to see a full health score report for sphinx-prompt, including popularity, security, maintenance & community analysis.

Is sphinx-prompt popular?

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

Is sphinx-prompt well maintained?

We found indications that sphinx-prompt maintenance is sustainable demonstrating some project activity. We saw a total 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-prompt safe to use?

The python package sphinx-prompt 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 21 December-2024, at 08:32 (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-prompt

Sphinx directive to add unselectable prompt 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

Not sure how to use sphinx-prompt?

Sphinx Prompt

Initialize

Syntax

Language

Prompt(s)

Examples

Run tests and prospector

Create new release

Contributing

sphinx-prompt dependencies

FAQs

What is sphinx-prompt?

Is sphinx-prompt popular?

Is sphinx-prompt well maintained?

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

Not sure how to use sphinx-prompt?

Sphinx Prompt

Initialize

Syntax

Language

Prompt(s)

Examples

Run tests and prospector

Create new release

Contributing

sphinx-prompt dependencies

FAQs

What is sphinx-prompt?

Is sphinx-prompt popular?

Is sphinx-prompt well maintained?

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