release-2.1.0

jacksonpradolima · web-flow · commit 46eca975c6db · 2024-12-26T00:15:24.000-03:00
Enhance Python Version Compatibility and Testing Workflow
diff --git a/.github/workflows/codecov.yml b/.github/workflows/codecov.yml
@@ -19,7 +19,7 @@ jobs:
                     python-version: 3.11
 
             -   name: Install dependencies
-                run: pip install -r requirements.txt
+                run: pip install -r requirements-dev.txt
 
             -   name: Run tests
                 run: pytest --cov --cov-branch --junitxml=junit.xml -o junit_family=legacy
@@ -36,4 +36,4 @@ jobs:
                 if: ${{ !cancelled() }}
                 uses: codecov/test-results-action@v1
                 with:
-                    token: ${{ secrets.CODECOV_TOKEN }}
+                    token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.python-version b/.python-version
@@ -0,0 +1,6 @@
+3.6.15
+3.7.12
+3.8.10
+3.9.16
+3.10.12
+3.11.4
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,49 +1,76 @@
 # Changelog
 
+## [v2.1.0] - 2024-12-26
+
+### **Compatibility Updates**
+- Updated **Python Compatibility**:
+  - Lowered the minimum Python version requirement from 3.11 to 3.8 in `setup.py`.
+  - Updated `README.md` to reflect compatibility with Python 3.8 and later.
+  - Added `tox.ini` configuration to test across Python versions 3.8 to 3.11.
+  - Added `.python-version` file specifying supported Python versions: 3.6.15, 3.7.12, 3.8.10, 3.9.16, 3.10.12, and 3.11.4.
+
+### **Dependency Management**
+- Split development dependencies:
+  - Moved development-specific dependencies to `requirements-dev.txt`.
+  - Removed redundant dependencies from `requirements.txt`.
+- Added `tox` as a development dependency in `requirements-dev.txt`.
+
+### **Testing Enhancements**
+- Introduced `tox` for managing tests across multiple Python versions.
+- Refactored GitHub Actions workflow (`codecov.yml`):
+  - Updated to install dependencies from `requirements-dev.txt`.
+  - Expanded testing configuration to include Python 3.8 compatibility.
+
+### **Documentation Updates**
+- Enhanced **README.md**:
+  - Updated Python badge to reflect compatibility with Python 3.8+.
+  - Included a clear statement of compatibility with Python 3.8 and later versions.
+
+### **Other Improvements**
+- Added classifiers in `setup.py` for Python 3.8, 3.9, and 3.10.
+- Improved project structure with the addition of `tox.ini` for environment management.
+
+---
+
 ## [v2.0.1] - 2024-12-25
 - Added **CITATION.cff** file for citation information.
-- Removed the GitHub sponsor badge from the README
+- Removed the GitHub sponsor badge from the README.
 
 ## [v2.0] - 2024-12-25
 
 ### **New Features**
-
 - Introduced **CLI Interface**:
-    - Added `cli.py` for command-line usage of the GSP algorithm.
-    - Supports input in JSON and CSV formats.
-    - Allows configuration of the `min_support` threshold via CLI arguments.
+  - Added `cli.py` for command-line usage of the GSP algorithm.
+  - Supports input in JSON and CSV formats.
+  - Allows configuration of the `min_support` threshold via CLI arguments.
 - Added **Parallel Processing for Support Calculation**:
-    - Optimized support calculation using multiprocessing for better performance on large datasets.
+  - Optimized support calculation using multiprocessing for better performance on large datasets.
 - Enhanced **Logging**:
-    - Configurable logs to monitor progress and debugging.
+  - Configurable logs to monitor progress and debugging.
 
 ### **Improved Documentation**
-
 - Comprehensive updates to the `README.md`:
-    - Detailed explanation of GSP with examples.
-    - Added "What is GSP?" and "Planned Features" sections.
-    - Expanded installation and usage guides.
+  - Detailed explanation of GSP with examples.
+  - Added "What is GSP?" and "Planned Features" sections.
+  - Expanded installation and usage guides.
 - Added `CONTRIBUTING.md`:
-    - Clear guidelines for contributing code, documentation, and bug reports.
+  - Clear guidelines for contributing code, documentation, and bug reports.
 - Added badges for PyPI, code coverage, and security metrics.
 
 ### **Testing**
-
 - Added a robust test suite:
-    - Moved test cases to the `gsppy/tests` directory.
-    - Comprehensive unit tests for the CLI, GSP algorithm, and utility functions.
-    - Tests include edge cases, large datasets, and benchmarking.
+  - Moved test cases to the `gsppy/tests` directory.
+  - Comprehensive unit tests for the CLI, GSP algorithm, and utility functions.
+  - Tests include edge cases, large datasets, and benchmarking.
 
 ### **Utilities**
-
 - Introduced helper utilities for GSP:
-    - `split_into_batches`: Efficiently split candidates into manageable batches.
-    - `is_subsequence_in_list`: Improved subsequence matching logic.
+  - `split_into_batches`: Efficiently split candidates into manageable batches.
+  - `is_subsequence_in_list`: Improved subsequence matching logic.
 
 ### **Workflow and Configuration**
