Skip to content

Commit adc6754

Browse files
committed
V6.0.2
1 parent 7cb507b commit adc6754

4 files changed

Lines changed: 45 additions & 189 deletions

File tree

.github/workflows/workflow.yml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
name: CI/CD Pipeline
22

33
'on':
4+
pull_request:
45
push:
5-
branches: ['**']
66
tags: ['v*']
77

88
env:
@@ -35,6 +35,8 @@ jobs:
3535

3636
- name: Install uv
3737
uses: astral-sh/setup-uv@v7
38+
with:
39+
enable-cache: true
3840

3941
- name: Set up Python ${{ matrix.python-version }}
4042
run: uv python install ${{ matrix.python-version }}
@@ -71,13 +73,21 @@ jobs:
7173

7274
- name: Install uv
7375
uses: astral-sh/setup-uv@v7
76+
with:
77+
enable-cache: true
7478

7579
- name: Set up Python ${{ env.LATEST_PYTHON_VERSION }}
7680
run: uv python install ${{ env.LATEST_PYTHON_VERSION }}
7781

7882
- name: Build package
7983
run: uv build
8084

85+
- name: Smoke test (wheel)
86+
run: uv run --isolated --no-project --with dist/*.whl tests/smoke_test.py
87+
88+
- name: Smoke test (sdist)
89+
run: uv run --isolated --no-project --with dist/*.tar.gz tests/smoke_test.py
90+
8191
- name: Upload artifacts
8292
uses: actions/upload-artifact@v6
8393
with:

README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,9 @@
4141
- [Settings Cache Management](#settings-cache-management)
4242
- [Flexible Configuration Options](#flexible-configuration-options)
4343
- [Development](#development)
44-
- [Create DEV Environment, Running Tests and Building Wheel](#create-dev-environment-running-tests-and-building-wheel)
44+
- [Create DEV Environment and Running Tests](#create-dev-environment-and-running-tests)
45+
- [Update DEV Environment Packages](#update-dev-environment-packages)
46+
- [Building Wheel](#building-wheel)
4547
- [Optionals](#optionals)
4648
- [License](#license)
4749
- [Support](#support)
@@ -349,20 +351,34 @@ RotateWhen.MONDAY # "W0"
349351

350352
# Development
351353

352-
Must have [UV](https://uv.run/docs/getting-started/installation),
353-
[Black](https://black.readthedocs.io/en/stable/getting_started.html),
354-
[Ruff](https://docs.astral.sh/ruff/installation/), and
355-
[Poe the Poet](https://poethepoet.naber.dev/installation) installed.
354+
Must have [UV](https://uv.run/docs/getting-started/installation) installed.
356355

357-
## Create DEV Environment, Running Tests and Building Wheel
356+
## Create DEV Environment and Running Tests
357+
358+
> **Note:** All poe tasks automatically run ruff linter along with Black formatting
358359
359360
```shell
360-
uv sync --all-extras
361-
poe linter
361+
uv sync --all-extras --all-groups
362362
poe test
363+
```
364+
365+
366+
## Update DEV Environment Packages
367+
This will update all packages dependencies
368+
369+
```shell
370+
poe updatedev
371+
```
372+
373+
374+
## Building Wheel
375+
This will update all packages, run linter, both unit and integration tests and finally build the wheel
376+
377+
```shell
363378
poe build
364379
```
365380

381+
366382
## Optionals
367383

368384
### Create a cprofile.prof file from unit tests

tests/README.md

Lines changed: 0 additions & 180 deletions
This file was deleted.

tests/smoke_test.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
"""Smoke test to verify the built package works correctly."""
2+
3+
from pythonLogs import BasicLog, SizeRotatingLog, TimedRotatingLog, __version__
4+
5+
assert __version__, "Version should not be empty"
6+
assert BasicLog, "BasicLog should be importable"
7+
assert TimedRotatingLog, "TimedRotatingLog should be importable"
8+
assert SizeRotatingLog, "SizeRotatingLog should be importable"
9+
10+
print(f"pythonLogs {__version__} OK")

0 commit comments

Comments
 (0)