Release 2.0

.github/workflows/pythonpackage.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
         include:
           - python-version: "3.11"
             use_pandas: 1
@@ -26,16 +26,24 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
           cache: poetry
-      - run: poetry install
-      - name: Pylint
+      - run: |
+          if ! poetry install; then
+            poetry lock
+            poetry install
+          fi
+      - name: Pylint (Python v${{ matrix.python-version }})
         run: poetry run pylint functional
-      - name: black
-        run: poetry run black --check functional
+        if: matrix.python-version != '3.12' && matrix.python-version != '3.13'
+      - name: Ruff (Python v${{ matrix.python-version }})
+        run: poetry run ruff check functional
+        if:  matrix.python-version == '3.12' || matrix.python-version == '3.13'
+      - name: black (Python v${{ matrix.python-version }})
+        run: poetry run black --diff --check functional
         if: always()
-      - name: Test with pytest
+      - name: Test with pytest (Python v${{ matrix.python-version }})
         run: poetry run pytest --cov=functional --cov-report=xml
         if: always()
-      - name: mypy
+      - name: mypy (Python v${{ matrix.python-version }})
         run: poetry run mypy functional
         if: always()
       - uses: codecov/codecov-action@v1

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: check-yaml
       - id: check-added-large-files
@@ -23,6 +23,6 @@ repos:
         pass_filenames: false
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.4.2
+    rev: v0.6.0
     hooks:
       - id: ruff

CHANGELOG.md

@@ -1,50 +1,69 @@
 # Changelog
 
