Added ruff and repository linting

.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.8.2
+  hooks:
+    - id: ruff
+      args: [--fix]
+    - id: ruff-format

examples/example.py

@@ -1,11 +1,10 @@
-
 from wellbelog.belolis.reader import LisReader  # noqa
 
 
 if __name__ == '__main__':
-    PATH_TO_FILE = r'test\test_files\1-MPE-3-AL.lis'
+	PATH_TO_FILE = r'test\test_files\1-MPE-3-AL.lis'
 
-    reader = LisReader()
-    file = reader.process_physical_file(PATH_TO_FILE)
-    print(file.file_name)
-    print(file.logical_files_table())
+	reader = LisReader()
+	file = reader.process_physical_file(PATH_TO_FILE)
+	print(file.file_name)
+	print(file.logical_files_table())

examples/example_dlis.py

@@ -1,12 +1,11 @@
-
 from wellbelog.belodlis.reader import DlisReader  # noqa
 
 
 if __name__ == '__main__':
-    PATH_TO_FILE = r'test\test_files\1PIR1AL_conv_ccl_canhoneio.dlis'
+	PATH_TO_FILE = r'test\test_files\1PIR1AL_conv_ccl_canhoneio.dlis'
 
-    reader = DlisReader()
-    file = reader.process_physical_file(PATH_TO_FILE)
-    print(file.file_name)
-    print(file.logical_files_table())
-    table = file.logical_files_table()
+	reader = DlisReader()
+	file = reader.process_physical_file(PATH_TO_FILE)
+	print(file.file_name)
+	print(file.logical_files_table())
+	table = file.logical_files_table()

examples/example_las.py

@@ -1,11 +1,10 @@
-
 from wellbelog.belolas.reader import LasReader  # noqa
 
 
 if __name__ == '__main__':
-    PATH_TO_FILE = r'test\test_files\1-MPE-3-AL_hals-dslt-tdd-hgns-gr_resistividade_repetida.las'
+	PATH_TO_FILE = r'test\test_files\1-MPE-3-AL_hals-dslt-tdd-hgns-gr_resistividade_repetida.las'
 
-    reader = LasReader()
-    file = reader.process_las_file(PATH_TO_FILE)
-    print(file.file_name)
-    print(file.table_view())
+	reader = LasReader()
+	file = reader.process_las_file(PATH_TO_FILE)
+	print(file.file_name)
+	print(file.table_view())

examples/main_reader.py

@@ -4,6 +4,6 @@
 PATH_TO_FILE = r'test\test_files\1PIR1AL_conv_ccl_canhoneio.dlis'
 
 if __name__ == '__main__':
-    reader = MainReader()
-    file = reader.load_file(PATH_TO_FILE)
-    print(file.file_name)
+	reader = MainReader()
+	file = reader.load_file(PATH_TO_FILE)
+	print(file.file_name)

pyproject.toml

@@ -18,6 +18,7 @@ shapely = "^2.0.6"
 sqlalchemy = "^2.0.34"
 pytest = "^8.3.3"
 pytest-cov = "^5.0.0"
+ruff = "^0.8.3"
 
 
 [tool.poetry.group.dev.dependencies]

ruff.toml

@@ -0,0 +1,9 @@
+line-length = 150
+[lint]
+ignore = ["F403"]
+
+# To specify that this rule should only be ignored for __init__.py files
+exclude = ["**/__init__.py"]
+[format]
+quote-style = "single"
+indent-style = "tab"

setup.py

@@ -1,10 +1,10 @@
 from setuptools import setup
 
 if __name__ == '__main__':
-    setup(
-        name='wellbelog',
-        version='0.0.1',
-        description='A Python package for reading well log files.',
-        author='Pedro Cavalcanti',
-        author_email='[email protected]',
-    )
+	setup(
+		name='wellbelog',
+		version='0.0.1',
+		description='A Python package for reading well log files.',
+		author='Pedro Cavalcanti',
+		author_email='[email protected]',
+	)

