fmu-settings 0.0.1__tar.gz

fmu_settings-0.0.1/.coveragerc

@@ -0,0 +1,4 @@
+[report]
+exclude_also =
+    ; Ignore type checking blocks
+    if TYPE_CHECKING:

fmu_settings-0.0.1/.github/pull_request_template.md

@@ -0,0 +1,18 @@
+Resolves #issue
+
+Briefly describe changes here, e.g. "Added a precise description about the
+changes made to the code, and what the PR is solving."
+
+## Checklist
+
+- [ ] Tests added (if not, comment why)
+- [ ] Test coverage equal or up from main (run pytest with `--cov=src/ --cov-report term-missing`)
+- [ ] If not squash merging, every commit passes tests
+- [ ] Appropriate [commit prefix](https://upgraded-funicular-eywe4gy.pages.github.io/developing/#commit-prefixes) and precise commit message used
+- [ ] All debug prints and unnecessary comments removed
+- [ ] Docstrings are correct and updated
+- [ ] Documentation is updated, if necessary
+- [ ] Latest main rebased/merged into branch
+- [ ] Added comments on this PR where appropriate to help reviewers
+- [ ] Moved issue status on project board
+- [ ] Checked the boxes in this checklist ✅

fmu_settings-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,58 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  release:
+    types:
+      - published
+  schedule:
+    # Run nightly to check that tests are working with latest dependencies
+    - cron: "0 0 * * *"
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+
+    steps:
+      - name: Checkout commit locally
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install with dependencies
+        if: ${{ always() }}
+        run: |
+          pip install -U pip
+          pip install -e ".[dev]"
+
+      - name: List all installed packages
+        run: pip freeze
+
+      - name: Ruff check
+        if: ${{ always() }}
+        run: ruff check
+
+      - name: Ruff format
+        if: ${{ always() }}
+        run: ruff format --check
+
+      - name: Check typing with mypy
+        if: ${{ always() }}
+        run: mypy src tests
+
+      - name: Run tests
+        if: ${{ always() }}
+        run: pytest -n auto tests --cov=src/ --cov-report term-missing

fmu_settings-0.0.1/.github/workflows/codeql.yml

@@ -0,0 +1,43 @@
+name: CodeQL
+
+on:
+  push:
+    branches: [main, "version-*"]
+  pull_request:
+    branches: [main, "version-*"]
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      security-events: write
+      packages: read
+      actions: read
+      contents: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - language: actions
+            build-mode: none
+          - language: python
+            build-mode: none
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: ${{ matrix.language }}
+          build-mode: ${{ matrix.build-mode }}
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3
+        with:
+          category: "/language:${{matrix.language}}"

fmu_settings-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  pypi-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/fmu-settings
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python 3.12
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.12
+
+    - name: Install build dependencies
+      run: |
+        pip install -U pip
+        pip install build
+
+    - name: Build distributions
+      run: python -m build
+
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

fmu_settings-0.0.1/.gitignore

@@ -0,0 +1,98 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+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/
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# vscode
+.vscode/
+
+# setuptools_scm version
+_version.py
+.mypy_cache/

fmu_settings-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing
+
+This document contains information for contributing to this project.
+All contributions are welcome!
+
+## Developing
+
+Clone and install into a virtual environment.
+
+```sh
+git clone git@github.com:equinor/fmu-settings.git
+cd fmu-settings
+# Create or source virtual/Komodo env
+pip install -U pip
+pip install -e ".[dev]"
+# Make a feature branch for your changes
+git checkout -b some-feature-branch
+```
+
+Run the tests with
+
+```sh
+pytest -n auto tests
+```
+
+Ensure your changes will pass the various linters before making a pull
+request. It is expected that all code will be typed and validated with
+mypy.
+
+```sh
+ruff check
+ruff format --check
+mypy src tests
+```