-
 - Integrated GitHub Actions workflows:
-    - Added workflows for testing, linting, and publishing to PyPI.
+  - Added workflows for testing, linting, and publishing to PyPI.
 - Added `.editorconfig` for consistent code formatting.
 - Integrated Dependabot for automated dependency updates.
 
@@ -52,32 +79,26 @@
 ## **[v1.1]** - 2020-05-01
 
 ### **Features**
-
 - Initial release of the **GSP-Py** library.
 - Basic implementation of the Generalized Sequential Pattern (GSP) algorithm:
-    - Single-threaded support calculation.
-    - Basic candidate generation and pruning.
+  - Single-threaded support calculation.
+  - Basic candidate generation and pruning.
 - Test cases for supermarket transactions.
 
 ### **Documentation**
-
 - Basic `README.md` with:
-    - Installation instructions.
-    - Example usage of the GSP algorithm.
+  - Installation instructions.
+  - Example usage of the GSP algorithm.
 
 ### **Miscellaneous**
-
 - Added setup files (`setup.py`, `setup.cfg`) for publishing to PyPI.
 - Licensed under MIT.
 
 ---
 
 ## **Summary of Changes**
 
-### From v1.1 to v2.0
-
-- **Performance**: Introduced parallel processing for faster support calculation.
-- **Usability**: Added CLI and extensive logging.
-- **Documentation**: Improved and expanded documentation.
-- **Testing**: Robust test suite added.
-- **Workflow**: Automated CI/CD workflows integrated.
+### From v2.0 to v2.1.0
+- Enhanced compatibility with earlier Python versions (3.8+).
+- Improved testing and dependency management.
+- Updated workflows and documentation for broader support and clarity.
diff --git a/CITATION.cff b/CITATION.cff
@@ -6,7 +6,7 @@ authors:
     given-names: "Jackson Antonio do"
     orcid: "https://orcid.org/10.5281/zenodo.3333987"
 year: 2024
-version: "2.0.1"
+version: "2.1.0"
 doi: "10.5281/zenodo.3333987"
 url: "https://github.com/jacksonpradolima/gsp-py"
 repository-code: "https://github.com/jacksonpradolima/gsp-py"
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 [![PyPI License](https://img.shields.io/pypi/l/gsppy.svg?style=flat-square)]()
-![](https://img.shields.io/badge/python-3.11+-blue.svg)
+![](https://img.shields.io/badge/python-3.8+-blue.svg)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3333987.svg)](https://doi.org/10.5281/zenodo.3333987)
 
 [![PyPI Downloads](https://img.shields.io/pypi/dm/gsppy.svg?style=flat-square)](https://pypi.org/project/gsppy/)
@@ -14,6 +14,9 @@
 **GSP-Py**: A Python-powered library to mine sequential patterns in large datasets, based on the robust **Generalized
 Sequence Pattern (GSP)** algorithm. Ideal for market basket analysis, temporal mining, and user journey discovery.
 
+> [!IMPORTANT]
+> GSP-Py is compatible with Python 3.8 and later versions!
+
 ---
 
 ## 📚 Table of Contents
@@ -62,10 +65,6 @@ sudo apt install python3
 
 For package dependencies of GSP-Py, they will automatically be installed when using `pip`.
 
-> [!IMPORTANT]
-> GSP-Py is compatible with Python 3.11 and later versions.
-> We didn't test it on Python 3.10 or earlier versions.
-
 ---
 
 ## 🚀 Installation
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -3,3 +3,4 @@ pylint==3.3.3
 pytest==8.3.4
 pytest-benchmark==5.1.0
 pytest-cov==6.0.0
+tox==4.23.2
diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +0,0 @@
-pylint==3.3.3
-pytest==8.3.4
-pytest-benchmark==5.1.0
-pytest-cov==6.0.0
diff --git a/setup.py b/setup.py
@@ -16,7 +16,7 @@
 
 setup(
     name='gsppy',
-    version='2.0.1',
+    version='2.1.0',
     description='GSP (Generalized Sequence Pattern) algorithm in Python',
     long_description=README,
     long_description_content_type='text/markdown',
@@ -27,7 +27,7 @@
     license='MIT',
     url='https://github.com/jacksonpradolima/gsp-py',
     packages=find_packages(exclude=['test_']),
-    python_requires='>=3.11',
+    python_requires='>=3.8',
     install_requires=[
         # No additional runtime dependencies are required since the project uses standard library modules only.
     ],
@@ -40,6 +40,9 @@
         ],
     },
     classifiers=[
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
         'Programming Language :: Python :: 3.11',
         'Operating System :: OS Independent',
         'License :: OSI Approved :: MIT License',
diff --git a/tox.ini b/tox.ini
@@ -0,0 +1,8 @@
+[tox]
+envlist = py38, py39, py310, py311
+
+[testenv]
+deps =
+    pytest
+    pytest-benchmark
+commands = pytest

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +3.6.15
 +3.7.12
 +3.8.10
 +3.9.16
 +3.10.12
 +3.11.4