sphinxcontrib-towncrier

v0.4.0a0

An RST directive for injecting a Towncrier-generated changelog draft containing fragments for the unreleased (next) project version For more information about how to use this package see README

Latest version published 12 months ago

License: BSD-3-Clause

PyPI

GitHub

Package Health Score

63 / 100

security
Security review needed
popularity
Small
maintenance
Sustainable
community
Sustainable

Popularity

Small

GitHub Stars: 19
Forks: 17
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package sphinxcontrib-towncrier, we found that it has been starred 19 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Nov 9, 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
1
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 sphinxcontrib-towncrier 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: 12
Open PR: 3
Last Release: 12 months ago
Last Commit: 2 months ago

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

We found that sphinxcontrib-towncrier 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

Sustainable

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

With more than 10 contributors for the sphinxcontrib-towncrier 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 sphinxcontrib-towncrier 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

Age: 4 years
Latest Release: 12 months ago
Dependencies: 3 Direct / 31 Total
Versions: 12
Maintainers: 2
Wheels: OS Independent

Readme

sphinxcontrib-towncrier

An RST directive for injecting a Towncrier-generated changelog draft containing fragments for the unreleased (next) project version.

How to use this?

$ pip install sphinxcontrib-towncrier

extensions = ['sphinxcontrib.towncrier.ext']

# Options: draft/sphinx-version/sphinx-release
towncrier_draft_autoversion_mode = 'draft'
towncrier_draft_include_empty = True
towncrier_draft_working_directory = PROJECT_ROOT_DIR
# Not yet supported:
# towncrier_draft_config_path = 'pyproject.toml'  # relative to cwd

Make sure to point to the dir with pyproject.toml and pre-configure towncrier itself in the config.

If everything above is set up correctly, you should be able to add

.. towncrier-draft-entries::

to your documents, like changelog.rst. With no argument, the version title will be generated using the strategy set up in the towncrier_draft_autoversion_mode setting.

If you want to be in control, override it with an argument you like:

.. towncrier-draft-entries:: |release| [UNRELEASED DRAFT]

Native RST substitutions in the argument work, just make sure to declare any non-default ones via rst_epilog or at the end of the document where the towncrier-draft-entries directive is being used.

Does anybody actually use this?

So far we know about two projects using sphinxcontrib-towncrier — ansible/pylibssh and pypa/pip. Also, this Sphinx extension is inspired by and somewhat based on the ideas used in pytest-dev/pytest and tox-dev/tox. We believe that these projects are full of wonderful tricks that you may want to explore regardless of whether you'll use our project.

sphinxcontrib-towncrier dependencies

importlib-metadata sphinx towncrier

FAQs

What is sphinxcontrib-towncrier?

An RST directive for injecting a Towncrier-generated changelog draft containing fragments for the unreleased (next) pro... Visit Snyk Advisor to see a full health score report for sphinxcontrib-towncrier, including popularity, security, maintenance & community analysis.

Is sphinxcontrib-towncrier popular?

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

Is sphinxcontrib-towncrier well maintained?

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

While scanning the latest version of sphinxcontrib-towncrier, 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 7 November-2024, at 16:51 (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

sphinxcontrib-towncrier

How to use this?

Does anybody actually use this?

sphinxcontrib-towncrier dependencies

FAQs

What is sphinxcontrib-towncrier?

Is sphinxcontrib-towncrier popular?

Is sphinxcontrib-towncrier well maintained?

Is sphinxcontrib-towncrier 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