+## Release 2.0
+
+- Renamed `head_option` and `last_option` to `head_or_none` and `last_or_none` respectively
+  - __N.B:__ This is potentially a breaking change as the renamed functions are being repurposed to return an `Option`
+    and will no longer return the raw value or `None`
+  - The old names are less applicable as the functions do not provide any 'option' apart from their single parameter,
+    which is no different to that of `head/first` and `last`
+- Corrected and improved language consistency in readme and `CHANGELOG.md`
+- Fixed tests failing (to find test files) when running from the IDE or the terminal when not in the right directory
+
+### New Features
+
+- Added `first_or_none`, a function to match `head_or_none`   
+- Added run_test.sh script
+- Added [parametrize](https://pypi.org/project/parametrize/) for parameterized unit tests
+
 ## Release 1.5
 
 ## Release 1.4
 
-- Allow empty sequence expressions `seq()`, `pseq()` (#159)
-- Add `no_wrap` option to `head()`, `head_option()`, `first()`, `last()` and `last_option()`, as well as to `seq()`, `pseq()` and `Sequence` constructor
+- Added support for empty sequence expressions `seq()`, `pseq()` (#159)
+- Added `no_wrap` option to `head()`, `head_option()`, `first()`, `last()` and `last_option()`, as well as to `seq()`, `pseq()` and `Sequence` constructor
 
 ## Release 1.3.0
 
-- added precompute attribute to reverse transformation (#137)
-- Update setup.py dill to requirements.txt (#138)
+- Added precompute attribute to reverse transformation (#137)
+- Updated setup.py dill to requirements.txt (#138)
 - Docstring of tail fixed (#140)
-- adding extend feature (#144)
+- Added extend feature (#144)
 
 ## Release 1.2.0
 
-- Fix Broken link in readme
-- Loosen version requirements #129
-- Fix lint errors
-- Fix StopIteration errors for Python 3.7 #132
-- Drop support for python 3.4
+- Fixed Broken link in readme
+- Loosened version requirements #129
+- Fixed lint errors
+- Fixed StopIteration errors for Python 3.7 #132
+- Dropped support for python 3.4
 
 ## Release 1.1.3
 
-- Fix bug in `partition` https://github.com/EntilZha/PyFunctional/issues/124
+- Fixed bug in `partition` https://github.com/EntilZha/PyFunctional/issues/124
 
 ## Release 1.1.0
 
 - Implemented optimized version of `reduce_by_key`
 - Implemented `count_by_key`
 - Implemented `count_by_value`
 - Implemented `accumulate` https://github.com/EntilZha/PyFunctional/pull/104
-- Fix bug in `grouped` https://github.com/EntilZha/PyFunctional/pull/123
-- Fix bug in `to_csv` https://github.com/EntilZha/PyFunctional/pull/123
-- Fix bug with incorrect wrapping of pandas dataframes https://github.com/EntilZha/PyFunctional/pull/122
-- Allow variance on versions of certain packages: https://github.com/EntilZha/PyFunctional/pull/117 and https://github.com/EntilZha/PyFunctional/pull/116
+- Added support for variance on versions of certain packages: https://github.com/EntilZha/PyFunctional/pull/117 and https://github.com/EntilZha/PyFunctional/pull/116
 - Various typo fixes
 - Various CI fixes
-- Fix issue with `first/head` evaluating entire sequence https://github.com/EntilZha/PyFunctional/commit/fb8f3686cf94f072f4e6ed23a361952de1447dc8
-- Drop CI testing and official support for Python 3.3
-- Make import much faster by loading pandas more lazily https://github.com/EntilZha/PyFunctional/issues/99
+- Dropped CI testing and official support for Python 3.3
+- Made import much faster by loading pandas more lazily https://github.com/EntilZha/PyFunctional/issues/99
+
+### Bug Fixes
+
+- Fixed bug in `grouped` https://github.com/EntilZha/PyFunctional/pull/123
+- Fixed bug in `to_csv` https://github.com/EntilZha/PyFunctional/pull/123
+- Fixed bug with incorrect wrapping of pandas dataframes https://github.com/EntilZha/PyFunctional/pull/122
+- Fixed issue with `first/head` evaluating entire sequence https://github.com/EntilZha/PyFunctional/commit/fb8f3686cf94f072f4e6ed23a361952de1447dc8
 
 ## Release 1.0.0
 
-Reaching `1.0` primarily means that API stability has been reached so I don't expect to run into many new breaking changes.
+Reaching `1.0` primarily means that API stability has been reached, so I don't expect to run into many new breaking changes.
 
 ### New Features
 
@@ -67,13 +86,13 @@ Reaching `1.0` primarily means that API stability has been reached so I don't ex
 
 - Implemented pretty html repr for Jupyter
 - Implemented proper parsing of pandas DataFrames
-- Detect when its possible to pretty print a table and do so
+- Added feature to detect when it's possible to pretty print a table and do so
 - `list`/`to_list` have a parameter `n` to limit number of results
 
 ### Bug Fixes
 
 - Fixed bug where `grouped` unnecessarily forces precomputation of sequence
-- Remove package installations from default requirements that sometimes break installation on barebones systems in python 2.7
+- Removed package installations from default requirements that sometimes break installation on barebones systems in python 2.7
 
 ## Release 0.7.0
 
@@ -96,14 +115,14 @@ Reaching `1.0` primarily means that API stability has been reached so I don't ex
 ### Contributors
 
 - Thanks to [versae](https://github.com/versae) for implementing most of the `pseq` feature!
-- Thanks to [ChuyuHsu](https://github.com/ChuyuHsu) for implemented large parts of the compression feature!
+- Thanks to [ChuyuHsu](https://github.com/ChuyuHsu) for implementing large parts of the compression feature!
 
 ## Release 0.6.0
 
 ### New Features
 
 - Added support for reading to and from SQLite databases
-- Change project name to `PyFunctional` from `ScalaFunctional`
+- Changed project name from `ScalaFunctional` to `PyFunctional` 
 - Added `to_pandas` call integration
 
 ### Internal Changes
@@ -125,13 +144,13 @@ Reaching `1.0` primarily means that API stability has been reached so I don't ex
 
 - Fixed case where `_wrap` is changing named tuples to arrays when it should preserve them
 - Fixed documentation on `to_file` which incorrectly copied from `seq.open` delimiter parameter
-- Fixed `Sequence.zip_with_index` behavior. used to mimic `enumerate` by zipping on the left size
-  while scala and spark do zip on the right side. This introduces different behavior and more flexible
-  behavior in combination with `enumerate` A start parameter was also added like in `enumerate`
+- Fixed `Sequence.zip_with_index` behavior, which used to mimic `enumerate` by zipping on the left side
+  while Scala and Spark zip on the right side. This introduces different but more flexible
+  behavior in combination with `enumerate`. A start parameter was also added like in `enumerate`
 
 ## Release 0.4.1
 
-Fix python 3 build error due to wheel installation of enum34. Package no longer depends on enum34
+Fixed python 3 build error due to wheel installation of enum34. Package no longer depends on enum34
 
 ## Release 0.4.0
 
@@ -156,7 +175,7 @@ Fix python 3 build error due to wheel installation of enum34. Package no longer
 - `Sequence.to_file` to save files
 - `Sequence.to_csv` to save csv files
 - Improved documentation with more examples and mention LINQ explicitly
-- Change PyPi keywords to improve discoverability
+- Changed PyPi keywords to improve discoverability
 - Created [Google groups mailing list](https://groups.google.com/forum/#!forum/scalafunctional)
 
 ### Bug Fixes

DEVELOPER.md

@@ -4,7 +4,7 @@
 For every release, the following process is used.
 
 ### Before Release
-1. From the project directory, run `./run-tests.sh` to insure unit tests pass (on python 2 and 3),
+1. From the project directory, run [./run-tests.sh](run-tests.sh) to insure unit tests pass (on python 2 and 3),
 and that pylint succeeds
 2. Push commit which is the candidate release to Github master
 3. Wait for tests to pass on [TravisCI](https://travis-ci.org/EntilZha/PyFunctional)