Skip to main content

System audit and self-healing CLI tool

Project description

SysGuard

SysGuard is a small Python command-line tool for basic system auditing (and, later, “self-healing” actions).

Right now, the project is a working CLI skeleton with an audit subcommand that prints a placeholder message. It’s ready to be extended with real checks.

Requirements

  • Python 3.9+ (3.10+ recommended)
  • Dependencies: psutil

Install

  1. Create and activate a virtual environment (recommended):

Windows (PowerShell):

python -m venv .venv
.\.venv\Scripts\Activate.ps1

Windows (cmd):

python -m venv .venv
.\.venv\Scripts\activate.bat
  1. Install dependencies:
pip install -r requirements.txt

Usage

Show help:

python sysguard.py --help

Run the (placeholder) audit command:

python sysguard.py audit

Expected output (currently):

Running system audit...

Project layout

  • sysguard.py: CLI entry point (argument parsing + command routing)
  • requirements.txt: runtime dependency list

Extending SysGuard

SysGuard uses argparse subcommands. To add a new command:

  1. Add another parser via subparsers.add_parser("<command>")
  2. Check args.command and run your code for that command

Example ideas for an audit implementation using psutil:

  • CPU usage and load
  • Memory usage and swap
  • Disk usage per partition
  • Top processes by CPU/RAM

Development

  • Run from source: python sysguard.py audit
  • Keep changes small and test from the command line after edits.

License

No license file is included yet. If you plan to publish this project, add a LICENSE file (for example: MIT, Apache-2.0, GPL-3.0).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sysguard-0.1.0.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sysguard-0.1.0-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

Details for the file sysguard-0.1.0.tar.gz.

File metadata

  • Download URL: sysguard-0.1.0.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for sysguard-0.1.0.tar.gz
Algorithm Hash digest
SHA256 bbacc2a68231c6a48cf657df9fdae9855c0ee1ea08085718cb376bd82d3d14aa
MD5 e351d3210ee57a0901fae1ba84001ddc
BLAKE2b-256 fc5e59cbced5e4d5c1465080e3ea525ee5d73e4e74e15e9e8288aeb0900f08e5

See more details on using hashes here.

File details

Details for the file sysguard-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: sysguard-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for sysguard-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eb7f75943dd224c80cbb6fd80f7538f1efa703682d393ab8b347747e6d5c736c
MD5 f78ee2b4abe3fde1938707ec46e8e9d2
BLAKE2b-256 c1824a329e34841f8f604743a24bb11c3e2253e278f66447851ab85eb506c352

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page