Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,41 @@

# cmping changelog

## 0.16.1.dev0

(in development)

## 0.16.0

### Features

- Add timing statistics at the end of each run showing:
- Account setup time
- Group join time
- Message send/receive time
- Send and receive message rates (msg/s)

### Improvements

- Streamlined code with extracted helper functions:
- `print_progress()` for consistent progress display
- `format_duration()` for human-readable time formatting
- `wait_profiles_online()` for profile online waiting logic
- `SPINNER_CHARS` constant to avoid duplication

- Improved verbosity handling for receiver addresses:
- Normal mode: shows only receiver count in statistics
- `-v` mode: shows receiver count after joining
- `-vv` mode: shows full list of receiver addresses

- Added comprehensive documentation:
- Module-level docstring explaining 4-phase message flow
- Detailed docstrings for Pinger class and methods

### Bug Fixes

- Fixed `loss` property to return `0.0` instead of `1` when no messages expected

## 0.15.0

### Improvements
Expand Down
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,17 @@ Example output for two-domain ping:

3. edit cmping.py and test, finally commit your changes

4. set a new git-tag
4. update CHANGELOG.md with the new version number and changes

5. install build/release tools: `pip install build twine`

6. run the following command:
6. run the release script:

rm -rf dist && python -m build && twine upload -r pypi dist/cmping*
python release.py

The release script will:
- Validate the version in CHANGELOG.md is a proper version jump
- Create and push a git tag for the version
- Build the package and upload to PyPI
- Add a dev changelog entry and commit it
- Print which tag was uploaded to PyPI
Loading