django_wtfd
wtfd(write the f*ing docs) is a Django library that forces developers to write docstrings.
Developed on Django 1.5.8
Installation
pip install django_wtfd
Add django_wtfd to your project’s INSTALLED_APPS.
Settings
- WTFD_APPS
List of project’s apps to include in docstrings check. If its not set all the .py files in project will be checked.
- WTFD_STRICT
If set to True, checks will raise an exception in case some method/function/class is missing docstrings. Defaults to False.
Usage
To perform docstrings check, run: ./manage.py wtfd
Notes
Docstrings check skips magic methods, migrations, Meta class and modules that have ‘test’ in their name.
1 maintainer
Metadata
1 maintainer
Release files for django_wtfd 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| django_wtfd-0.1.4.tar.gz | 4.8 kB | Without provenance | Details for django_wtfd-0.1.4.tar.gz |
Release files / django_wtfd-0.1.4.tar.gz
| Download URL | django_wtfd-0.1.4.tar.gz |
|---|---|
| Size | 4.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d325dcde5a9e6ab8476639219a4899bc1cb067cc03603004c2bda03805aac4d9
|
|
BLAKE2b-256 checksum How to use checksums |
623ca18dfcc82037645fcf4fe1fe1dece3094b8065d5c64833f38ede5cfbfd78
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for django_wtfd 0.1.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