test/dlis/test_dlis_export.py

@@ -9,26 +9,25 @@
 
 
 def test_exports():
-    dlis_processor = DlisReader()
-    physical_file = dlis_processor.process_physical_file(file_path)
-    assert physical_file.file_name == '1PIR1AL_conv_ccl_canhoneio.dlis'
-
-    file_curves = physical_file.curves_names
-    # Getting the first curve
-    frame = physical_file.logical_files[0].get_frame()
-    assert frame is not None
-    with tempfile.TemporaryDirectory() as temp_dir:
-
-        csv_path = Path(temp_dir) / 'test.csv'
-        physical_file.logical_files[0].get_frame().data.to_csv(csv_path)
-        assert csv_path.exists()
-        assert csv_path.is_file()
-        assert csv_path.stat().st_size > 0
-
-        # Check the column names
-        with open(csv_path, 'r') as f:
-            columns = f.readline().strip().split(',')
-            if 'FRAMENO' in columns:
-                columns.remove('FRAMENO')
-            for _, column in enumerate(columns):
-                assert file_curves.__contains__(column)
+	dlis_processor = DlisReader()
+	physical_file = dlis_processor.process_physical_file(file_path)
+	assert physical_file.file_name == '1PIR1AL_conv_ccl_canhoneio.dlis'
+
+	file_curves = physical_file.curves_names
+	# Getting the first curve
+	frame = physical_file.logical_files[0].get_frame()
+	assert frame is not None
+	with tempfile.TemporaryDirectory() as temp_dir:
+		csv_path = Path(temp_dir) / 'test.csv'
+		physical_file.logical_files[0].get_frame().data.to_csv(csv_path)
+		assert csv_path.exists()
+		assert csv_path.is_file()
+		assert csv_path.stat().st_size > 0
+
+		# Check the column names
+		with open(csv_path, 'r') as f:
+			columns = f.readline().strip().split(',')
+			if 'FRAMENO' in columns:
+				columns.remove('FRAMENO')
+			for _, column in enumerate(columns):
+				assert file_curves.__contains__(column)

test/dlis/test_dlis_functions.py

@@ -9,9 +9,9 @@
 
 
 def test_open_dlis_file():
-    physical_file = open_dlis_file(file_path)
-    assert isinstance(physical_file, dlis.PhysicalFile)
-    logical_files = unpack_physical_dlis(physical_file)
-    assert isinstance(logical_files, list)
-    assert len(logical_files) > 0
-    assert isinstance(logical_files[0], dlis.LogicalFile)
+	physical_file = open_dlis_file(file_path)
+	assert isinstance(physical_file, dlis.PhysicalFile)
+	logical_files = unpack_physical_dlis(physical_file)
+	assert isinstance(logical_files, list)
+	assert len(logical_files) > 0
+	assert isinstance(logical_files[0], dlis.LogicalFile)

test/dlis/test_dlis_models.py

@@ -10,63 +10,63 @@
 
 
 def test_dlis_physical_schema():
-    dlis_processor = DlisReader()
-    physical_file = dlis_processor.process_physical_file(file_path)
-    assert physical_file.file_name == '1PIR1AL_conv_ccl_canhoneio.dlis'
+	dlis_processor = DlisReader()
+	physical_file = dlis_processor.process_physical_file(file_path)
+	assert physical_file.file_name == '1PIR1AL_conv_ccl_canhoneio.dlis'
 
-    assert physical_file.logical_files_count > 0
+	assert physical_file.logical_files_count > 0
 
-    assert physical_file.curves_names is not None
+	assert physical_file.curves_names is not None
 
-    # We already know that the file has the CCL curve
-    # Test file curves = ['LTEN', 'TDEP', 'LSPD', 'MINMK', 'CCL']
-    assert 'CCL' in physical_file.curves_names
+	# We already know that the file has the CCL curve
+	# Test file curves = ['LTEN', 'TDEP', 'LSPD', 'MINMK', 'CCL']
+	assert 'CCL' in physical_file.curves_names
 
 
 def test_logical_files_table():
-    dlis_processor = DlisReader()
-    physical_file = dlis_processor.process_physical_file(file_path)
-    table = physical_file.logical_files_table()
-    assert table.columns[0].header == 'File Name'
-    assert table.columns[1].header == 'Curves'
-    assert table.columns[2].header == 'Error'
-    assert len(table.columns) == 3
-    assert len(table.rows) == physical_file.logical_files_count
-    assert table.title == '1PIR1AL_conv_ccl_canhoneio.dlis'
+	dlis_processor = DlisReader()
+	physical_file = dlis_processor.process_physical_file(file_path)
+	table = physical_file.logical_files_table()
+	assert table.columns[0].header == 'File Name'
+	assert table.columns[1].header == 'Curves'
+	assert table.columns[2].header == 'Error'
+	assert len(table.columns) == 3
+	assert len(table.rows) == physical_file.logical_files_count
+	assert table.title == '1PIR1AL_conv_ccl_canhoneio.dlis'
 
 
 def test_logical_file_schema_methods():
-    reader = DlisReader()
-    physical_file = reader.process_physical_file(file_path)
-    logical_file = physical_file.logical_files[0]
-    # Logical File curves names = ['TDEP', 'LSPD', 'LTEN', 'CCL', 'MINMK']
-    assert logical_file.file_name == '1PIR1AL_conv_ccl_canhoneio.dlis'
-    assert logical_file.error is False
-    assert logical_file.error_message is None
+	reader = DlisReader()
+	physical_file = reader.process_physical_file(file_path)
+	logical_file = physical_file.logical_files[0]
+	# Logical File curves names = ['TDEP', 'LSPD', 'LTEN', 'CCL', 'MINMK']
+	assert logical_file.file_name == '1PIR1AL_conv_ccl_canhoneio.dlis'
+	assert logical_file.error is False
+	assert logical_file.error_message is None
 
-    # NOTE Testing Curves names
-    assert logical_file.curves_names is not None
-    assert 'CCL' in logical_file.curves_names
+	# NOTE Testing Curves names
+	assert logical_file.curves_names is not None
+	assert 'CCL' in logical_file.curves_names
 
-    # NOTE Testing Frames counting
-    assert logical_file.frames_count == len(logical_file.frames)
+	# NOTE Testing Frames counting
+	assert logical_file.frames_count == len(logical_file.frames)
 
-    assert isinstance(logical_file.frames[0], FrameModel)
+	assert isinstance(logical_file.frames[0], FrameModel)
 
-    # NOTE Testing table view
-    table = logical_file.table_view()
-    assert table.columns[0].header == 'Logical File ID'
-    assert table.columns[1].header == 'File Name'
-    assert table.columns[2].header == 'Frames'
-    assert table.columns[3].header == 'Curves'
-    assert table.columns[4].header == 'Error'
+	# NOTE Testing table view
+	table = logical_file.table_view()
+	assert table.columns[0].header == 'Logical File ID'
+	assert table.columns[1].header == 'File Name'
+	assert table.columns[2].header == 'Frames'
+	assert table.columns[3].header == 'Curves'
+	assert table.columns[4].header == 'Error'
 
 
 def test_frame_schema_methods():
-    reader = DlisReader()
-    physical_file = reader.process_physical_file(file_path)
-    logical_file = physical_file.logical_files[0]
-    frame = logical_file.frames[0]
+	reader = DlisReader()
+	physical_file = reader.process_physical_file(file_path)
+	logical_file = physical_file.logical_files[0]
+	frame = logical_file.frames[0]
 
-    assert frame.logical_file_id == logical_file.logical_id
-    assert isinstance(frame.data.as_df(), pd.DataFrame)
+	assert frame.logical_file_id == logical_file.logical_id
+	assert isinstance(frame.data.as_df(), pd.DataFrame)