Skip to content

Commit

Permalink
docs(README): add missing ticks and update link to notebook
Browse files Browse the repository at this point in the history
  • Loading branch information
ninopleno committed Dec 15, 2023
1 parent 581de90 commit 65b3303
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 7 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<img src="https://img.shields.io/badge/docs-passing-brightgreen.svg" alt="Documentation">
</a>
<a href="https://pypi.org/project/anomalytics/">
<img src="https://img.shields.io/badge/PyPi-v0.1.9-blue.svg" alt="PyPi">
<img src="https://img.shields.io/badge/PyPi-v0.2.1-blue.svg" alt="PyPi">
</a>
</p>

Expand Down Expand Up @@ -151,7 +151,6 @@ Read the walkthrough below, or the concrete examples here:
pot_detector.exeedance_thresholds.head()
```
```shell

xandr gam adobe datetime
0 58.224653 85.177029 60.362306 2023-10-18 09:01:00
1 58.224653 85.177029 60.362306 2023-10-18 09:02:00
Expand Down Expand Up @@ -252,7 +251,6 @@ Read the walkthrough below, or the concrete examples here:
Name: detected data, Length: 6570, dtype: bool
```


10. Now we can visualize the anomaly scores from the fitting with the anomaly threshold to get the sense of the extremely large values:

```python
Expand Down Expand Up @@ -340,6 +338,7 @@ You have a project that only needs to be fitted? To be detected? Don't worry! `a
print(f"T1: {t1}")
print(f"T2: {t2}")
```
```shell
T0: 65001
T1: 25001
T2: 10000
Expand Down Expand Up @@ -549,6 +548,9 @@ We have anomaly you said? Don't worry, `anomalytics` has the implementation to s
# Slack
slack.send
```
```shell
'Notification sent successfully.'
```

3. Check your email or slack, this example produces the following notification via Slack:

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
name = "anomalytics"
description = "The ultimate anomaly detection library."
readme = "README.md"
version = "0.2.0"
version = "0.2.1"
license = {file = "LICENSE"}
requires-python = ">=3.10"
authors = [
Expand Down
2 changes: 1 addition & 1 deletion src/anomalytics/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = "0.2.0"
__version__ = "0.2.1"

__all__ = [
"get_anomaly",
Expand Down
2 changes: 1 addition & 1 deletion src/anomalytics/notifications/email.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ def send(self):
server.login(user=self.sender_address, password=self.password)
server.send_message(msg=msg, from_addr=self.sender_address, to_addrs=self.recipient_addresses)
server.quit()
print("Email sent successfully.")
print("Notification sent successfully.")
except Exception as e:
print(f"Failed to send email. Error: {e}")

Expand Down
2 changes: 1 addition & 1 deletion tests/test_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@


def test_pkg_version():
assert __version__ == "0.2.0"
assert __version__ == "0.2.1"

0 comments on commit 65b3303

Please sign in to comment.