Config str (#47)

Author: joaonc

README.md

@@ -4,6 +4,11 @@ Prevent external HD's from becoming inactive (sleeping).
 
 **[https://joaonc.github.io/hd_active](https://joaonc.github.io/hd_active)**
 
+## Quick start
+```
+python -m app.hd_active --conf app/hd_active.ini
+```
+
 ## Development
 Note: Best to work on a virtual environment.
 This page doesn't go into how to do that.

app/hd_active.py

@@ -174,7 +174,7 @@ def change_state(self) -> HdActionState:
     config = HdActiveConfig(args.conf)
     hd_active = HdActive(drive_paths=config.drive_paths, run=config.run, wait=config.wait)
     hd_active.start()
-    print('HD Active started.')
+    print(f'HD Active started.\n{config}')
     while True:
         x = input('Type `s` to stop: ')
         if x.lower() == 's':

app/hd_active_config.py

@@ -25,6 +25,9 @@ def __init__(self, file_name: str):
         )
         self.read()
 
+    def __str__(self):
+        return f'drive paths: {", ".join(self.drive_paths)}' f'\nwait: {self.wait}s'
+
     def read(self):
         files_read = self.config.read(self.file_name)
         if not files_read:

dev-requirements.txt

@@ -30,7 +30,7 @@ colorama==0.4.4
     #   pytest
 distlib==0.3.4
     # via virtualenv
-dparse==0.5.1
+dparse==0.6.2
     # via safety
 filelock==3.7.0
     # via virtualenv
@@ -110,11 +110,14 @@ pytest-check==1.0.5
 pyyaml==6.0
     # via
     #   bandit
-    #   dparse
     #   pre-commit
 requests==2.27.1
     # via safety
-safety==1.10.3
+ruamel-yaml==0.17.21
+    # via safety
+ruamel-yaml-clib==0.2.7
+    # via ruamel-yaml
+safety==2.3.5
     # via -r dev-requirements.in
 shiboken6==6.2.2.1
     # via

docs/index.md

@@ -19,6 +19,11 @@ The _objectives_ of this project, however are the following:
     * Other functionality that PyInvoke provides.
 * CI with GitHub Actions.
 
+## Quick start
+```
+python -m app.hd_active --conf app/hd_active.ini
+```
+
 ## Config file
 The file `hd_active.ini`, located in the same folder as the app, is used to persist settings.
 
@@ -37,6 +42,6 @@ The file is created/updated when settings change.
 ```
 [HD Active]
 run_on_start = True
-wait_between_access = 60
+wait_between_access = 30
 drives = e:\, f:\, g:\
 ```

tasks.py

@@ -109,9 +109,7 @@ def ui_edit(c, file):
     file_stem = file[:-3] if file.lower().endswith('.ui') else file
     ui_file_path = next((p for p in UI_FILES if p.stem == file_stem), None)
     if not ui_file_path:
-        raise Exit(
-            f'File "{file}" not found. Available files: ", ".join(p.stem for p in UI_FILES)'
-        )
+        raise Exit(f'File "{file}" not found. Available files: ", ".join(p.stem for p in UI_FILES)')
 
     c.run(f'pyside6-designer {ui_file_path}', asynchronous=True)
 
@@ -210,6 +208,9 @@ def pip_package(c, requirements, package):
 def pip_upgrade(c, requirements):
     """
     Try to upgrade all dependencies to their latest versions.
+
+    Use `pip-compile <filename> --upgrade-package <package>` to only upgrade one package.
+    Ex `pip-compile dev-requirements.in --upgrade-package safety`
     """
     for filename in _get_requirements_files(requirements, 'in'):
         c.run(f'pip-compile --upgrade {filename}')

tests/test_hd_active_config.py

@@ -70,3 +70,24 @@ def test_drives(config_file):
 def test_file_doesnt_exist():
     with pytest.raises(FileNotFoundError):
         HdActiveConfig('foo_doesnt_exist.ini')
+
+
+@pytest.mark.parametrize(
+    'config_file',
+    [
+        pytest.param(
+            (
+                '''[HD Active]
+wait_between_access = 7
+drives = e:\\,f:\\''',
+                'drive paths: e:\\, f:\\\nwait: 7.0s',
+            ),
+            id='two drives',
+        ),
+    ],
+    indirect=True,
+)
+def test_str(config_file):
+    file_name, expected_str = config_file
+    config = HdActiveConfig(file_name)
+    assert str(config) == expected_str