Open-Source Static Analysis for Privacy Data Flows
Project description
truscanner
Open-Source Static Analysis for Privacy Data Flows
truscanner is a static code analysis tool designed to discover data flows in your code. It helps developers and security teams identify where personal data is being processed and maps the journey of that data from collection to destination.
🚀 Why truscanner?
Understanding data lineage is critical for privacy and security. truscanner automates this by:
- Discovering PII: Automatically detecting personal data elements in source code.
- Mapping Flows: Visualizing how data moves to databases, logs, or third parties.
- Reporting: Generating audit-ready reports.
✨ Features
- Comprehensive Detection: Identifies more than 110 personal data elements (e.g., PII, financial data, device identifiers).
- Data Flow Mapping: Traces data from the point of collection to specific "sinks":
- ☁️ External Third Parties
- 🗄️ Databases
- 📝 Logs
- 🔗 Internal APIs
- Multi-Format Reporting: Produces actionable insights in Markdown and PDF.
📦 Installation
You can install truscanner easily using pip or uv.
Using pip
pip install truscanner
Using uv
uv pip install truscanner
🛠️ Usage
To scan a project, simply run the scan command pointing to your source code directory:
truscanner scan <path_to_directory>
Example
truscanner scan ./src
📊 Output
Upon completion, truscanner generates the following reports in your working directory:
- Markdown Report (
.md): Ideal for quick review and integration into version control. - PDF Report (
.pdf): A polished document suitable for sharing with compliance and security teams.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file truscanner-0.1.0.tar.gz.
File metadata
- Download URL: truscanner-0.1.0.tar.gz
- Upload date:
- Size: 9.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cb9389dfb5ffbc6c91e68f9ef7bbb081677ce04220b9636df81e6e07b7060a8f
|
|
| MD5 |
4d3c90a44a3b9aeb8237915a8d0cbbfb
|
|
| BLAKE2b-256 |
d0971ea7d8d4c71cfa13050ba47f3c9097af95c8274ed172a693c736b8609920
|
File details
Details for the file truscanner-0.1.0-py3-none-any.whl.
File metadata
- Download URL: truscanner-0.1.0-py3-none-any.whl
- Upload date:
- Size: 10.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
73e14fc30d8ddec3c9ca4e584b1fd608f5fc348cc59a9b8781058c572ce8fd89
|
|
| MD5 |
631514cfbba165773a6a1c58def4df30
|
|
| BLAKE2b-256 |
c5dd11a7f0f45a70438760ec7cb098c67808149a6337808e5ca13b17dce3838c
|