diff --git a/.github/_project-dependabot.yml b/.github/_project-dependabot.yml deleted file mode 100644 index 6ed6e57..0000000 --- a/.github/_project-dependabot.yml +++ /dev/null @@ -1,12 +0,0 @@ -version: 2 -updates: - - package-ecosystem: pip - directory: / - schedule: - interval: monthly - versioning-strategy: increase-if-necessary - commit-message: - prefix: build - include: scope - assignees: - - "lwjohnst86" diff --git a/.github/sync.yml b/.github/sync.yml deleted file mode 100644 index fe133dd..0000000 --- a/.github/sync.yml +++ /dev/null @@ -1,46 +0,0 @@ -group: - - files: - # General - - source: .github/CODEOWNERS - dest: .github/CODEOWNERS - - source: .pre-commit-config.yaml - dest: .pre-commit-config.yaml - - source: .editorconfig - dest: .editorconfig - - source: .gitignore - dest: .gitignore - - source: justfile - dest: justfile - - source: .cz.toml - dest: .cz.toml - - source: pytest.ini - dest: pytest.ini - - source: ruff.toml - dest: ruff.toml - - source: LICENSE.md - dest: LICENSE.md - - source: .github/pull_request_template.md - dest: .github/pull_request_template.md - - source: mypy.ini - dest: mypy.ini - - # Actions - - source: .github/workflows/add-to-project.yml - dest: .github/workflows/add-to-project.yml - - source: .github/workflows/build-package.yml - dest: .github/workflows/build-package.yml - - source: .github/workflows/build-website.yml - dest: .github/workflows/build-website.yml - - source: .github/workflows/release-package.yml - dest: .github/workflows/release-package.yml - - source: .github/workflows/scorecards.yml - dest: .github/workflows/scorecards.yml - - source: .github/_project-dependabot.yml - dest: .github/dependabot.yml - - # VSCode Settings - - source: .vscode/ - dest: .vscode/ - deleteOrphaned: true - repos: | - seedcase-project/seedcase-sprout diff --git a/.github/workflows/build-package.yml b/.github/workflows/build-package.yml deleted file mode 100644 index 1f8741e..0000000 --- a/.github/workflows/build-package.yml +++ /dev/null @@ -1,19 +0,0 @@ -name: Build package - -on: - pull_request: - branches: - - main - push: - branches: - - main - -# Limit token permissions for security -permissions: read-all - -jobs: - build: - uses: seedcase-project/.github/.github/workflows/reusable-build-python.yml@main - # Permissions needed for pushing to the coverage branch. - permissions: - contents: write diff --git a/.github/workflows/release-package.yml b/.github/workflows/release-package.yml deleted file mode 100644 index 2e50423..0000000 --- a/.github/workflows/release-package.yml +++ /dev/null @@ -1,61 +0,0 @@ -name: Release package - -on: - push: - branches: - - main - -# Limit token permissions for security -permissions: read-all - -jobs: - release: - # This job outputs env variables `previous_version` and `current_version`. - # Only give permissions for this job. - permissions: - contents: write - uses: seedcase-project/.github/.github/workflows/reusable-release-project.yml@main - with: - app-id: ${{ vars.UPDATE_VERSION_APP_ID }} - secrets: - update-version-gh-token: ${{ secrets.UPDATE_VERSION_TOKEN }} - - pypi-publish: - name: Publish to PyPI - runs-on: ubuntu-latest - # Only give permissions for this job. - permissions: - # IMPORTANT: mandatory for trusted publishing. - id-token: write - environment: - name: pypi - needs: - - release - if: ${{ needs.release.outputs.previous_version != needs.release.outputs.current_version }} - steps: - - name: Harden the runner (Audit all outbound calls) - uses: step-security/harden-runner@ec9f2d5744a09debf3a187a3f4f675c53b671911 # v2.13.0 - with: - egress-policy: audit - - - name: Checkout - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 - with: - # Need to explicitly get the current version, otherwise it defaults to current commit - # (which is not the same as the release/version commit). - ref: ${{ needs.release.outputs.current_version }} - - # This workflow and the publish workflows are based on: - # - https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/ - # - https://www.andrlik.org/dispatches/til-use-uv-for-build-and-publish-github-actions/ - # - https://github.com/astral-sh/trusted-publishing-examples - - name: Set up uv - uses: astral-sh/setup-uv@e92bafb6253dcd438e0484186d7669ea7a8ca1cc # v6.4.3 - - - name: Build distributions - # Builds dists from source and stores them in the dist/ directory. - run: uv build - - - name: Publish 📦 to PyPI - # Only publish if the option is explicitly set in the calling workflow. - run: uv publish --trusted-publishing always diff --git a/.github/workflows/release-project.yml b/.github/workflows/release-project.yml new file mode 100644 index 0000000..75d255b --- /dev/null +++ b/.github/workflows/release-project.yml @@ -0,0 +1,21 @@ +name: Release project + +on: + push: + branches: + - main + +# Limit token permissions for security +permissions: read-all + +jobs: + release: + # This job outputs env variables `previous_version` and `current_version`. + # Only give permissions for this job. + permissions: + contents: write + uses: seedcase-project/.github/.github/workflows/reusable-release-project.yml@main + with: + app-id: ${{ vars.UPDATE_VERSION_APP_ID }} + secrets: + update-version-gh-token: ${{ secrets.UPDATE_VERSION_TOKEN }} diff --git a/.github/workflows/scorecards.yml b/.github/workflows/scorecards.yml deleted file mode 100644 index 68827d2..0000000 --- a/.github/workflows/scorecards.yml +++ /dev/null @@ -1,28 +0,0 @@ -# This workflow uses actions that are not certified by GitHub. They are provided -# by a third-party and are governed by separate terms of service, privacy -# policy, and support documentation. -name: "Security: Scorecard" -on: - # For Branch-Protection check. Only the default branch is supported. See - # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection - branch_protection_rule: - # To guarantee Maintained check is occasionally updated. See - # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained - schedule: - - cron: '20 7 * * 2' - push: - branches: - - main - -# Declare default permissions as read only. -permissions: read-all - -jobs: - analysis: - name: Analysis - uses: seedcase-project/.github/.github/workflows/reusable-scorecards.yml@main - permissions: - # Needed to upload the results to code-scanning dashboard. - security-events: write - # Needed to publish results and get a badge (see publish_results below). - id-token: write diff --git a/.github/workflows/sync-files.yml b/.github/workflows/sync-files.yml deleted file mode 100644 index 04d93ca..0000000 --- a/.github/workflows/sync-files.yml +++ /dev/null @@ -1,17 +0,0 @@ -name: Sync files across repos -on: - push: - branches: - - main - workflow_dispatch: - -# Limit token permissions for security -permissions: read-all - -jobs: - sync: - uses: seedcase-project/.github/.github/workflows/reusable-sync-files.yml@main - with: - app-id: ${{ vars.SYNC_FILES_APP_ID }} - secrets: - sync-files-token: ${{ secrets.SYNC_FILES_TOKEN }} diff --git a/.python-version b/.python-version deleted file mode 100644 index e4fba21..0000000 --- a/.python-version +++ /dev/null @@ -1 +0,0 @@ -3.12 diff --git a/.vscode/google-notypes.mustache b/.vscode/google-notypes.mustache deleted file mode 100644 index 55477fa..0000000 --- a/.vscode/google-notypes.mustache +++ /dev/null @@ -1,41 +0,0 @@ -{{! Copied from https://github.com/NilsJPWerner/autoDocstring/blob/master/src/docstring/templates/google-notypes.mustache with some edits }} -{{! Google Docstring Template without Types for Args, Returns or Yields }} -{{summaryPlaceholder}}. - -{{extendedSummaryPlaceholder}} -{{#parametersExist}} - -Args: -{{#args}} - {{var}}: {{descriptionPlaceholder}}. -{{/args}} -{{#kwargs}} - {{var}}: {{descriptionPlaceholder}}. Defaults to {{&default}}. -{{/kwargs}} -{{/parametersExist}} -{{#returnsExist}} - -Returns: -{{#returns}} - {{descriptionPlaceholder}}. -{{/returns}} -{{/returnsExist}} -{{#exceptionsExist}} - -Raises: -{{#exceptions}} - {{type}}: {{descriptionPlaceholder}}. -{{/exceptions}} -{{/exceptionsExist}} -{{#yieldsExist}} - -Yields: -{{#yields}} - {{descriptionPlaceholder}}. -{{/yields}} -{{/yieldsExist}} - -Examples: - ```{python} - {{descriptionPlaceholder}} - ``` diff --git a/.vscode/launch.json b/.vscode/launch.json deleted file mode 100644 index 37af1fd..0000000 --- a/.vscode/launch.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - // Use IntelliSense to learn about possible attributes. - // Hover to view descriptions of existing attributes. - // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 - "version": "0.2.0", - "configurations": [ - { - "name": "test-debugger", - "type": "debugpy", - "request": "launch", - "program": "${file}", - "purpose": [ - "debug-test" - ], - "console": "integratedTerminal", - "justMyCode": false - } - ] -} diff --git a/.vscode/python.code-snippets b/.vscode/python.code-snippets deleted file mode 100644 index 237cf88..0000000 --- a/.vscode/python.code-snippets +++ /dev/null @@ -1,31 +0,0 @@ -{ - // Place your snippets for python here. Each snippet is defined under a snippet name and has a prefix, body and - // description. The prefix is what is used to trigger the snippet and the body will be expanded and inserted. Possible variables are: - // $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders. Placeholders with the - // same ids are connected. - // Example: - // "Print to console": { - // "prefix": "log", - // "body": [ - // "console.log('$1');", - // "$2" - // ], - // "description": "Log output to console" - // } - "Insert a Python test": { - "prefix": "test-gwt", - "body": [ - "def test_$1():", - " # Given", - " $2", - " ", - " # When", - " $3", - " ", - " # Then", - " $4", - "", - ], - "description": "Create Given-When-Then test" - } -} diff --git a/docs/design/index.qmd b/docs/design/index.qmd deleted file mode 100644 index e69de29..0000000 diff --git a/docs/guide/index.qmd b/docs/guide/index.qmd deleted file mode 100644 index e69de29..0000000 diff --git a/docs/includes/_wip.qmd b/docs/includes/_wip.qmd deleted file mode 100644 index 0e40629..0000000 --- a/docs/includes/_wip.qmd +++ /dev/null @@ -1,4 +0,0 @@ -::: {.callout-warning appearance="default" icon="true"} -🚧 This section is still in active development and is subject to changes -🚧 -::: diff --git a/mypy.ini b/mypy.ini deleted file mode 100644 index f6c48ee..0000000 --- a/mypy.ini +++ /dev/null @@ -1,9 +0,0 @@ -[mypy] -python_version = 3.12 -strict = True - -[mypy-quartodoc.*] -ignore_missing_imports = True - -[mypy-tests.*] -disallow_untyped_defs = False diff --git a/pyproject.toml b/pyproject.toml deleted file mode 100644 index 415bf77..0000000 --- a/pyproject.toml +++ /dev/null @@ -1,41 +0,0 @@ -[project] -name = "template-python-package" -version = "0.1.0" -description = "Template Python Package" -authors = [ - {name = "Luke W. Johnston", email = "lwjohnst@gmail.com" }, - {name = "Kristiane Beicher", email = "kris.beicher@clin.au.dk" }, - {name = "Signe Kirk Brødbæk", email = "signekb@clin.au.dk" }, - {name = "Marton Vago", email = "marton.vago95@gmail.com" }, -] -maintainers = [ - {name = "Luke W. Johnston", email = "lwjohnst@gmail.com" }, - {name = "Kristiane Beicher", email = "kris.beicher@clin.au.dk" }, - {name = "Signe Kirk Brødbæk", email = "signekb@clin.au.dk" }, - {name = "Marton Vago", email = "marton.vago95@gmail.com" }, -] -readme = "README.md" -license = "MIT" -license-files = ["LICENSE.md"] -requires-python = ">=3.12" -dependencies = [] - -# TODO: Update these -[project.urls] -homepage = "https://PROJECT.seedcase-project.org" -repository = "https://github.com/seedcase-project/REPO" -changelog = "https://github.com/seedcase-project/REPO/blob/main/CHANGELOG.md" -issues = "https://github.com/seedcase-project/REPO/issues" - - -[build-system] -requires = ["hatchling"] -build-backend = "hatchling.build" - -[tool.pytest.ini_options] -addopts = [ - # A short traceback mode to make it easier to view - "--tb=short", - # Use the `src/` package - "--import-mode=importlib", -] diff --git a/pytest.ini b/pytest.ini deleted file mode 100644 index 5b84f15..0000000 --- a/pytest.ini +++ /dev/null @@ -1,8 +0,0 @@ -[pytest] -# - A short traceback (tb) mode to make it easier to view -# - Use the `src/` package (importlib) -# - Use code coverage on the `src/` package -# - If tests fail, do not generate coverage report -# - Create the coverage report in XML (for badge), terminal, and HTML -# - Trigger failure if below 90% code coverage -addopts = --tb=short --import-mode=importlib --cov=src --no-cov-on-fail --cov-report=term --cov-report=xml --cov-report=html --cov-fail-under=90 diff --git a/ruff.toml b/ruff.toml deleted file mode 100644 index 9171953..0000000 --- a/ruff.toml +++ /dev/null @@ -1,26 +0,0 @@ -# Support Python 3.12+ -target-version = "py312" - -# In addition to the default formatters/linters, add these as well. -[lint] -extend-select = [ - # Add the `line-too-long` rule to the enforced rule set. - "E501", - # Add rule that all functions have docstrings. - "D", - # Add isort to list. - "I" -] -# Ignore missing docstring at the top of files -ignore = ["D100"] - -[lint.pydocstyle] -convention = "google" - -[format] -docstring-code-format = true - -[lint.per-file-ignores] -# ignore "Module imported but unused" error in all init files -"__init__.py" = ["F401"] -"**/tests/*" = ["D"] diff --git a/src/PACKAGE-NAME/__init__.py b/src/PACKAGE-NAME/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/tests/__init__.py b/tests/__init__.py deleted file mode 100644 index 8e07441..0000000 --- a/tests/__init__.py +++ /dev/null @@ -1 +0,0 @@ -"""Module containing all tests."""