diff --git a/.copier-answers.yml b/.copier-answers.yml new file mode 100644 index 0000000..a5e1ac4 --- /dev/null +++ b/.copier-answers.yml @@ -0,0 +1,9 @@ +# Changes here will be overwritten by Copier +_commit: HEAD +_src_path: https://github.com/Ingenjorsarbete-For-Klimatet/ifk-python-template.git +author: IFK +email: info@ingenjorsarbeteforklimatet.se +module_name: test_module +package_name: test_package +project_description: Unspecified. +project_name: ifk-testing diff --git a/.github/workflows/github-action-build.yaml b/.github/workflows/github-action-build.yaml new file mode 100644 index 0000000..eb0a570 --- /dev/null +++ b/.github/workflows/github-action-build.yaml @@ -0,0 +1,42 @@ +name: Build +on: [push] +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.9", "3.10", "3.11", "3.12"] + + steps: + - uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Recopy + run: | + pip install copier + copier recopy $project --force + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -e ".[test]" + - name: Test with pytest + run: | + python -m pytest --cov-report term-missing --cov=src tests + coverage json + - name: Export summary stats + run: | + export TOTAL=$(python -c "import json;print(json.load(open('coverage.json'))['totals']['percent_covered_display'])") + echo "total=$TOTAL" >> $GITHUB_ENV + - name: Coverage badge + uses: schneegans/dynamic-badges-action@v1.6.0 + with: + auth: ${{ secrets.BADGE_SECRET }} + gistID: 955d89d05ed9ca61fb3774bc68bbae33 + filename: ifk-python-template-coverage-badge.json + label: Coverage + message: ${{ env.total }}% + minColorRange: 50 + maxColorRange: 90 + valColorRange: ${{ env.total }} diff --git a/.github/workflows/github-action-docs.yaml b/.github/workflows/github-action-docs.yaml new file mode 100644 index 0000000..4332376 --- /dev/null +++ b/.github/workflows/github-action-docs.yaml @@ -0,0 +1,56 @@ +name: Deploy docs to GitHub Pages + +on: + push: + branches: ["SET_TO_MAIN"] + + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: "pages" + cancel-in-progress: true + +jobs: + build-docs: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.9"] + + steps: + - uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Recopy + run: | + pip install copier + copier recopy $project --force + - name: Setup Pages + uses: actions/configure-pages@v2 + - name: Install MkDocs + run: | + python -m pip install --upgrade pip + pip install ".[doc]" + - name: Build with MkDocs + run: | + mkdocs build -d _site + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + + deploy-docs: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build-docs + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1 diff --git a/.github/workflows/github-action-lint.yaml b/.github/workflows/github-action-lint.yaml new file mode 100644 index 0000000..d0a7386 --- /dev/null +++ b/.github/workflows/github-action-lint.yaml @@ -0,0 +1,29 @@ +name: Lint +on: [push] +jobs: + lint: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.9"] + + steps: + - uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Recopy + run: | + pip install copier + copier recopy $project --force + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -e ".[lint]" + - name: Lint with ruff + run: | + ruff check --output-format=github src tests + - name: Format with ruff + run: | + ruff format --check src tests diff --git a/.github/workflows/github-action-md-lint.yaml b/.github/workflows/github-action-md-lint.yaml new file mode 100644 index 0000000..cf72e39 --- /dev/null +++ b/.github/workflows/github-action-md-lint.yaml @@ -0,0 +1,21 @@ +name: Markdown Lint +on: [push] +jobs: + mdlint: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.9"] + + steps: + - uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Markdown lint + uses: nosborn/github-action-markdown-cli@v3.2.0 + with: + files: . + config_file: .markdownlint.yaml + ignore_files: README.md diff --git a/.github/workflows/github-action-type.yaml b/.github/workflows/github-action-type.yaml new file mode 100644 index 0000000..7d4f49c --- /dev/null +++ b/.github/workflows/github-action-type.yaml @@ -0,0 +1,31 @@ +name: Type +on: [push] +jobs: + type: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.9"] + + steps: + - uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Recopy + run: | + pip install copier + copier recopy $project --force + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -e ".[type]" + - name: Type checking with mypy + run: > + MYPYPATH=src + mypy + --namespace-packages + --explicit-package-bases + --allow-redefinition + src diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b1cb160 --- /dev/null +++ b/.gitignore @@ -0,0 +1,161 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000..8e3d5f0 --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,4 @@ +{ + "default": true, + "no-inline-html": false +} diff --git a/.markdownlintignore b/.markdownlintignore new file mode 100644 index 0000000..b43bf86 --- /dev/null +++ b/.markdownlintignore @@ -0,0 +1 @@ +README.md diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..3422fe7 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,23 @@ +repos: +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v2.3.0 + hooks: + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace +- repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.1.5 + hooks: + - id: ruff + types_or: [ python, pyi, jupyter ] + args: [ --fix ] + - id: ruff-format + types_or: [ python, pyi, jupyter ] +- repo: https://github.com/pre-commit/mirrors-mypy + rev: "586b4f0" + hooks: + - id: mypy +- repo: https://github.com/igorshubovych/markdownlint-cli + rev: v0.32.2 + hooks: + - id: markdownlint diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0542b31 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Ingenjörsarbete För Klimatet + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ff78b48 --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +

ifk-lantmateriet

+ +

+ + build + + + coverage + + + docs + + + lint + + + type + +

+ +

