openenergyid 0.1.19__tar.gz → 0.1.21__tar.gz

openenergyid-0.1.21/.devcontainer/devcontainer.json

@@ -0,0 +1,42 @@
+{
+  "name": "Python 3",
+  "image": "mcr.microsoft.com/devcontainers/python:1.1.9-3.11-bookworm",
+  "features": {},
+  "postCreateCommand": "zsh -l .devcontainer/post-install.sh",
+  // "postStartCommand": "",
+  "workspaceMount": "source=${localWorkspaceFolder},target=/workspaces/${localWorkspaceFolderBasename},type=bind,consistency=cached",
+  "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
+  "remoteUser": "root",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-toolsai.jupyter",
+        "charliermarsh.ruff",
+        "ms-python.pylint",
+        "ms-python.vscode-pylance",
+        "visualstudioexptteam.vscodeintellicode",
+        "esbenp.prettier-vscode",
+        "GitHub.vscode-pull-request-github",
+        "mhutchie.git-graph",
+        "ms-toolsai.jupyter"
+      ],
+      "settings": {
+        "python.pythonPath": "/usr/local/bin/python",
+        "python.testing.pytestArgs": ["--no-cov"],
+        "editor.formatOnPaste": false,
+        "editor.formatOnSave": true,
+        "editor.formatOnType": true,
+        "files.trimTrailingWhitespace": true,
+        "terminal.integrated.profiles.linux": {
+          "zsh": {
+            "path": "/usr/bin/zsh"
+          }
+        },
+        "terminal.integrated.defaultProfile.linux": "zsh",
+        "[python]": {
+          "editor.defaultFormatter": "charliermarsh.ruff"
+        }
+      }
+    }
+  }
+}

openenergyid-0.1.21/.devcontainer/post-install.sh

@@ -0,0 +1,22 @@
+#!/bin/zsh -l
+# Add the current directory to Git's safe directory list
+git config --global --add safe.directory /workspaces/OpenEnergyID
+
+# Install Python tools
+pipx install ruff poetry pre-commit
+
+# Install project dependencies using Poetry
+poetry install
+
+# Install pre-commit hooks
+pre-commit install
+
+# Install ZSH plugins
+git clone https://github.com/zsh-users/zsh-autosuggestions ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-autosuggestions
+git clone https://github.com/zsh-users/zsh-syntax-highlighting.git ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-syntax-highlighting
+
+# Update .zshrc to enable plugins
+sed -i 's/plugins=(git)/plugins=(git zsh-autosuggestions zsh-syntax-highlighting)/' ~/.zshrc
+
+# Source the updated configuration
+source ~/.zshrc

openenergyid-0.1.21/.gitattributes

@@ -0,0 +1,21 @@
+# Set default behavior to LF
+* text=auto eol=lf
+
+# Explicitly declare files that should always use LF
+*.py text eol=lf
+*.json text eol=lf
+*.md text eol=lf
+*.yaml text eol=lf
+*.yml text eol=lf
+*.sh text eol=lf
+*.ndjson text eol=lf
+*.html text eol=lf
+*.toml text eol=lf
+*.txt text eol=lf
+*.dat text eol=lf
+*.lock text eol=lf
+
+# Denote all files that are truly binary and should not be modified
+*.png binary
+*.jpg binary
+*.gif binary

{openenergyid-0.1.19 → openenergyid-0.1.21}/.github/workflows/python-publish.yml

@@ -36,4 +36,3 @@ jobs:
       run: python -m build
     - name: Publish package
       uses: pypa/gh-action-pypi-publish@release/v1
-      

{openenergyid-0.1.19 → openenergyid-0.1.21}/.github/workflows/ruff.yml

@@ -5,4 +5,4 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: chartboost/ruff-action@v1
+      - uses: chartboost/ruff-action@v1

{openenergyid-0.1.19 → openenergyid-0.1.21}/.gitignore

@@ -164,4 +164,5 @@ secrets.json
 private_data/
 figures/
 temp_notebooks/
-*.pkl
+*.pkl
+vis/

openenergyid-0.1.21/.pre-commit-config.yaml

