Skip to content

Commit 38a9537

Browse files
committed
chore: prepare for rebranding to pynnex
- Add deprecation warning in __init__.py - Update package metadata and URLs in pyproject.toml - Update version to 0.5.0 to indicate deprecation status - Point all repository links to new pynnex location This commit prepares the tsignal package for transition to pynnex. Users will receive deprecation warnings and be directed to the new repository when using the package.
1 parent 43e4ede commit 38a9537

File tree

4 files changed

+40
-12
lines changed

4 files changed

+40
-12
lines changed

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7+
## [0.5.0] - 2024-12-28
8+
9+
### Important Notice
10+
- **Package Deprecation**: TSignal is being rebranded to Pynnex. This version marks the beginning of the deprecation period.
11+
- All future development will continue at [github.com/nexconnectio/pynnex](https://github.com/nexconnectio/pynnex)
12+
- Users are encouraged to migrate to the new package: `pip install pynnex`
13+
14+
### Changed
15+
- Updated all repository URLs to point to the new Pynnex repository
16+
- Added deprecation warnings when importing the package
17+
- Updated package metadata to reflect deprecated status
18+
719
## [0.4.0] - 2024-12-21
820

921
### Added

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
# TSignal
1+
# TSignal (Deprecated - Moving to Pynnex)
2+
3+
> ⚠️ **Important Notice**: TSignal has been rebranded to Pynnex. This package is deprecated as of version 0.5.x, and all future development will take place at [Pynnex](https://github.com/nexconnectio/pynnex). Please use Pynnex for new projects.
4+
5+
```bash
6+
# New package installation:
7+
pip install pynnex
8+
```
29

310
TSignal is a lightweight, pure-Python signal/slot library that provides thread-safe, asyncio-compatible event handling inspired by the Qt signal/slot pattern—but without the heavyweight Qt dependencies. It enables clean decoupling of components, seamless thread-to-thread communication, and flexible asynchronous/synchronous slot handling.
411

@@ -44,9 +51,11 @@ Modern Python applications often rely on asynchronous operations and multi-threa
4451

4552
TSignal requires Python 3.10 or higher.
4653

54+
> ⚠️ **Note**: For new installations, please use `pip install pynnex` instead.
55+
4756
```bash
48-
git clone https://github.com/TSignalDev/tsignal-python.git
49-
cd tsignal-python
57+
git clone https://github.com/nexconnectio/pynnex.git
58+
cd pynnex
5059
pip install -e .
5160
```
5261

pyproject.toml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "tsignal"
7-
version = "0.4.4"
8-
description = "A Python Signal-Slot library inspired by Qt"
7+
version = "0.5.0"
8+
description = "A Python Signal-Slot library inspired by Qt (Deprecated - Use pynnex instead)"
99
readme = "README.md"
1010
requires-python = ">=3.10"
1111
license = {text = "MIT"}
@@ -25,10 +25,10 @@ classifiers = [
2525
]
2626

2727
[project.urls]
28-
Homepage = "https://github.com/TSignalDev/tsignal-python"
29-
Repository = "https://github.com/TSignalDev/tsignal-python"
30-
Documentation = "https://github.com/TSignalDev/tsignal-python#readme"
31-
Issues = "https://github.com/TSignalDev/tsignal-python/issues"
28+
Homepage = "https://github.com/nexconnectio/pynnex"
29+
Repository = "https://github.com/nexconnectio/pynnex"
30+
Documentation = "https://github.com/nexconnectio/pynnex#readme"
31+
Issues = "https://github.com/nexconnectio/pynnex/issues"
3232

3333
[project.optional-dependencies]
3434
dev = [

src/tsignal/__init__.py

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
1-
# pylint: disable=missing-module-docstring
1+
import warnings
22

33
"""
4-
TSignal - Python Signal/Slot Implementation
4+
TSignal - Python Signal/Slot Implementation (Deprecated - Use pynnex instead)
55
"""
66

7+
warnings.warn(
8+
"The tsignal package is deprecated as of version 0.5.x. "
9+
"Please use the pynnex package instead. "
10+
"For more information, visit https://github.com/nexconnectio/pynnex",
11+
DeprecationWarning,
12+
)
13+
714
from .core import (
815
t_with_signals,
916
t_signal,
@@ -15,7 +22,7 @@
1522
from .utils import t_signal_log_and_raise_error
1623
from .contrib.patterns.worker.decorators import t_with_worker
1724

18-
__version__ = "0.1.0"
25+
__version__ = "0.5.0"
1926

2027
__all__ = [
2128
"t_with_signals",

0 commit comments

Comments
 (0)