Skip to content

Commit 83e58bc

Browse files
authored
release v0.2.11 to warn about future rename to hetnetpy
Merges #41 Refs #40
1 parent f8aab19 commit 83e58bc

File tree

4 files changed

+43
-1
lines changed

4 files changed

+43
-1
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@
44
[![GitHub issues](https://img.shields.io/github/issues/hetio/hetio.svg)](https://github.com/hetio/hetio/issues)
55
[![Build Status](https://travis-ci.com/hetio/hetio.svg?branch=master)](https://travis-ci.com/hetio/hetio)
66

7+
## Package relocation
8+
9+
**Critical**:
10+
This is the final release before the package name [changes](https://github.com/hetio/hetio/issues/40) to `hetnetpy` from `hetio`.
11+
Future development will occur in the `hetio/hetnetpy` [repository](https://github.com/hetio/hetnetpy).
12+
PyPI releases will be available at <https://pypi.org/project/hetnetpy/>.
13+
14+
Users of v0.2.11 will see a warning when importing `hetio`.
15+
These users should either switch to using `hetnetpy` or downgrade to `hetio<=0.2.10` to avoid the warning.
16+
717
## Background
818

919
**Hetnets**: Hetnets, also [called](https://doi.org/10.15363/thinklab.d104) *heterogeneous information networks*, are graphs with multiple node and edge types. Hetnets are both multipartite and multirelational. They provide a scalable, intuitive, and frictionless structure for data integration.

hetio/__init__.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
1-
__version__ = '0.2.10'
1+
import warnings
2+
3+
__version__ = "0.2.11"
4+
5+
message = '''
6+
PACKAGE HAS BEEN RELOCATED:
7+
v0.2.11 is the last release before the hetio package is renamed to hetnetpy.
8+
Consider switching to the hetnetpy package or specifying hetio<=0.2.10 to silence this warning.
9+
Future releases and development will only occur for the hetnetpy package.
10+
'''
11+
warnings.warn(message, FutureWarning)

release-notes/v0.2.11.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
hetio/hetio v0.2.11
2+
===================
3+
4+
Final release before this package is renamed to hetnetpy from hetio.
5+
See <https://github.com/hetio/hetio/issues/40> for more information on the renaming.
6+
`import hetio` will raise a DeprecationWarning.
7+
Users are recommended to switch to hetnetpy or downgrade to v0.2.10 to avoid the warning.
8+
9+
There are no functional changes in this release.

test/relocation_test.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import importlib
2+
3+
import pytest
4+
5+
6+
def test_relocation_warning():
7+
"""
8+
https://github.com/hetio/hetio/issues/40
9+
"""
10+
with pytest.warns(FutureWarning, match='PACKAGE HAS BEEN RELOCATED'):
11+
import hetio
12+
# Reload module to ensure warning tiggers
13+
importlib.reload(hetio)

0 commit comments

Comments
 (0)