From 77f01a099cd671f45dfcc8746d3215848e122e51 Mon Sep 17 00:00:00 2001 From: Alfi Maulana Date: Wed, 18 Jun 2025 12:28:34 +0700 Subject: [PATCH 1/3] refactor: rename example project to `bonaccis` Signed-off-by: Alfi Maulana --- pyproject.toml | 8 ++-- src/{my_fibonacci => bonacci}/__init__.py | 0 src/{my_fibonacci => bonacci}/__main__.py | 6 +-- src/{my_fibonacci => bonacci}/sequence.py | 0 tests/test_sequence.py | 2 +- uv.lock | 46 +++++++++++------------ 6 files changed, 31 insertions(+), 31 deletions(-) rename src/{my_fibonacci => bonacci}/__init__.py (100%) rename src/{my_fibonacci => bonacci}/__main__.py (77%) rename src/{my_fibonacci => bonacci}/sequence.py (100%) diff --git a/pyproject.toml b/pyproject.toml index 1c4f84d..044dab3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,12 +1,12 @@ [project] -name = "my_fibonacci" +name = "bonacci" version = "0.0.0" dependencies = [] requires-python = ">=3.10" authors = [ {name = "Alfi Maulana", email = "alfi.maulana.f@gmail.com"}, ] -description = "A starter python module for generating a Fibonacci sequence." +description = "An example Python project for generating a Fibonacci sequence" readme = "README.md" license = "Unlicense" keywords = ["python", "starter", "fibonacci"] @@ -19,7 +19,7 @@ classifiers = [ ] [project.scripts] -my_fibonacci = "my_fibonacci.__main__:main" +bonacci = "bonacci.__main__:main" [project.urls] repository = "https://github.com/threeal/python-starter.git" @@ -42,7 +42,7 @@ fail_under = 100 omit = ["__main__.py"] [tool.coverage.run] -source = ["my_fibonacci"] +source = ["bonacci"] [tool.ruff.lint] select = ["ALL"] diff --git a/src/my_fibonacci/__init__.py b/src/bonacci/__init__.py similarity index 100% rename from src/my_fibonacci/__init__.py rename to src/bonacci/__init__.py diff --git a/src/my_fibonacci/__main__.py b/src/bonacci/__main__.py similarity index 77% rename from src/my_fibonacci/__main__.py rename to src/bonacci/__main__.py index 96ffd12..dfb2a92 100644 --- a/src/my_fibonacci/__main__.py +++ b/src/bonacci/__main__.py @@ -5,10 +5,10 @@ def main() -> None: parser = argparse.ArgumentParser( - prog="my_fibonacci", - description="Generate a Fibonacci sequence up to the given number of terms.", + prog="bonacci", + description="Generate a Fibonacci sequence up to the given number of terms", ) - parser.add_argument("--version", action="version", version="0.0.0") + parser.add_argument("-v", "--version", action="version", version="0.0.0") parser.add_argument("n", type=int, help="The number of terms") args = parser.parse_args() diff --git a/src/my_fibonacci/sequence.py b/src/bonacci/sequence.py similarity index 100% rename from src/my_fibonacci/sequence.py rename to src/bonacci/sequence.py diff --git a/tests/test_sequence.py b/tests/test_sequence.py index 4d14810..db6a2dd 100644 --- a/tests/test_sequence.py +++ b/tests/test_sequence.py @@ -1,4 +1,4 @@ -from my_fibonacci import fibonacci_sequence +from bonacci import fibonacci_sequence def test_fibonacci_sequence() -> None: diff --git a/uv.lock b/uv.lock index 69e7a9f..a78c42c 100644 --- a/uv.lock +++ b/uv.lock @@ -2,6 +2,29 @@ version = 1 revision = 2 requires-python = ">=3.10" +[[package]] +name = "bonacci" +version = "0.0.0" +source = { editable = "." } + +[package.dev-dependencies] +dev = [ + { name = "lefthook" }, + { name = "pytest" }, + { name = "pytest-cov" }, + { name = "ruff" }, +] + +[package.metadata] + +[package.metadata.requires-dev] +dev = [ + { name = "lefthook", specifier = ">=1.11.14" }, + { name = "pytest", specifier = ">=8.4.0" }, + { name = "pytest-cov", specifier = ">=6.2.1" }, + { name = "ruff", specifier = ">=0.11.13" }, +] + [[package]] name = "colorama" version = "0.4.6" @@ -110,29 +133,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/80/33/733ed0f218b1959e52b9b35617ad7ef6a082558e938d9403eb0197c20e6e/lefthook-1.11.14-py3-none-any.whl", hash = "sha256:daf02089d0ba368070a132524bf0b2068ba131d2208678eecac719c351b72dac", size = 49734655, upload-time = "2025-06-16T09:25:05.873Z" }, ] -[[package]] -name = "my-fibonacci" -version = "0.0.0" -source = { editable = "." } - -[package.dev-dependencies] -dev = [ - { name = "lefthook" }, - { name = "pytest" }, - { name = "pytest-cov" }, - { name = "ruff" }, -] - -[package.metadata] - -[package.metadata.requires-dev] -dev = [ - { name = "lefthook", specifier = ">=1.11.14" }, - { name = "pytest", specifier = ">=8.4.0" }, - { name = "pytest-cov", specifier = ">=6.2.1" }, - { name = "ruff", specifier = ">=0.11.13" }, -] - [[package]] name = "packaging" version = "25.0" From 3a87e8a4764bed786ca324586245e488111b4882 Mon Sep 17 00:00:00 2001 From: Alfi Maulana Date: Wed, 18 Jun 2025 13:40:57 +0700 Subject: [PATCH 2/3] docs: use example metadata in `pyproject.toml` Signed-off-by: Alfi Maulana --- pyproject.toml | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 044dab3..4f00073 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,26 +4,23 @@ version = "0.0.0" dependencies = [] requires-python = ">=3.10" authors = [ - {name = "Alfi Maulana", email = "alfi.maulana.f@gmail.com"}, + {name = "Leonardo Bonacci", email = "leonardo@bonacci.com"}, ] description = "An example Python project for generating a Fibonacci sequence" readme = "README.md" license = "Unlicense" -keywords = ["python", "starter", "fibonacci"] +keywords = ["example", "fibonacci"] classifiers = [ "Development Status :: 1 - Planning", - "Intended Audience :: Developers", - "Operating System :: OS Independent", "Programming Language :: Python :: 3 :: Only", - "Topic :: Software Development :: Libraries :: Python Modules", ] [project.scripts] bonacci = "bonacci.__main__:main" [project.urls] -repository = "https://github.com/threeal/python-starter.git" -issues = "https://github.com/threeal/python-starter/issues" +repository = "https://github.com/leonardo/bonacci.git" +issues = "https://github.com/leonardo/bonacci/issues" [build-system] requires = ["hatchling"] From 53af1f06c839490423de0f023a11d13a9ce803a8 Mon Sep 17 00:00:00 2001 From: Alfi Maulana Date: Wed, 18 Jun 2025 13:42:40 +0700 Subject: [PATCH 3/3] style: use 4 spaces indentation in `pyproject.toml` Signed-off-by: Alfi Maulana --- pyproject.toml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 4f00073..526dd1d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,15 +4,15 @@ version = "0.0.0" dependencies = [] requires-python = ">=3.10" authors = [ - {name = "Leonardo Bonacci", email = "leonardo@bonacci.com"}, + {name = "Leonardo Bonacci", email = "leonardo@bonacci.com"}, ] description = "An example Python project for generating a Fibonacci sequence" readme = "README.md" license = "Unlicense" keywords = ["example", "fibonacci"] classifiers = [ - "Development Status :: 1 - Planning", - "Programming Language :: Python :: 3 :: Only", + "Development Status :: 1 - Planning", + "Programming Language :: Python :: 3 :: Only", ] [project.scripts] @@ -28,10 +28,10 @@ build-backend = "hatchling.build" [dependency-groups] dev = [ - "lefthook>=1.11.14", - "pytest>=8.4.0", - "pytest-cov>=6.2.1", - "ruff>=0.11.13", + "lefthook>=1.11.14", + "pytest>=8.4.0", + "pytest-cov>=6.2.1", + "ruff>=0.11.13", ] [tool.coverage.report]