-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Updated the .gitattributes * Updated the README.md * Updated the pyproject.toml * Updated .github/workflows/tests.yml * Updated .editorconfig
- Loading branch information
Showing
5 changed files
with
120 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,42 @@ | ||
| name: Tests | ||
|
|
||
| on: | ||
| workflow_dispatch: # Only enable manual runs for now | ||
| workflow_dispatch: # Only enable manual runs for now | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| strategy: | ||
| matrix: | ||
| # Define the Python versions to test against | ||
| python-version: [ "3.9", "3.10", "3.11" ] | ||
|
|
||
| steps: | ||
| - name: Checkout Repository | ||
| uses: actions/checkout@v2 | ||
|
|
||
| - name: Set Up Python ${{ matrix.python-version }} | ||
| uses: actions/setup-python@v2 | ||
| with: | ||
| python-version: ${{ matrix.python-version }} | ||
|
|
||
| # Install Poetry and Dependencies and run tests with coverage and upload test results and coverage reports as artifacts | ||
| - name: Install Poetry and Dependencies | ||
| run: | | ||
| pip install poetry | ||
| poetry install | ||
| - name: Run Tests with Coverage | ||
| run: | | ||
| poetry run pytest tests/ --doctest-modules --cov=src --cov-report xml --cov-report html \ | ||
| --junitxml=junit/test-results-${{ matrix.python-version }}.xml | ||
| continue-on-error: false | ||
|
|
||
| - name: Upload Test Results and Coverage Reports | ||
| uses: actions/upload-artifact@v2 | ||
| with: | ||
| name: test-results-and-coverage | ||
| path: | | ||
| junit/test-results-${{ matrix.python-version }}.xml | ||
| htmlcov/ | ||
| build: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| strategy: | ||
| matrix: | ||
| # Define the Python versions to test against | ||
| python-version: [ "3.10", "3.11" "3.12" "3.13" ] | ||
|
|
||
| steps: | ||
| - name: Checkout Repository | ||
| uses: actions/checkout@v2 | ||
|
|
||
| - name: Set Up Python ${{ matrix.python-version }} | ||
| uses: actions/setup-python@v2 | ||
| with: | ||
| python-version: ${{ matrix.python-version }} | ||
|
|
||
| # Install Poetry and Dependencies and run tests with coverage and upload test results and coverage reports as artifacts | ||
| - name: Install Poetry and Dependencies | ||
| run: | | ||
| pip install poetry | ||
| poetry install | ||
| - name: Run Tests with Coverage | ||
| run: | | ||
| poetry run pytest tests/ --doctest-modules --cov=src --cov-report xml --cov-report html \ | ||
| --junitxml=junit/test-results-${{ matrix.python-version }}.xml | ||
| continue-on-error: false | ||
|
|
||
| - name: Upload Test Results and Coverage Reports | ||
| uses: actions/upload-artifact@v2 | ||
| with: | ||
| name: test-results-and-coverage | ||
| path: | | ||
| junit/test-results-${{ matrix.python-version }}.xml | ||
| htmlcov/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,28 +3,92 @@ name = "template-python-project-repo" | |
| version = "0.1.0" | ||
| description = "A template for a data science or machine learning project in Python." | ||
| authors = ["Hassan Abedi <[email protected]>"] | ||
| maintainers = ["Hassan Abedi <[email protected]>"] | ||
| readme = "README.md" | ||
| packages = [{ include = "template_python_project_repo" }] | ||
| license = "MIT" | ||
| packages = [{ include = "src", from = "." }] | ||
|
|
||
| [tool.poetry.dependencies] | ||
| python = "^3.10" | ||
| pylint = "^3.0.3" | ||
|
|
||
| [tool.poetry.dev-dependencies] | ||
| poetry-dynamic-versioning = "^1.4.0" | ||
| pytest = "^8.0.1" | ||
| jupyter = "^1.0.0" | ||
| seaborn = "^0.13.2" | ||
| pandas = "^2.2.1" | ||
| pytest-cov = "^5.0.0" | ||
| pytest-mock = "^3.14.0" | ||
| mypy = "^1.11.1" | ||
| ruff = "^0.7.1" | ||
|
|
||
| [tool.poetry.scripts] | ||
| cli_script = "src.cli:main" | ||
|
|
||
| [build-system] | ||
| requires = ["poetry-core"] | ||
| build-backend = "poetry.core.masonry.api" | ||
|
|
||
| [tool.pytest.ini_options] | ||
| pythonpath = [".", "bin", "src"] | ||
| pythonpath = [".", "src", 'bin'] | ||
|
|
||
| [tool.mypy] | ||
| python_version = "3.10" | ||
| ignore_missing_imports = true | ||
| disallow_untyped_calls = true | ||
| strict_optional = true | ||
| warn_redundant_casts = true | ||
|
|
||
| [tool.poetry-dynamic-versioning] | ||
| enable = true | ||
| vcs = "git" | ||
| versioning = "semver" # Semantic Versioning | ||
|
|
||
| # Ruff configuration | ||
| [tool.ruff] | ||
| exclude = [ | ||
| ".bzr", | ||
| ".direnv", | ||
| ".eggs", | ||
| ".git", | ||
| ".git-rewrite", | ||
| ".hg", | ||
| ".mypy_cache", | ||
| ".nox", | ||
| ".pants.d", | ||
| ".pytype", | ||
| ".ruff_cache", | ||
| ".svn", | ||
| ".tox", | ||
| ".venv", | ||
| "__pypackages__", | ||
| "_build", | ||
| "buck-out", | ||
| "build", | ||
| "dist", | ||
| "node_modules", | ||
| "venv" | ||
| ] | ||
| line-length = 100 | ||
| indent-width = 4 | ||
| src = ["mongo_analyser", "tests"] | ||
| target-version = "py311" | ||
|
|
||
| [tool.ruff.lint] | ||
| select = ["ANN", "D", "E", "F", "I"] | ||
| ignore = [ | ||
| "ANN101", # Don't annotate self | ||
| "ANN102" # Don't annotate cls | ||
| ] | ||
| fixable = ["ALL"] | ||
| unfixable = [] | ||
| dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$" | ||
|
|
||
| [tool.ruff.format] | ||
| quote-style = "double" | ||
| indent-style = "space" | ||
| skip-magic-trailing-comma = false | ||
| line-ending = "auto" | ||
|
|
||
| [tool.ruff.lint.pydocstyle] | ||
| convention = "google" | ||
|
|
||
| [tool.ruff.lint.per-file-ignores] | ||
| "tests/**/*.py" = [] | ||