@@ -0,0 +1,43 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.5.5
+    hooks:
+      # Run the linter.
+      - id: ruff
+        types_or: [python, pyi, jupyter]
+        args: [--fix]
+      # Run the formatter.
+      - id: ruff-format
+        types_or: [python, pyi, jupyter]
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.16.0
+    hooks:
+      - id: pyupgrade
+        args: [--py311-plus]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: mixed-line-ending
+        args: [--fix=lf] # Force LF line endings
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-added-large-files
+
+  - repo: local
+    hooks:
+      - id: poetry-export-prod
+        name: Poetry export production requirements
+        entry: poetry export -f requirements.txt --output requirements.txt --without-hashes
+        language: system
+        pass_filenames: false
+        files: ^(pyproject\.toml|poetry\.lock)$
+      - id: poetry-export-dev
+        name: Poetry export development requirements
+        entry: poetry export -f requirements.txt --output requirements-dev.txt --without-hashes --only dev
+        language: system
+        pass_filenames: false
+        files: ^(pyproject\.toml|poetry\.lock)$

openenergyid-0.1.21/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "python.analysis.typeCheckingMode": "basic",
+  "remote.autoForwardPortsFallback": 0
+}

{openenergyid-0.1.19 → openenergyid-0.1.21}/DEVELOPERS.md

@@ -1,9 +1,13 @@
 # Development Environment Setup
 
 This guide outlines the setup process for our development environment, focusing on packaging and dependency management.
+
 ## Info on dev setup
+
 ### Commit practices (pre-commit)
-we use [pre-commit ](https://pre-commit.com/)to run RUFF. 
+
+we use [pre-commit ](https://pre-commit.com/)to run RUFF.
+
 ### Poetry for Packaging and Dependency Management
 
 We use [Poetry](https://python-poetry.org/docs/main/#installation) as our primary tool for packaging and managing dependencies. Poetry provides a simple yet powerful way to manage project dependencies and publish packages.
@@ -18,31 +22,42 @@ To ensure that Python CLI applications are installed globally on your system whi
 
 1. First, [install pipx](https://pipx.pypa.io/stable/installation/) following the instructions on the official website.
 2. Once pipx is installed, you can easily install Poetry by running the following command in your terminal:
-        ```pipx install poetry```
-3. (*optional*) [install](vscode:extension/zeshuaro.vscode-python-poetry) vscode extension for poetry
+   `pipx install poetry`
+3. (_optional_) [install](vscode:extension/zeshuaro.vscode-python-poetry) vscode extension for poetry
+
 ### Setup with Poetry
+
 ```shell
 poetry install
 ```
+
 ### publishing with poetry
+
 https://python-poetry.org/docs/repositories/
+
 ## Remarks for devcontainer
 
-You can also work inside a docker container(devcontainer).  
-To make sure you have access/permissions inside the devcontainer.
-From inside the devcontainer after launch, check user and take ownership:
+You can also work inside a docker container(devcontainer).
 
 ```bash
 whoami
 sudo chown -R $USER:$USER /workspaces/ -R
 ```
 
-other option is to run as root from within the `devcontainer.json` `"remoteUser": "root"`
+### some info about devcontainers:
+
+- [poetry in a devcontainer](https://marioscalas.medium.com/using-python-and-poetry-inside-a-dev-container-33c80bc5a22c)
+
+- [our python/container version](https://github.com/devcontainers/images/blob/main/src/python/history/1.1.9.md#variant-311-bookworm)
+
+- notes on [devcontainer git authentication](https://code.visualstudio.com/remote/advancedcontainers/sharing-git-credentials). dont forget to ssh-add if you use keys.
 
 # Useful commands for dev work
+
 ## clean up
-[vulture](https://github.com/jendrikseipp/vulture) for finding dead python 🐍      
-```pipx run vulture . --exclude venv```
 
-[deptry](https://github.com/fpgmaas/deptry) for checking dependencies   
-```pipx run deptry . --ignore-notebooks```
+[vulture](https://github.com/jendrikseipp/vulture) for finding dead python 🐍
+`pipx run vulture . --exclude venv`
+
+[deptry](https://github.com/fpgmaas/deptry) for checking dependencies
+`pipx run deptry . --ignore-notebooks`

{openenergyid-0.1.19 → openenergyid-0.1.21}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: openenergyid
-Version: 0.1.19
+Version: 0.1.21
 Summary: Open Source Python library for energy analytics and simulations
 Project-URL: Homepage, https://energyid.eu
 Project-URL: Repository, https://github.com/EnergieID/OpenEnergyID
@@ -47,4 +47,4 @@ Description-Content-Type: text/markdown
 
 Open Source Python library for energy data analytics and simulations
 
-[*more info for developers*](DEVELOPERS.md)
+[*more info for developers*](DEVELOPERS.md)

{openenergyid-0.1.19 → openenergyid-0.1.21}/README.md

@@ -2,4 +2,4 @@
 
 Open Source Python library for energy data analytics and simulations
 
-[*more info for developers*](DEVELOPERS.md)
+[*more info for developers*](DEVELOPERS.md)