system-report 1.0.0

A Python package to generate and save system reports.

System Report

System Report is a Python package designed to generate and save a detailed system report, including information about the operating system, CPU, memory, and disk usage.

Features

• Collect system information, such as OS version, hostname, CPU, memory, and disk details.
• Format values in a human-readable way (e.g., GB, MB).
• Save the system report as a JSON file.
• Easily extensible and includes unit tests.

Installation

You can install the package locally:

pip install .

Usage

To generate and save a system report, run the following command:

python -m system_report

This will create a system_report.json file in the current working directory.

Running Tests

The package includes unit tests written with pytest. To execute the tests and generate a report in JUnit XML format, follow these steps:

1. Install the required dependencies:

   pip install pytest
   

2. Run the tests and generate the report:

   python -m pytest --junitxml=report.xml
   

This will run all tests and save the test results in a file named report.xml.

Publishing the Package to PyPI

To publish the package to PyPI, follow these steps:

1. Ensure you have the required tools installed:

   pip install twine setuptools wheel
   

2. Build the package:

   python setup.py sdist bdist_wheel
   

3. Upload the package to PyPI:

   twine upload dist/*
   

You will be prompted to enter your PyPI username and password.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Author

John Doe