Add: pre-commit and linting / formatting (#25)

* Add: pre-commit and linting / formatting

* Fix: run pre-commit / ruff

* Fix: changelog

Author: lwasser

.pre-commit-config.yaml

@@ -0,0 +1,49 @@
+# pre-commit (https://pre-commit.com/) is a tool that runs source code checks
+# such as linting, formatting, and code style.
+
+# CI
+# pyosMeta uses pre-commit with the precommit.ci bot to check pull requests.
+# Configuration reference doc: https://pre-commit.com/#pre-commit-configyaml---top-level
+
+# Developers
+# You may want to install pre-commit to run locally on each minimum_pre_commit_version
+# See https://pre-commit.com/#install
+# To set up pre-commit hooks: pre-commit install
+# To run on all files: pre-commit run --all-files
+
+ci:
+  # pyosMeta disables autofixing of PRs to simplify new contributor experience and cleaner git history
+  autofix_prs: false
+  # Frequency of hook updates
+  autoupdate_schedule: weekly
+
+repos:
+  # Out of the box hooks for pre-commit https://github.com/pre-commit/pre-commit-hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      # Makes sure files end in a newline and only a newline.
+      - id: end-of-file-fixer
+      # Check for files with names that would conflict on a case-insensitive filesystem like MacOS HFS+ or Windows FAT.
+      - id: check-case-conflict
+      # Remove trailing whitespace on code lines
+      - id: trailing-whitespace
+
+  # Spelling hook
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell
+        additional_dependencies:
+          - tomli
+
+    # Lint code using ruff
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.5
+    hooks:
+    - id: ruff
+      args: [--fix, --exit-non-zero-on-fix]
+    # Ruff can be used as a code formatter replacing black
+    # It can also replace isort
+    - id: ruff-format
+      args: ["--line-length", "79"]

CODE_OF_CONDUCT.md

@@ -6,7 +6,7 @@
 We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
 size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
+identity and expression, level of experience, education, socioeconomic status,
 nationality, personal appearance, race, caste, color, religion, or sexual
 identity and orientation.
 
@@ -60,7 +60,7 @@ representative at an online or offline event.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement using 
+reported to the community leaders responsible for enforcement using
 [this form](https://forms.gle/7MR7tCpDuprtStWP9).
 
 All complaints will be reviewed and investigated promptly and fairly.
@@ -130,5 +130,5 @@ For answers to common questions about this code of conduct, see the FAQ at
 ## pyOpenSci Code of Conduct
 
 Please note the anyone contributing to any Github repositories in the pyOpenSci
-GitHub organization must also adhere to the 
-[pyOpenSci Code of Conduct](https://www.pyopensci.org/handbook/CODE_OF_CONDUCT.html).
+GitHub organization must also adhere to the
+[pyOpenSci Code of Conduct](https://www.pyopensci.org/handbook/CODE_OF_CONDUCT.html).

README.md

@@ -1,4 +1,4 @@
-# pyospackage 
+# pyospackage
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 [![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
@@ -11,7 +11,7 @@
 [![pyOpenSci](https://tinyurl.com/y22nb8up)](https://github.com/pyOpenSci/software-review/issues/115)
 
 ## What does pyospackage do?
-pyospackage is a demonstration Python package that compliments the pyOpenSci [beginner tutorial series on creating a Python package](https://www.pyopensci.org/python-package-guide/tutorials/intro.html). 
+pyospackage is a demonstration Python package that compliments the pyOpenSci [beginner tutorial series on creating a Python package](https://www.pyopensci.org/python-package-guide/tutorials/intro.html).
 
 **Table of Contents**
 
@@ -47,6 +47,23 @@ print(a)
 
 You can also add any links to this section to tutorials in your documentation.
 
+## Development
+
+* TODO: link to development docs when they exist and move the text below to the
+docs.
+
+### Linting & Code Formatting
+
+TODO: this will be added to the docs once they are created in a separate pr.
+
+All linting and code formatting is implemented in this package using a combination
+of pre-commit hooks and Ruff. Ruff is a fast, rust-based linter and code
+formatter that covers functionality previously implemented by Black and isort
+(formatters that are commonly used in the Python ecosystem). Ruff simplifies
+your linting and code format setup but running all of the checks and fixes
+using a single tool. As such pyOpenSci encourages new projects to consider
+using Ruff.
+
 ## Community
 
 Information here about contributing to your package. links to your code of conduct and development guide.
@@ -85,4 +102,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

changelog.md

@@ -4,10 +4,11 @@
 
 * Fix: Drop support for python 3.9, add for 3.12 (@lwasser, #15)
 * Add: Code of conduct to repo following contributors covenant (@lwasser, #17)
+* Add: Linting & code format using ruff / precommit (@lwasser, #19)
 
 ## 0.1.10
 
-* Initial publish to PyPI & Conda forge 
+* Initial publish to PyPI & Conda forge
 
 ## 0.1.9
 
@@ -23,4 +24,4 @@
 
 ## 0.1.6
 
-* Fix: Add `readme` and `pyproject.toml` file
+* Fix: Add `readme` and `pyproject.toml` file

pyproject.toml

@@ -34,4 +34,13 @@ Source = "https://github.com/pyopensci/pyospackage"
 dependencies = [
   "pytest",
   "pytest-cov"
-]
+]
+
+
+[tool.ruff]
+lint.select = [
+  "F", # pyflakes
+  "I", # isort
+]
+lint.ignore = ["F841"]
+line-length = 79

src/pyospackage/__init__.py

@@ -1 +0,0 @@
-from pyospackage.add_numbers import add_num

src/pyospackage/add_numbers.py

@@ -1,5 +1,8 @@
 """A module that performs basic math operations."""
 
 
-def add_num(a: int, b: int) -> int:
+def add_num(
+    a: int,
+    b: int,
+) -> int:
     return a + b