Merge branch 'main' into dependabot/pip/dot-github/workflows/workflow…

…s-dependencies-9615ce233e

.cruft.json

@@ -1,7 +1,7 @@
 {
   "template": "https://github.com/statisticsnorway/ssb-pypitemplate.git",
-  "commit": "be07b1714e102b263e86c5f6f5578af4db38a03e",
-  "checkout": null,
+  "commit": "e6f0ca2794354d16838cf36d97bee2f9f70d3142",
+  "checkout": "2024.9.10",
   "context": {
     "cookiecutter": {
       "project_name": "ssb-konjunk",

.github/workflows/docs.yml

@@ -34,7 +34,7 @@ jobs:
           poetry --version
 
       - name: Set up Python
-        uses: actions/setup-python@v5.1.0
+        uses: actions/setup-python@v5.2.0
         with:
           python-version: "3.12"
           cache: "poetry"

.github/workflows/release.yml

@@ -21,7 +21,7 @@ jobs:
           fetch-depth: 2
 
       - name: Set up Python
-        uses: actions/setup-python@v5.1.0
+        uses: actions/setup-python@v5.2.0
         with:
           python-version: "3.12"
 
@@ -61,11 +61,11 @@ jobs:
 
       - name: Publish package on PyPI
         if: steps.check-version.outputs.tag
-        uses: pypa/gh-action-pypi-publish@v1.8.14
+        uses: pypa/gh-action-pypi-publish@v1.10.1
 
       - name: Publish package on TestPyPI
         if: (!steps.check-version.outputs.tag)
-        uses: pypa/gh-action-pypi-publish@v1.8.14
+        uses: pypa/gh-action-pypi-publish@v1.10.1
         with:
           repository-url: https://test.pypi.org/legacy/
 

.github/workflows/tests.yml

@@ -38,7 +38,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python }}
-        uses: actions/setup-python@v5.1.0
+        uses: actions/setup-python@v5.2.0
         with:
           python-version: ${{ matrix.python }}
 
@@ -102,6 +102,7 @@ jobs:
         with:
           name: coverage-data-${{ matrix.os }}-${{ matrix.python }}
           path: ".coverage.*"
+          include-hidden-files: true
 
       - name: Upload documentation
         if: matrix.session == 'docs-build'
@@ -120,7 +121,7 @@ jobs:
           fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
 
       - name: Set up Python
-        uses: actions/setup-python@v5.1.0
+        uses: actions/setup-python@v5.2.0
         with:
           python-version: "3.12"
 
@@ -167,4 +168,4 @@ jobs:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
         # No need to run SonarCloud analysis if dependabot update or token not defined
         if: env.SONAR_TOKEN != '' && (github.actor != 'dependabot[bot]')
-        uses: SonarSource/sonarcloud-github-action@v2.1.1
+        uses: SonarSource/sonarcloud-github-action@v3.0.0

.gitignore

@@ -15,6 +15,11 @@
 *.xlsx
 *.zip
 
+# Notebooks shall be stored in .py or .R-format.
+# See https://adr.ssb.no/0020-lagringsformat-for-jupyter-notebooks/
+*.ipynb
+
+
 # The section below is from the GitHub .gitignore template for Python:
 # https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
 
@@ -204,18 +209,7 @@ rsconnect/
 
 # ignore poetry in .config
 .poetry/**
-/.python-version
-/.pytype/
-/docs/_build/
-
-# Visual Studio Code
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-!.vscode/*.code-snippets
-# Local History for Visual Studio Code
-.history/
-# Built Visual Studio Code Extensions
-*.vsix
+
+# Blaise specific ignores
+*.bdix
+*.bdbx

docs/reference.md

@@ -16,10 +16,18 @@ ssb\_konjunk package
 ====================
 
 
-ssb\_konjunk.functions module
------------------------------
+ssb\_konjunk.data\_formating module
+-----------------------------------
 
-.. automodule:: ssb_konjunk.functions
+.. automodule:: ssb_konjunk.data_formating
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ssb\_konjunk.fame module
+------------------------
+
+.. automodule:: ssb_konjunk.fame
    :members:
    :undoc-members:
    :show-inheritance:
@@ -31,3 +39,35 @@ ssb\_konjunk.prompts module
    :members:
    :undoc-members:
    :show-inheritance:
+
+ssb\_konjunk.saving module
+--------------------------
+
+.. automodule:: ssb_konjunk.saving
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ssb\_konjunk.timestamp module
+-----------------------------
+
+.. automodule:: ssb_konjunk.timestamp
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ssb\_konjunk.xml\_handling module
+---------------------------------
+
+.. automodule:: ssb_konjunk.xml_handling
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ssb_konjunk
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/ssb_konjunk.rst

@@ -0,0 +1,67 @@
+ssb\_konjunk package
+====================
+
+
+ssb\_konjunk.data\_formating module
+-----------------------------------
+
+.. automodule:: ssb_konjunk.data_formating
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ssb\_konjunk.fame module
+------------------------
+
+.. automodule:: ssb_konjunk.fame
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ssb\_konjunk.prompts module
+---------------------------
+
+.. automodule:: ssb_konjunk.prompts
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ssb\_konjunk.rounding module
+----------------------------
+
+.. automodule:: ssb_konjunk.rounding
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ssb\_konjunk.saving module
+--------------------------
+
+.. automodule:: ssb_konjunk.saving
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ssb\_konjunk.statbank\_format module
+------------------------------------
+
+.. automodule:: ssb_konjunk.statbank_format
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ssb\_konjunk.timestamp module
+-----------------------------
+
+.. automodule:: ssb_konjunk.timestamp
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ssb\_konjunk.xml\_handling module
+---------------------------------
+
+.. automodule:: ssb_konjunk.xml_handling
+   :members:
+   :undoc-members:
+   :show-inheritance: