Use lower-case type hints and fix test data types

Author: neubig

.github/workflows/lint.yml

@@ -1,6 +1,6 @@
 name: Lint
 
-on: [push, pull_request]
+on: [pull_request]
 
 jobs:
   lint:
@@ -10,7 +10,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
-        python-version: '3.8'
+        python-version: '3.12'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

.github/workflows/test.yml

@@ -1,13 +1,13 @@
 name: Test
 
-on: [push, pull_request]
+on: [pull_request]
 
 jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.11', '3.12']
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Graham Neubig
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+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.

README.md

@@ -88,5 +88,25 @@ pip install -e ".[dev]"
 5. Run tests: `pytest`
 6. Submit a pull request
 
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+> **Note**: Without a license, the code is under exclusive copyright by default. This means no one can copy, distribute, or modify your work without facing potential legal consequences. Adding a license (like MIT) explicitly grants these permissions, making it clear how others can use your code.
+
 ## Author
-Graham Neubig ([email protected])
+Graham Neubig ([email protected])
+
+## Citation
+
+If you use this repository in your research, please cite it using the following BibTeX entry:
+
+```bibtex
+@misc{neubig2025starter,
+  author = {Graham Neubig},
+  title = {Python Project Starter Repository},
+  year = {2025},
+  publisher = {GitHub},
+  journal = {GitHub Repository},
+  howpublished = {\url{https://github.com/neubig/starter-repo}}
+}

mypy.ini

@@ -0,0 +1,10 @@
+[mypy]
+python_version = 3.12
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+check_untyped_defs = true
+namespace_packages = true
+
+[mypy.plugins.numpy.*]
+ignore_errors = true

pyproject.toml

@@ -13,7 +13,8 @@ authors = [
 ]
 description = "A starter repository demonstrating Python best practices"
 readme = "README.md"
-requires-python = ">=3.8"
+license = "MIT"
+requires-python = ">=3.11"
 dependencies = [
     "pandas",
     "matplotlib",
@@ -25,18 +26,16 @@ dev = [
     "ruff",
     "mypy",
     "pre-commit",
+    "pandas-stubs",
 ]
 
 [tool.ruff]
-select = ["E", "F", "I"]
 line-length = 100
 
-[tool.mypy]
-python_version = "3.8"
-warn_return_any = true
-warn_unused_configs = true
-disallow_untyped_defs = true
-check_untyped_defs = true
+[tool.ruff.lint]
+select = ["E", "F", "I"]
+
+
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]

starter_repo/__init__.py

@@ -0,0 +1,3 @@
+"""A starter repository demonstrating Python best practices."""
+
+__version__ = "0.1.0"

starter_repo/plot_data.py

@@ -2,13 +2,12 @@
 
 import argparse
 from pathlib import Path
-from typing import List, Tuple
 
 import matplotlib.pyplot as plt
 import pandas as pd
 
 
-def read_csv_data(file_path: Path, x_col: str, y_col: str) -> Tuple[List[float], List[float]]:
+def read_csv_data(file_path: Path, x_col: str, y_col: str) -> tuple[list[float], list[float]]:
     """Read data from a CSV file and return specified columns.
 
     Args:
@@ -24,7 +23,7 @@ def read_csv_data(file_path: Path, x_col: str, y_col: str) -> Tuple[List[float],
 
 
 def create_plot(
-    x_data: List[float], y_data: List[float], x_label: str, y_label: str, title: str
+    x_data: list[float], y_data: list[float], x_label: str, y_label: str, title: str
 ) -> plt.Figure:
     """Create a plot from the provided data.
 

tests/test_plot_data.py

@@ -2,13 +2,14 @@
 
 import pandas as pd
 import pytest
+
 from starter_repo.plot_data import create_plot, read_csv_data
 
 
 @pytest.fixture
 def sample_csv(tmp_path: Path) -> Path:
     """Create a sample CSV file for testing."""
-    df = pd.DataFrame({"x": [1, 2, 3, 4, 5], "y": [2, 4, 6, 8, 10]})
+    df = pd.DataFrame({"x": [1.0, 2.0, 3.0, 4.0, 5.0], "y": [2.0, 4.0, 6.0, 8.0, 10.0]})
     file_path = tmp_path / "test.csv"
     df.to_csv(file_path, index=False)
     return file_path
@@ -17,14 +18,14 @@ def sample_csv(tmp_path: Path) -> Path:
 def test_read_csv_data(sample_csv: Path) -> None:
     """Test reading data from CSV file."""
     x_data, y_data = read_csv_data(sample_csv, "x", "y")
-    assert x_data == [1, 2, 3, 4, 5]
-    assert y_data == [2, 4, 6, 8, 10]
+    assert x_data == [1.0, 2.0, 3.0, 4.0, 5.0]
+    assert y_data == [2.0, 4.0, 6.0, 8.0, 10.0]
 
 
 def test_create_plot() -> None:
     """Test plot creation."""
-    x_data = [1, 2, 3]
-    y_data = [2, 4, 6]
+    x_data = [1.0, 2.0, 3.0]
+    y_data = [2.0, 4.0, 6.0]
     fig = create_plot(x_data, y_data, "X", "Y", "Test Plot")
     assert fig is not None
     # Basic check that the figure contains the expected elements