Skip to content

Commit

Permalink
Release v2.0.0
Browse files Browse the repository at this point in the history
Update README.md and include release_notes.rst
  • Loading branch information
dormant-user committed Jan 5, 2025
1 parent 43e8979 commit e32b130
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 1 deletion.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,17 @@ pyudisk start
- **REPORT_DIR**: Directory to save disk reports. Default: `report`
- **REPORT_FILE**: Filename for disk reports. Default format: `disk_report_%m-%d-%Y_%I:%M_%p.html`

## [Release Notes][release-notes]
**Requirement**
```shell
python -m pip install gitverse
```

**Usage**
```shell
gitverse-release reverse -f release_notes.rst -t 'Release Notes'
```

## Linting
`pre-commit` will ensure linting

Expand Down Expand Up @@ -109,3 +120,4 @@ Licensed under the [MIT License][license]
[pypi]: https://pypi.org/project/PyUdisk
[pypi-files]: https://pypi.org/project/PyUdisk/#files
[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/
[release-notes]: https://github.com/thevickypedia/PyUdisk/blob/master/release_notes.rst
2 changes: 1 addition & 1 deletion pyudisk/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

from .main import generate_report, monitor, smart_metrics # noqa: F401

version = "1.1.0"
version = "2.0.0"


@click.command()
Expand Down
52 changes: 52 additions & 0 deletions release_notes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
Release Notes
=============

v2.0.0 (01/05/2025)
-------------------
- Includes windows compatibility
- Restructured project for `udiskctl` vs `smartctl`

v1.1.0 (01/03/2025)
-------------------
- Restructured model for both Linux and macOS
- Suppress unwanted errors and warnings for unmounted devices
- Remove dry_run functionality

v0.3.1 (01/02/2025)
-------------------
- Extend physical drive's stats retrieval before considering partitions

v0.3.0 (01/02/2025)
-------------------
- Retrieve physical drive's stats before considering partitions

v0.2.2 (01/02/2025)
-------------------
- Improve models for macOS metrics
- Includes compatibility for python3.10

v0.2.0 (12/31/2024)
-------------------
- Includes support for macOS machines

v0.1.1 (11/29/2024)
-------------------
- Includes bug fixes for missing `S.M.A.R.T` metrics
- Handles unmounted drives

v0.1.0 (11/27/2024)
-------------------
- Simplify requirements
- Install specific dependencies for standard and basic

v0.0.3 (11/26/2024)
-------------------
- Identifies udiskctl library as udisk_lib

v0.0.2 (11/25/2024)
-------------------
- Includes an option to return raw HTML data while generating report

v0.0.1 (11/24/2024)
-------------------
- Release `v0.0.1`

0 comments on commit e32b130

Please sign in to comment.