From 3f263deae9f74cff98a6559d67171fec949c9ed9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ricardo=20Monta=C3=B1ana?= Date: Tue, 13 Dec 2022 11:54:33 +0100 Subject: [PATCH] Add codacy badge and complete restructure --- .github/workflows/codeql-analysis.yml | 46 --------------------------- .github/workflows/main.yml | 2 +- Makefile | 2 +- README.md | 2 ++ pyproject.toml | 4 +++ src/fimdlp/__init__.py | 5 +++ src/fimdlp/mdlp.py | 8 ++--- src/fimdlp/tests/FImdlp_test.py | 5 +++ src/fimdlp/tests/__init__.py | 2 -- 9 files changed, 22 insertions(+), 54 deletions(-) delete mode 100644 .github/workflows/codeql-analysis.yml diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml deleted file mode 100644 index dd3c009..0000000 --- a/.github/workflows/codeql-analysis.yml +++ /dev/null @@ -1,46 +0,0 @@ -name: "CodeQL" - -on: - push: - branches: [master] - pull_request: - # The branches below must be a subset of the branches above - branches: [master] - schedule: - - cron: "16 17 * * 3" - -jobs: - analyze: - name: Analyze - runs-on: ubuntu-latest - - strategy: - fail-fast: false - matrix: - language: ["python"] - - steps: - - name: Checkout repository - uses: actions/checkout@v2 - - # Initializes the CodeQL tools for scanning. - - name: Initialize CodeQL - uses: github/codeql-action/init@v1 - with: - languages: ${{ matrix.language }} - - - name: Autobuild - uses: github/codeql-action/autobuild@v1 - - # ℹī¸ Command-line programs to run using the OS shell. - # 📚 https://git.io/JvXDl - - # ✏ī¸ If the Autobuild fails above, remove it and uncomment the following three lines - # and modify them (or add more) to build your code if your project - # uses a compiled language - - - run: | - make install - - - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v1 diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 97d1f94..4c5de3f 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -32,7 +32,7 @@ jobs: - name: Lint run: | black --check --diff src - flake8 --count src + flake8 --count --per-file-ignores="__init__.py:F401" src - name: Tests run: | coverage run -m unittest discover -v - s src diff --git a/Makefile b/Makefile index 1b937e5..3e37057 100644 --- a/Makefile +++ b/Makefile @@ -17,7 +17,7 @@ coverage: lint: ## Lint and static-check black src - flake8 src + flake8 --per-file-ignores="__init__.py:F401" src push: ## Push code with tags git push && git push --tags diff --git a/README.md b/README.md index 3c42245..0d92dd7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # FImdlp +[![Codacy Badge](https://app.codacy.com/project/badge/Grade/8b4d784fee13401588aa8c06532a2f6d)](https://www.codacy.com/gh/Doctorado-ML/FImdlp/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Doctorado-ML/FImdlp&utm_campaign=Badge_Grade) + Discretization algorithm based on the paper by Usama M. Fayyad and Keki B. Irani ``` diff --git a/pyproject.toml b/pyproject.toml index 2c9a17e..8e166b8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -55,3 +55,7 @@ exclude = ''' | dist )/ ''' +[tool.flake8] +per-file-ignores = ['__init__.py:F401'] +max-line-length = 79 +count = true diff --git a/src/fimdlp/__init__.py b/src/fimdlp/__init__.py index d1675e1..3a99d3b 100644 --- a/src/fimdlp/__init__.py +++ b/src/fimdlp/__init__.py @@ -1,3 +1,8 @@ from ._version import __version__ + +def version(): + return __version__ + + all = ["FImdlp", "__version__"] diff --git a/src/fimdlp/mdlp.py b/src/fimdlp/mdlp.py index ab82dc6..b8f11e7 100644 --- a/src/fimdlp/mdlp.py +++ b/src/fimdlp/mdlp.py @@ -16,8 +16,8 @@ class FImdlp(TransformerMixin, BaseEstimator): Parameters ---------- n_jobs : int, default=-1 - The number of jobs to run in parallel. :meth:`fit` and - :meth:`transform`, are parallelized over the features. ``-1`` means + The number of jobs to run in parallel. :meth:`fit` and + :meth:`transform`, are parallelized over the features. ``-1`` means using all cores available. Attributes @@ -28,9 +28,9 @@ class FImdlp(TransformerMixin, BaseEstimator): The list of discretizers, one for each feature. cut_points_ : list The list of cut points for each feature. - X_ : array + X_ : array the samples used to fit, shape (n_samples, n_features) - y_ : array + y_ : array the labels used to fit, shape (n_samples,) features_ : list the list of features to be discretized diff --git a/src/fimdlp/tests/FImdlp_test.py b/src/fimdlp/tests/FImdlp_test.py index 73cb564..7eb282b 100644 --- a/src/fimdlp/tests/FImdlp_test.py +++ b/src/fimdlp/tests/FImdlp_test.py @@ -3,9 +3,14 @@ import sklearn from sklearn.datasets import load_iris import numpy as np from ..mdlp import FImdlp +from .. import version +from .._version import __version__ class FImdlpTest(unittest.TestCase): + def test_version(self): + self.assertEqual(version(), __version__) + def test_init(self): clf = FImdlp() self.assertEqual(-1, clf.n_jobs) diff --git a/src/fimdlp/tests/__init__.py b/src/fimdlp/tests/__init__.py index cac328b..8feb203 100644 --- a/src/fimdlp/tests/__init__.py +++ b/src/fimdlp/tests/__init__.py @@ -1,3 +1 @@ from .FImdlp_test import FImdlpTest - -all = ["FImdlpTest"]