Skip to main content

Code-Guardian by TGSC

Project description

Code Guardian

Guard your code with swarms of agents

Join our Discord Subscribe on YouTube Connect on LinkedIn Follow on X.com

CodeGuardian is an intelligent agent designed to automate the generation of production-grade unit tests for your Python code. It not only creates and runs these tests but also monitors them in real-time, providing you with comprehensive summaries of your code health. With CodeGuardian, you can enhance code reliability, maintainability, and accelerate your development workflow.

Features

  • Automated Test Generation: Automatically generate unit tests for your existing Python codebase.
  • Test Execution: Run generated tests seamlessly and view results instantly.
  • Real-Time Monitoring: Watch tests in real-time to observe code behavior and performance.
  • Code Health Summaries: Receive detailed reports on test coverage, code quality, and potential issues.
  • Easy Integration: Integrate effortlessly with existing projects and CI/CD pipelines.
  • Customizable Configurations: Tailor settings to match your project requirements.

Prerequisites

  • Python 3.7 or higher
  • pip package manager

Installation

pip3 install -U code-guardian

Configuration Options

  • test_directory: Directory where tests are stored.
  • source_directory: Directory containing your source code.
  • exclude_patterns: Files or directories to exclude.
  • report_format: Format of the code health report (html, json, xml).
  • watch: Settings for real-time monitoring.

Roadmap

  • Multi-language Support: Extend functionality to other programming languages.
  • Advanced Static Analysis: Integrate deeper code analysis tools.
  • IDE Plugins: Develop plugins for popular IDEs like VSCode and PyCharm.
  • Enhanced Reporting: Add more detailed metrics and visualizations.

Contributing

We welcome contributions! Please see our Contributing Guidelines for details on how to get started.

License

CodeGuardian is licensed under the MIT License.

Acknowledgements

  • Inspired by the need for robust automated testing tools.
  • Thanks to the open-source community for their invaluable contributions.

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

code_guardian-0.0.1.tar.gz (3.4 kB view details)

Uploaded Source

Built Distribution

code_guardian-0.0.1-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

Details for the file code_guardian-0.0.1.tar.gz.

File metadata

  • Download URL: code_guardian-0.0.1.tar.gz
  • Upload date:
  • Size: 3.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Darwin/23.3.0

File hashes

Hashes for code_guardian-0.0.1.tar.gz
Algorithm Hash digest
SHA256 76f2993c3aea8d1edbfe5fa51a6dd782165dd7110dbfe7c539741c268672baee
MD5 db1e5250cc83121474441fc3c24e7b94
BLAKE2b-256 41737e0b0a17a37323cec8c54173c7c1cff3ba046e17cec4285293ba698be0f0

See more details on using hashes here.

File details

Details for the file code_guardian-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: code_guardian-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 3.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Darwin/23.3.0

File hashes

Hashes for code_guardian-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 550acbdaaaef1d2bebfd7f4856bede0e49fff14063d8cc5b9549b074a736e7ba
MD5 58161f1a73e49cac9a3ea4b531b6e9d8
BLAKE2b-256 907daca46f2f78dc3a50a36b897aba1c64a747d19dcc8d30e574d7709d2472af

See more details on using hashes here.

Supported by

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