Add pre commits

.gitignore

@@ -160,4 +160,7 @@ cython_debug/
 #.idea/
 
 # Visual Studio
-.vscode/
+.vscode/
+
+# ruff cache
+.ruff_cache/

.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v3.2.0
+  hooks:
+  - id: trailing-whitespace
+  - id: end-of-file-fixer
+  - id: check-yaml
+  - id: check-added-large-files
+- repo: https://github.com/charliermarsh/ruff-pre-commit
+  rev: v0.0.275
+  hooks:
+  - id: ruff
+- repo: https://github.com/psf/black
+  rev: 23.3.0
+  hooks:
+  - id: black
+    args:
+    - --check

LICENSE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -92,4 +92,4 @@ Please make a pull request or log an issue on GitHub.
 
 ## License
 
-Code is released as free software under the MIT License (see `LICENSE` file).
+Code is released as free software under the MIT License (see `LICENSE` file).

efaciency/block.py

@@ -1,14 +1,14 @@
 """efaciency block"""
 
 from datetime import date, datetime, timedelta
-from typing import List, Dict, Any
+from typing import Any, Dict, List
 
 from efaciency.utils import (
     convert_to_local,
     get_efa_block,
     get_efa_date,
-    get_efa_start_time,
     get_efa_end_time,
+    get_efa_start_time,
 )
 
 

efaciency/settlement_period.py

@@ -1,7 +1,7 @@
 """efaciency settlement_period"""
 
 from datetime import date, datetime, timedelta
-from typing import List, Dict, Any
+from typing import Any, Dict, List
 
 from efaciency.utils import (
     convert_to_local,

pyproject.toml

@@ -15,3 +15,19 @@ dependencies = [
 
 [project.urls]
 "Homepage" = "https://github.com/capcir/efaciency"
+
+[tool.ruff]
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "C",  # flake8-comprehensions
+    "B",  # flake8-bugbear
+]
+ignore = [
+    "E501",  # line too long, handled by black
+]
+
+[tool.ruff.per-file-ignores]
+"__init__.py" = ["F401"]

requirements-dev.txt

@@ -2,4 +2,5 @@ black
 coverage
 flit
 pytest
-pytz
+pytz
+ruff

tests/test_utils.py

@@ -2,7 +2,18 @@
 
 import pytest
 
-from efaciency.utils import *
+from efaciency.utils import (
+    UTC,
+    convert_to_local,
+    convert_to_utc,
+    get_efa_block,
+    get_efa_date,
+    get_efa_end_time,
+    get_efa_start_time,
+    get_settlement_date,
+    get_settlement_period,
+    get_ts,
+)
 
 STR_FORMAT = "%Y-%m-%d %H:%M:%S%z"