Skip to content

Commit 8b78184

Browse files
committed
Update files structure to share as library
1 parent 9ba2015 commit 8b78184

9 files changed

+23
-16
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ $ sudo bluetoothctl
2020
$ sudo rfcomm connect /dev/rfcomm0 <MAC>
2121
```
2222

23-
### Application initialisation
23+
### Demo application usage
2424

2525
```
2626
$ poetry install --no-dev
27-
$ poetry run task app -p /dev/rfcomm0
27+
$ poetry run task demo -p /dev/rfcomm0
2828
```

src/__init__.py demo/__init__.py

File renamed without changes.

src/main.py demo/main.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
from datetime import datetime
44
from time import sleep
55
from typing import Optional
6-
from src.export_csv import ExportCSV
7-
from src.ummeter import UMmeter
6+
from pyummeter import UMmeter
7+
from pyummeter.export_csv import ExportCSV
88

99

1010
def parse_args():

pyproject.toml

+8-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,14 @@
22
name = "pyummeter"
33
version = "0.1.0"
44
description = "Python UM-Meter interface"
5+
keywords = ["ummeter"]
56
authors = ["William Vallet <[email protected]>"]
67
license = "MIT"
8+
repository = "https://github.com/valletw/pyummeter"
9+
readme = "README.md"
10+
packages = [
11+
{ include = "pyummeter" }
12+
]
713

814
[tool.poetry.dependencies]
915
python = "^3.8"
@@ -23,7 +29,7 @@ requires = ["poetry-core>=1.0.0"]
2329
build-backend = "poetry.core.masonry.api"
2430

2531
[tool.taskipy.tasks]
26-
app = "python -m src.main"
27-
test = "pytest --cov=src -v --junit-xml=test_results.xml"
32+
demo = "python -m demo.main"
33+
test = "pytest --cov=pyummeter -v --junit-xml=test_results.xml"
2834
lint_full = "pytest --flake8 --mypy --pylint --lint-only -v --junit-xml=analysis_results.xml"
2935
lint = "task lint_full --pylint-error-types=EF"

pyummeter/__init__.py

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
from pyummeter.ummeter import UMmeter, UMmeterData, UMmeterDataGroup

src/export_csv.py pyummeter/export_csv.py

+7-7
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,28 @@
22
import csv
33
from datetime import datetime, timedelta
44
from typing import Callable, Optional
5-
from src.ummeter import UMmeterData
5+
from pyummeter import UMmeterData
66

77

8-
def bool_to_str(value: bool) -> str:
8+
def _bool_to_str(value: bool) -> str:
99
""" Convert bool to string """
1010
return str(int(value))
1111

1212

13-
def datetime_to_str(value: datetime) -> str:
13+
def _datetime_to_str(value: datetime) -> str:
1414
""" Convert date to string (ISO format) """
1515
return value.isoformat(sep=" ")
1616

1717

18-
def timedelta_to_str(value: timedelta) -> str:
18+
def _timedelta_to_str(value: timedelta) -> str:
1919
""" Convert time delta to string (elapsing seconds) """
2020
return str(int(value.total_seconds()))
2121

2222

2323
class ExportCSV:
2424
""" CSV export instance """
2525
_SEP = ";"
26-
_FIELD_DATE = ("", "Date", datetime_to_str)
26+
_FIELD_DATE = ("", "Date", _datetime_to_str)
2727
_FIELDS = [
2828
# UM-Meter field, Description, Conversion method.
2929
("voltage", "Voltage (V)", None),
@@ -35,8 +35,8 @@ class ExportCSV:
3535
("charging_mode", "Charging Mode", None),
3636
("temperature_celsius", "Temperature (°C)", None),
3737
("model", "Model", None),
38-
("record_enabled", "Recording", bool_to_str),
39-
("record_duration", "Record duration (sec)", timedelta_to_str),
38+
("record_enabled", "Recording", _bool_to_str),
39+
("record_duration", "Record duration (sec)", _timedelta_to_str),
4040
("record_intensity_threshold", "Record intensity (A)", None),
4141
("record_capacity_threshold", "Record capacity (Ah)", None),
4242
("record_energy_threshold", "Record energy (Wh)", None),
File renamed without changes.

tests/test_export_csv.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import pytest
22
import unittest
33
from datetime import datetime, timedelta
4-
from src.export_csv import ExportCSV
5-
from src.ummeter import UMmeterData
4+
from pyummeter import UMmeterData
5+
from pyummeter.export_csv import ExportCSV
66

77

88
@pytest.fixture

tests/test_ummeter.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
from datetime import timedelta
22
import pytest
3-
from src.ummeter import UMmeter
3+
from pyummeter import UMmeter
44

55

66
@pytest.fixture

0 commit comments

Comments
 (0)