| Name | system-report JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | A Python package to generate and save system reports. |
| upload_time | 2025-01-14 10:40:06 |
| maintainer | None |
| docs_url | None |
| author | John Doe |
| requires_python | >=3.6 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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:
```bash
pip install .
```
## Usage
To generate and save a system report, run the following command:
```bash
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:
```bash
pip install pytest
```
2. Run the tests and generate the report:
```bash
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:
```bash
pip install twine setuptools wheel
```
2. Build the package:
```bash
python setup.py sdist bdist_wheel
```
3. Upload the package to PyPI:
```bash
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](mailto:john.doe@admsys.com)
Raw data
{
"_id": null,
"home_page": null,
"name": "system-report",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "John Doe",
"author_email": "john.doe@admsys.com",
"download_url": "https://files.pythonhosted.org/packages/9d/d3/31ada36d3b1a47030437a810d7b28028ca68136c222aa2c58ce13aab1482/system_report-1.0.0.tar.gz",
"platform": null,
"description": "# System Report\n\nSystem 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.\n\n## Features\n- Collect system information, such as OS version, hostname, CPU, memory, and disk details.\n- Format values in a human-readable way (e.g., GB, MB).\n- Save the system report as a JSON file.\n- Easily extensible and includes unit tests.\n\n## Installation\n\nYou can install the package locally:\n\n```bash\npip install .\n```\n\n## Usage\n\nTo generate and save a system report, run the following command:\n\n```bash\npython -m system_report\n```\n\nThis will create a `system_report.json` file in the current working directory.\n\n## Running Tests\n\nThe package includes unit tests written with `pytest`. To execute the tests and generate a report in JUnit XML format, follow these steps:\n\n1. Install the required dependencies:\n\n ```bash\n pip install pytest\n ```\n\n2. Run the tests and generate the report:\n\n ```bash\n python -m pytest --junitxml=report.xml\n ```\n\nThis will run all tests and save the test results in a file named `report.xml`.\n\n## Publishing the Package to PyPI\n\nTo publish the package to PyPI, follow these steps:\n\n1. Ensure you have the required tools installed:\n\n ```bash\n pip install twine setuptools wheel\n ```\n\n2. Build the package:\n\n ```bash\n python setup.py sdist bdist_wheel\n ```\n\n3. Upload the package to PyPI:\n\n ```bash\n twine upload dist/*\n ```\n\nYou will be prompted to enter your PyPI username and password.\n\n## Contributing\n\nContributions are welcome! Please fork the repository and submit a pull request.\n\n## License\n\nThis project is licensed under the MIT License. See the LICENSE file for details.\n\n## Author\n\n[John Doe](mailto:john.doe@admsys.com)\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python package to generate and save system reports.",
"version": "1.0.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "250d8b7aeb050f235ae4eb9e3cbb1853a0302683fb19ff7633a92715b9b91326",
"md5": "37f9266de907180dadd8018a1a4bb665",
"sha256": "c7a0ff5160cb61064652bb11ffda4babcca0c711d22a1eb6239201a9eb087590"
},
"downloads": -1,
"filename": "system_report-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "37f9266de907180dadd8018a1a4bb665",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 2266,
"upload_time": "2025-01-14T10:40:05",
"upload_time_iso_8601": "2025-01-14T10:40:05.077532Z",
"url": "https://files.pythonhosted.org/packages/25/0d/8b7aeb050f235ae4eb9e3cbb1853a0302683fb19ff7633a92715b9b91326/system_report-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9dd331ada36d3b1a47030437a810d7b28028ca68136c222aa2c58ce13aab1482",
"md5": "fa426b1c02d5e93a3c356ba0b2eb6a41",
"sha256": "3bc9c8a11589c15303218d3d1cce934ca27f9c0b84a51ab7a8414c9c32ad9659"
},
"downloads": -1,
"filename": "system_report-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "fa426b1c02d5e93a3c356ba0b2eb6a41",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 2113,
"upload_time": "2025-01-14T10:40:06",
"upload_time_iso_8601": "2025-01-14T10:40:06.769086Z",
"url": "https://files.pythonhosted.org/packages/9d/d3/31ada36d3b1a47030437a810d7b28028ca68136c222aa2c58ce13aab1482/system_report-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-14 10:40:06",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "system-report"
}
