Registry / testing / dodgy
library0.2.1pypypiunverified

Dodgy is a basic static analysis tool designed to scan Python codebases for 'dodgy' looking values. It uses simple regular expressions to detect patterns such as accidentally committed SCM diffs, hardcoded passwords, or secret keys. While initially developed for open-source projects to prevent public exposure of sensitive data, it can also be used in private projects, though its configurability is limited. The project appears to be inactive since its last release in 2019.

pip install dodgy
INSTALL
IMPORT
SIG · DODGY
D
dodgy
testingpythonv0.2.1
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Run Dodgy from the command line against your project directory to scan for problematic patterns. It's often recommended to integrate this as a pre-commit hook.

dodgy /path/to/your/project
dodgy --version
Debug
Known issues
breakingThe `dodgy` project is officially marked as 'Inactive' on PyPI, with its last release in December 2019. This means it is unlikely to receive updates, bug fixes, or new feature development, potentially leading to compatibility issues with newer Python versions or false positives/negatives.
fix
Consider using more actively maintained static analysis tools for sensitive data detection, such as 'bandit' or custom regular expression-based linters.
affects: <=0.2.1
gotchaPyPI classifiers indicate support up to Python 3.6. Running `dodgy` on Python versions 3.7+ may lead to unexpected behavior or errors due to lack of compatibility updates.
fix
Test thoroughly if using with newer Python versions, or consider migrating to a more modern tool. The `prospector` tool (which used to integrate `dodgy`) might offer a more up-to-date solution.
affects: >=0.2.1 (Python 3.7+)
gotchaThe name 'dodgy' has been associated with various malicious packages on PyPI, leveraging typosquatting or other techniques to trick users into installing malware. Ensure you are installing the legitimate `dodgy` package from `landscapeio` (version 0.2.1) and not a similarly named malicious variant.
fix
Always verify the package name, author, and version on PyPI before installation. Cross-reference with the official GitHub repository (github.com/landscapeio/dodgy) to confirm authenticity.
affects: All versions
gotchaThe tool's configurability is noted in its README as 'not configurable enough currently to change that,' referring to its output often pointing out things that are not problems for private projects. This can lead to a high number of false positives in certain contexts.
fix
Understand that `dodgy` is a basic tool. Supplement its use with manual code reviews or more sophisticated, configurable secrets detection tools that allow for custom rule sets and exclusions.
affects: All versions
Errors
Common errors & fixes
ModuleNotFoundError: No module named 'dodgy'
The 'dodgy' library is not installed in the Python environment being used, or there is a typo in the import statement.
fix
Install the package using `pip install dodgy` and ensure you are running your script in the correct Python environment.
dodgy: command not found
The 'dodgy' command-line executable, installed by pip, is not located in your system's PATH environment variable, or the pip installation directory for scripts is not in PATH.
fix
Ensure that the directory where pip installs scripts (e.g., `~/.local/bin` on Linux/macOS or `Scripts` folder within your Python installation on Windows) is added to your system's PATH. Alternatively, you can run it using `python -m dodgy` from your terminal.
ImportError: cannot import name 'X' from 'dodgy'
You are attempting to import a specific function, class, or submodule 'X' from the 'dodgy' package, but 'X' either does not exist, is not directly exposed at the top level of the package, or its name has changed. This can also occur if there's a circular import or naming conflict.
fix
Verify the exact name and path of the component you wish to import by consulting the library's source code or documentation (if available). For general use, simply `import dodgy` may be sufficient, or you may not need to import specific internal components for its command-line functionality.
AttributeError: module 'dodgy' has no attribute 'Y'
You have successfully imported the 'dodgy' module, but are attempting to call an attribute or function 'Y' that does not exist or is not publicly exposed on the module object.
fix
Review the available public API of the 'dodgy' module (e.g., by using `dir(dodgy)` after importing it, or by examining the source code) to ensure you are calling an existing and intended function or attribute. The library is primarily a command-line tool, so direct programmatic access to all internal functions may not be supported or documented.
Upgrade
Version history
0.2.1latest on PyPI · released Dec 31, 2019
Audit
Dependencies

No dependency data recorded yet.

Agent activity
9 hits · last 30 days
node
8
Resources
dodgy — pip install dodgy · libregistry