RomanNum3ral
/
Cybersecurity-Projects
mirror of https://github.com/CarterPerez-dev/Cybersecurity-Projects.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Revise README with project details and badges 

Updated README to include badges, project description, and installation instructions.
This commit is contained in:
Carter Perez 2026-01-29 00:18:51 -05:00 committed by GitHub
parent a6921c9672
commit d6978c4bd3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 30 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
PROJECTS/simple-vulnerability-scanner/README.md
View File

@ -1,9 +1,28 @@
# angela
[![Cybersecurity Projects](https://img.shields.io/badge/Cybersecurity--Projects-Project%20%2311-red?style=flat&logo=github)](https://github.com/CarterPerez-dev/Cybersecurity-Projects/tree/main/PROJECTS/simple-vulnerability-scanner)
A fast Python dependency updater and vulnerability scanner, written in Go.
```ruby
█ ▀██
███ ▄▄ ▄▄▄ ▄▄▄ ▄ ▄▄▄▄ ██ ▄▄▄▄
█ ██ ██ ██ ██ ██ ▄█▄▄▄██ ██ ▀▀ ▄██
▄▀▀▀▀█▄ ██ ██ █▀▀ ██ ██ ▄█▀ ██
▄█▄ ▄██▄ ▄██▄ ██▄ ▀████▄ ▀█▄▄▄▀ ▄██▄ ▀█▄▄▀█▀
▄█▄▄▄▄▀
```
### *[Go Docs](https://pkg.go.dev/github.com/CarterPerez-dev/angela)*
[![Go Version](https://img.shields.io/badge/Go-1.24+-00ADD8?style=flat&logo=go)](https://go.dev)
[![License: AGPLv3](https://img.shields.io/badge/License-AGPL_v3-purple.svg)](https://www.gnu.org/licenses/agpl-3.0)
[![Go Report Card](https://goreportcard.com/badge/github.com/CarterPerez-dev/angela)](https://goreportcard.com/report/github.com/CarterPerez-dev/angela)
[![PyPI Compatible](https://img.shields.io/badge/PyPI-compatible-3775A9?style=flat&logo=pypi&logoColor=white)](https://pypi.org)
[![OSV.dev](https://img.shields.io/badge/OSV.dev-integrated-4285F4?style=flat)](https://osv.dev)
A fast Python dependency updater and vulnerability scanner, written in Go ❤️
angela scans your `pyproject.toml` or `requirements.txt`, updates all dependencies to their latest stable versions, and checks for known CVEs using [OSV.dev](https://osv.dev) — in a single command.
<img width="660" height="558" alt="Screenshot_20260128_235646" src="https://github.com/user-attachments/assets/3f096ab9-9dae-4624-a57b-3ab9ab2ee663" />
## Highlights
- **One command updates everything** in `pyproject.toml` or `requirements.txt`, like `pnpm update` for Python.
@ -14,6 +33,14 @@ angela scans your `pyproject.toml` or `requirements.txt`, updates all dependenci
- Configurable via `.angela.toml` or `[tool.angela]` in `pyproject.toml`.
- Single binary with zero runtime dependencies.
## Demo Video
[![Angela Demo](https://img.youtube.com/vi/d9LfxGxk9H0/maxresdefault.jpg)](https://youtu.be/d9LfxGxk9H0)
> *Click to watch: Initialize a project, scan for vulnerabilities, and update dependencies in minutes.*
## Installation
```bash
@ -287,12 +314,6 @@ just ci # Lint + test in one step
just run check # Run angela check via go run
```
## Part of Cybersecurity-Projects
This tool is project #1 in [Cybersecurity-Projects](https://github.com/CarterPerez-dev/Cybersecurity-Projects) — a collection of 60 security-focused projects built for learning and reference.
The code is written to be educational: clear structure, proper error handling, and thorough testing. See the [`learn/`](learn/) directory for deep dives into the techniques used.
## License
MIT
AGPL 3.0