PyThreadKiller

A utility to manage and kill threads in Python applications.

Overview

PyThreadKiller is a utility designed to manage and kill threads in Python applications. This package provides a simple and effective way to terminate threads safely and retrieve return values from target functions.

Directory Structure

PyThreadKiller/
    ├── PyThreadKiller/
    │   ├── __init__.py
    │   ├── main.py
    ├── tests/
    │   ├── TestPyThreadKiller.py
    │   ├── UnittestPyThreadKiller.py
    ├── CHANGELOG.md
    ├── README.md
    ├── .github/
    │   └── workflows/
    │       └── python-app.yml
    └── setup.py

Installation

You can install the package using pip:

pip install PyThreadKiller

Usage

• Here is an example of how to use PyThreadKiller:

import time
from PyThreadKiller import PyThreadKiller

def example_target():
    for i in range(5):
        print(f"Thread is running... {i}")
        time.sleep(1)
    return True

# Create an instance of PyThreadKiller
thread = PyThreadKiller(target=example_target)
thread.start()

# Allow the thread to run for 3 seconds
time.sleep(3)

# Kill the thread
result = thread.kill()
print(f"Return value after killing the thread: {result}")

# Output:
# Thread is running... 0
# Thread is running... 1
# Thread is running... 2
# Thread killed successfully
# Return value after killing the thread: None

This file: tests/UnittestPyThreadKiller.py is integral to our CI/CD pipeline for automated testing.

License:

• This project is licensed under the MIT License - see the LICENSE file for details.

• This updated README.md includes the new project name, badges, a brief overview, the directory structure, installation instructions, usage example, changelog, and the main code for the PyThreadKiller class. Make sure to adjust any URLs and links to point to the correct resources for your project.

Changelog

[0.1] - 2024-05-19

Added

• Initial draft of PyThreadKiller with basic thread management and killing functionality.

[3.0.4] - 2024-07-20

Fix

• Test file for PyThreadKiller to test the package itself.

[3.0.6] - 2024-08-04

Documentation and CI/CD

• Documentation update and CI/CD pipeline for automated testing

[3.0.7] - 2025-12-21

Maintenance

• Removed unused requests dependency from the project.
• Cleaned up packaging metadata to reflect zero runtime dependencies.
• Ensured setup.py and CI configuration install the package directly.
• Minor project hygiene improvements (no functional code changes).

[3.0.8] - 2025-12-21

Added / Fixed

• Prepare package for next release.
• Ensure MANIFEST.in includes correct files.
• Update version to 3.0.8 for publishing.