Skip to content

Commit 9e6d238

Browse files
committed
Going for an initial release
1 parent 0e7ede3 commit 9e6d238

6 files changed

Lines changed: 45 additions & 41 deletions

File tree

dearlog/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ def simple(e: LogEntry) -> Iterable[str]:
115115
yield from e.message
116116

117117
def stopwatch(e: LogEntry) -> Iterable[str]:
118-
yield f"│{e.minsec}├"
118+
yield f"│[green]{e.minsec}[/]├"
119119
yield f"┤[{e.level.color} bold]{e.level.name:5}[/]│"
120120
yield " "
121121
yield from e.message

pyproject.toml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
[project.urls]
2-
GitHub = "https://github.com/BrokenSource/DearLog"
3-
41
[project]
52
name = "dearlog"
63
description = "🪵 A Human Logging Library"

readme.md

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,23 @@
66
<br>
77
<a href="https://pypi.org/project/dearlog/"><img src="https://img.shields.io/pypi/v/dearlog?label=PyPI&color=blue"></a>
88
<a href="https://pypi.org/project/dearlog/"><img src="https://img.shields.io/pypi/dw/dearlog?label=%E2%86%93&color=blue"></a>
9-
<a href="https://github.com/BrokenSource/DearLog/"><img src="https://img.shields.io/github/v/tag/BrokenSource/Dearlog?label=GitHub&color=orange"></a>
10-
<a href="https://github.com/BrokenSource/DearLog/stargazers/"><img src="https://img.shields.io/github/stars/BrokenSource/Dearlog?label=Stars&style=flat&color=orange"></a>
9+
<a href="https://github.com/BrokenSource/DearLog/"><img src="https://img.shields.io/github/v/tag/BrokenSource/DearLog?label=GitHub&color=orange"></a>
10+
<a href="https://github.com/BrokenSource/DearLog/stargazers/"><img src="https://img.shields.io/github/stars/BrokenSource/DearLog?label=Stars&style=flat&color=orange"></a>
1111
<a href="https://discord.gg/KjqvcYwRHm"><img src="https://img.shields.io/discord/1184696441298485370?label=Discord&style=flat&color=purple"></a>
1212
<br>
13+
<b>
14+
Links •
15+
<a href="https://github.com/BrokenSource/DearLog">GitHub</a> •
16+
<a href="https://dearlog.brokensrc.dev/">Documentation</a> •
17+
<a href="https://dearlog.brokensrc.dev/about/changelog">Changelog</a>
18+
</b>
19+
<br>
20+
<sub><small>⭐️ Consider starring the project to help it grow! ⭐️</small></sub>
1321
<br>
1422
</div>
1523

16-
A simple, pretty and human-first logging library for Python.
17-
18-
## Goals
19-
20-
- **Sane defaults**: Sensible logging formats and levels out of the box
21-
22-
- **User-first** experience and quality of life features:
23-
- Logging multiple lines.. enqueues multiple logs!
24-
- All methods return the message for inlining
25-
26-
- **Levels**: Standard logging levels, plus quality of life ones:
27-
- `Level.OK`: For expected or successful operations
28-
- `Level.MINOR`: Disabled or ignored issues, features
29-
- `Level.SKIP`: For skipped operations, tests
30-
- `Level.FIXME`: May need manual workarounds
31-
- `Level.TODO`: For planned work or improvements
32-
- `Level.TIP`: Helpful hints or suggestions
24+
<!-- Todo: Asciinema demo -->
3325

34-
- **Simple** handlers, formatters, configurations and filters
26+
## 🔥 Description
3527

36-
- **Fast** import times, lazy loading where possible
28+
A simple, pretty and human-first logging library.

website/about/changelog.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,20 @@ icon: material/file-document-edit
55

66
<style>ul li {line-height: 1.1}</style>
77

8-
<!-- ### 📦 v0.1.0 <small>Month ??, 2026</small> {#v0.1.0} -->
9-
108
### ✏️ Staging {#staging}
119

10+
### 📦 v0.1.0 <small>February 21, 2026</small> {#v0.1.0}
11+
12+
First release 🚀
13+
1214
!!! success ""
13-
Initial implementation, basic functionality
15+
**Additions**
16+
17+
- Basic functionality working
18+
- Stdout and file handlers
19+
- Many logging levels
20+
21+
**Limitations**
22+
23+
- Missing level filtering from environment
24+
- Missing compat/integration with stdlib

website/docs/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,9 @@ logger.ok("✔ Quickstart complete!")
2626
Oh, and [`rich`](https://pypi.org/project/rich/) formatting is enabled by default
2727

2828
```python
29-
logger.minor("[bold red]Consider [link=https://github.com/sponsors/Tremeschin/]Supporting[/link][/] me on GitHub!")
29+
logger.minor((
30+
"[bold red]Consider "
31+
"[link=https://github.com/sponsors/Tremeschin/]Supporting[/link][/] "
32+
"me on GitHub!"
33+
))
3034
```

zensical.toml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,25 +26,17 @@ variant = "modern"
2626
favicon = "assets/images/logo.png"
2727
language = "en"
2828
features = [
29-
# Code block features
3029
"content.code.copy",
31-
32-
# Footnote preview
3330
"content.footnote.tooltips",
34-
"content.tooltips",
35-
36-
# Switch all tabs with the same name at once
3731
"content.tabs.link",
38-
39-
# Others
40-
"navigation.indexes",
32+
"content.tooltips",
4133
"navigation.expand",
42-
# "navigation.sections",
4334
"navigation.footer",
44-
"navigation.path",
45-
"navigation.instant",
35+
"navigation.indexes",
4636
"navigation.instant.prefetch",
4737
"navigation.instant.progress",
38+
"navigation.instant",
39+
"navigation.path",
4840
"navigation.tabs",
4941
"navigation.top",
5042
"search.highlight",
@@ -70,3 +62,11 @@ media = "(prefers-color-scheme: dark)"
7062
scheme = "slate"
7163
primary = "orange"
7264
accent = "orange"
65+
66+
[[project.extra.social]]
67+
icon = "fontawesome/brands/github"
68+
link = "https://github.com/Tremeschin"
69+
70+
[[project.extra.social]]
71+
icon = "fontawesome/brands/discord"
72+
link = "https://discord.gg/KjqvcYwRHm"

0 commit comments

Comments
 (0)