+ + Python: 3.9 - 3.12 + + + Testing framework: pytest + + + Linter and formatter: ruff + + + Type checker: mypy + +

+ +## Description + +Welcome to ifk-lantmateriet. + +## Configuration + +When you start a new project, apart from the obvious changes, +there are some details to consider. + +- Build workflow, follow the guide in [dynamic badges](https://github.com/Schneegans/dynamic-badges-action). +- To build docs, change `branch` in `github/workflows/github-action-docs.yaml` +from `["SET_TO_MAIN"]` to `["main"]`. You also need to activate Pages under repo +Settings/Pages. + +Install `copier` (install `pipx` through `pip`) as + +```bash +pipx install copier +``` + +and then do + +```bash +copier copy https://github.com/Ingenjorsarbete-For-Klimatet/ifk-python-template.git /path/to/project-name +``` + +Copier supports updating projects based on templates when the template updates. +See copier docs. \ No newline at end of file diff --git a/docs/assets/favicon.png b/docs/assets/favicon.png new file mode 100644 index 0000000..44ea633 Binary files /dev/null and b/docs/assets/favicon.png differ diff --git a/docs/assets/ifk_logo_black.png b/docs/assets/ifk_logo_black.png new file mode 100644 index 0000000..6f81d61 Binary files /dev/null and b/docs/assets/ifk_logo_black.png differ diff --git a/docs/assets/ifk_logo_white.png b/docs/assets/ifk_logo_white.png new file mode 100644 index 0000000..5a0816b Binary files /dev/null and b/docs/assets/ifk_logo_white.png differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..9824d2b --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ +# Welcome to ifk-lantmateriet + +Docs for ifk-lantmateriet. diff --git a/material/partials/copyright.html b/material/partials/copyright.html new file mode 100644 index 0000000..d05edfe --- /dev/null +++ b/material/partials/copyright.html @@ -0,0 +1,14 @@ +{#- +This file was automatically generated - do not edit +-#} +
+
+ Made by Ingenjörsarbete för Klimatet +
+ {% if not config.extra.generator == false %} + Made with + + Material for MkDocs + + {% endif %} +
diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..59ab8bb --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,37 @@ +site_name: ifk-lantmateriet +repo_url: https://github.com/Ingenjorsarbete-For-Klimatet/ifk-lantmateriet +site_author: Mladen Gibanica +site_url: https://ingenjorsarbete-for-klimatet.github.io/ifk-lantmateriet/ +repo_name: Ingenjorsarbete-For-Klimatet/ifk-lantmateriet + +nav: +- Home: index.md + +watch: +- src + +theme: + name: material + custom_dir: material + palette: + scheme: default + primary: black + accent: light green + language: en + icon: + repo: fontawesome/brands/git-alt + logo: assets/ifk_logo_white.png + favicon: assets/favicon.png + features: + - navigation.tabs + +plugins: +- search +- mkdocstrings + +markdown_extensions: + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences diff --git a/mypy.ini b/mypy.ini new file mode 100644 index 0000000..5284375 --- /dev/null +++ b/mypy.ini @@ -0,0 +1,4 @@ +[mypy] +exclude = (?x)( + ^src/smhi/smhi\.py$ + ) diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..d76e992 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,47 @@ +[build-system] +requires = ["setuptools", "setuptools-scm"] +build-backend = "setuptools.build_meta" + +[project] +name = "ifk-lantmateriet" +version = "0.1.0" +description = "Parse data from Lantmäteriet." +license = { text = "MIT" } +readme = "README.md" +authors = [ + { name = "Mladen Gibanica", email = "11275336+mgcth@users.noreply.github.com" }, +] +requires-python = ">=3.9" +dependencies = [] + +[project.optional-dependencies] +lint = [ + "ruff ~= 0.1", +] +type = ["mypy ~= 0.990", "types-requests ~= 2.28", "pandas-stubs ~= 1.5"] +test = ["pytest ~= 7.1", "coverage ~= 6.5", "pytest-cov ~= 4.0"] +doc = [ + "mkdocs ~= 1.4", + "mkdocs-material ~= 8.5", + "mkdocstrings[python] ~= 0.19", +] +dev = [ + "ifk-lantmateriet[lint]", + "ifk-lantmateriet[type]", + "ifk-lantmateriet[test]", + "ifk-lantmateriet[doc]", + "pre-commit ~= 2.20", +] + +[tool.setuptools.packages.find] +where = ["src"] +exclude = ["material"] + +[tool.ruff] +line-length = 88 +extend-include = ["*.ipynb"] + +[tool.ruff.lint] +select = ["E4", "E7", "E9", "W", "F", "B", "D", "I", "S"] +ignore = ["D203", "D213", "S101"] +unfixable = ["B", "S"] diff --git a/src/lantmateriet/geometry.py b/src/lantmateriet/geometry.py new file mode 100644 index 0000000..0fe38d0 --- /dev/null +++ b/src/lantmateriet/geometry.py @@ -0,0 +1,6 @@ +"""geometry module.""" + + +def temp(): + """Temporary function.""" + return True diff --git a/tests/test_unit.py b/tests/test_unit.py new file mode 100644 index 0000000..f0faffb --- /dev/null +++ b/tests/test_unit.py @@ -0,0 +1,7 @@ +"""Temporary unit test.""" +from lantmateriet.geometry import temp + + +def test_unit_temp(): + """Unit test of temp function.""" + assert temp() is True