Package Health Score

69 / 100

security
No known security issues
popularity
Recognized
maintenance
Inactive
community
Sustainable

Popularity

Recognized

GitHub Stars: 159
Forks: 27
Contributors: 20

Direct Usage Popularity

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

Security

No known security issues

Security and license risk for latest version

Release Date: Apr 27, 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 autodoc_pydantic 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: 11
Last Release: 7 months ago
Last Commit: 2 months ago

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

We found that autodoc_pydantic 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: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the autodoc_pydantic 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 autodoc_pydantic 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: <4.0.0,>=3.8.1

Age: 4 years
Latest Release: 7 months ago
Dependencies: 0 Direct
Versions: 26
Maintainers: 1
Wheels: OS Independent

Readme

Autodoc Pydantic

You love pydantic ❤ and you want to document your models and configuration settings with sphinx?

Perfect, let's go. But wait, sphinx' autodoc does not integrate too well with pydantic models 😕.

Don't worry - just pip install autodoc_pydantic ☺.

🌟 Features

💬 provides default values, alias and constraints for model fields
🔗 adds hyperlinks between validators and corresponding fields
📃 includes collapsable model json schema
🏄 natively integrates with autodoc and autosummary extensions
📎 defines explicit pydantic prefixes for models, settings, fields, validators and model config
📋 shows summary section for model configuration, fields and validators
👀 hides overloaded and redundant model class signature
🔱 visualizes entity-relationship-diagrams for class hierarchies
🔨 allows complete configurability on global and per-model level
🍀 supports pydantic >= 1.5.0 and sphinx >= 4.0.0

📄 Documentation

Section	Description
📑 Landing Page	Guides and detailed information.
🛠️ Installation	Setup and installation procedures.
🔧 Configuration	System or application settings.
💡 Usage	How to use the application or tool.
🌐 Examples	Showcase and usage examples.
👨‍💻 Developer Guide	In-depth guide for developers.

🙏 Acknowledgements

Thanks to great open source projects sphinx, pydantic and poetry (and so many more) ❤ in addition to the following contributors:

_{Franz Wöllert} 🚧 📖 ⚠️ 🖋	_{Yves Renier} 📖 ⚠️ 🖋	_{TheBeardedBerserkr} 🤔	_{Jan Vlčinský} 🛡️	_antvig 🐛 📓	_{Hugo O Rivera} 🤔	_{yura bondarenko} 🐛 📓
_{Trevor Howard} 🐛 📓	_thomas-pedot 🐛 📓	_{Mat Utter} 🐛 📓	_{David C Hall} 🤔 📓	_{Josh A. Mitchell} 🤔 ⚠️	_{Roderick Go} ⚠️	_{Lily Wang} 📖 🖋
_j-carson 🐛 💻 ⚠️	_{Jakob Lykke Andersen} 💻	_{Juan Luis Cano Rodríguez} 🖋	_{Mikalai Chaly} 🐛 ⚠️	_{Stig Korsnes} 🐛 🤔	_{Ilia Kurenkov} 🐛	_{Grzegorz Bokota} 🐛
_jgunstone 🐛	_iwyrkore 💻	_{spacemanspiff2007} 🐛 🤔	_{Luke Hsiao} 🐛	_{Daniel Walker} 🐛	_{Evgeniy Lupashin} 🐛	_{Jan-Hendrik Ewers} 🐛
_{Jonny Saunders} 🐛	_{Charles Machalow} 💬	_{Thomas Karaouzene} 🐛	_caseyzak24 📖	_{Priscila Oliveira} 👀 📓	_{Arthur Woimbée} 👀 📓 💻 ⚠️	_{Chris Markiewicz} 🐛
_{David B. Nagle} 🐛	_JerryJia 💻	_{Mike D} 💻 🐛 ⚠️	_{Dario Quintero (Flexcompute)} 👀	_{Rafael Guedes} 💻	_{Andrew Linzie} 💻	_{Altay Sansal} 🤔
_{Tony Narlock} 💻 📖	_{Xuan (Sean) Hu} 🐛	_{Christian Riedel} 🐛	_morcef 🐛	_{alejandro-yousef} 🤔	_{exs-dwoodward} 💻	_{Leah Wasser} 🐛
_{Allan Galarza} 🐛	_Carson-Shaar 🐛	_{Kyle Finley} 🐛	_brunocruz 🐛	_{Anne Rademacher} 💵	_{Éloi Rivard} 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!

FAQs

What is autodoc_pydantic?

Seamlessly integrate pydantic models in your Sphinx documentation. Visit Snyk Advisor to see a full health score report for autodoc_pydantic, including popularity, security, maintenance & community analysis.

Is autodoc_pydantic popular?

The python package autodoc_pydantic receives a total of 45,887 weekly downloads. As such, autodoc_pydantic popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is autodoc_pydantic well maintained?

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

Is autodoc_pydantic safe to use?

The python package autodoc_pydantic 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 November-2024, at 00:52 (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

autodoc_pydantic

Seamlessly integrate pydantic models in your Sphinx documentation. 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

🌟 Features

📄 Documentation

🙏 Acknowledgements

FAQs

What is autodoc_pydantic?

Is autodoc_pydantic popular?

Is autodoc_pydantic well maintained?

Is autodoc_pydantic 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

🌟 Features

📄 Documentation

🙏 Acknowledgements

FAQs

What is autodoc_pydantic?

Is autodoc_pydantic popular?

Is autodoc_pydantic well maintained?

Is autodoc_pydantic 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