openenergyid 0.1.21__tar.gz → 0.1.28__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of openenergyid might be problematic. Click here for more details.

Files changed (71) hide show
  1. openenergyid-0.1.28/PKG-INFO +41 -0
  2. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/__init__.py +1 -1
  3. {openenergyid-0.1.21 → openenergyid-0.1.28}/pyproject.toml +26 -39
  4. openenergyid-0.1.21/.devcontainer/devcontainer.json +0 -42
  5. openenergyid-0.1.21/.devcontainer/post-install.sh +0 -22
  6. openenergyid-0.1.21/.gitattributes +0 -21
  7. openenergyid-0.1.21/.github/workflows/python-publish.yml +0 -38
  8. openenergyid-0.1.21/.github/workflows/ruff.yml +0 -8
  9. openenergyid-0.1.21/.gitignore +0 -168
  10. openenergyid-0.1.21/.pre-commit-config.yaml +0 -43
  11. openenergyid-0.1.21/.vscode/settings.json +0 -4
  12. openenergyid-0.1.21/DEVELOPERS.md +0 -63
  13. openenergyid-0.1.21/PKG-INFO +0 -50
  14. openenergyid-0.1.21/data/PP/energy_use.json +0 -35042
  15. openenergyid-0.1.21/data/PP/energy_use2Vin.ndjson +0 -35040
  16. openenergyid-0.1.21/data/PP/energy_use_big.ndjson +0 -29664
  17. openenergyid-0.1.21/data/PP/energy_use_test1.ndjson +0 -35040
  18. openenergyid-0.1.21/data/PP/energy_use_test2.ndjson +0 -28896
  19. openenergyid-0.1.21/data/capacity/capacity_output.json +0 -327
  20. openenergyid-0.1.21/data/capacity/power_sample.json +0 -3473
  21. openenergyid-0.1.21/data/da_prices_be.json +0 -291657
  22. openenergyid-0.1.21/data/dyntar/demo_dyntar_analysis.html +0 -8725
  23. openenergyid-0.1.21/data/dyntar/sample.json +0 -1
  24. openenergyid-0.1.21/data/dyntar/sample_output.json +0 -240540
  25. openenergyid-0.1.21/data/energiedelen/Optimaal_1.png +0 -0
  26. openenergyid-0.1.21/data/energiedelen/Optimaal_2.png +0 -0
  27. openenergyid-0.1.21/data/energiedelen/Relatief.png +0 -0
  28. openenergyid-0.1.21/data/energiedelen/Vast.png +0 -0
  29. openenergyid-0.1.21/data/energiedelen/sample_input.json +0 -1
  30. openenergyid-0.1.21/data/mvlr/sample_gas.json +0 -1869
  31. openenergyid-0.1.21/data/mvlr/sample_solar.json +0 -2586
  32. openenergyid-0.1.21/demo_baseLoad.ipynb +0 -271
  33. openenergyid-0.1.21/demo_capacity_analysis.ipynb +0 -472
  34. openenergyid-0.1.21/demo_dyntar_analysis.ipynb +0 -1243
  35. openenergyid-0.1.21/demo_energiedelen.ipynb +0 -1184
  36. openenergyid-0.1.21/demo_energyid_download.ipynb +0 -152
  37. openenergyid-0.1.21/demo_mvlr.ipynb +0 -118
  38. openenergyid-0.1.21/download_prices.ipynb +0 -110
  39. openenergyid-0.1.21/performance_testing.ipynb +0 -164
  40. openenergyid-0.1.21/poetry.lock +0 -3869
  41. openenergyid-0.1.21/requirements-dev.txt +0 -128
  42. openenergyid-0.1.21/requirements.txt +0 -19
  43. openenergyid-0.1.21/tests/__init__.py +0 -0
  44. openenergyid-0.1.21/tests/data/mvlr/sample.dat +0 -2585
  45. openenergyid-0.1.21/tests/nb.py +0 -38
  46. {openenergyid-0.1.21 → openenergyid-0.1.28}/LICENSE +0 -0
  47. {openenergyid-0.1.21 → openenergyid-0.1.28}/README.md +0 -0
  48. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/baseload/__init__.py +0 -0
  49. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/baseload/analysis.py +0 -0
  50. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/baseload/exceptions.py +0 -0
  51. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/baseload/models.py +0 -0
  52. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/capacity/__init__.py +0 -0
  53. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/capacity/main.py +0 -0
  54. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/capacity/models.py +0 -0
  55. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/const.py +0 -0
  56. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/dyntar/__init__.py +0 -0
  57. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/dyntar/const.py +0 -0
  58. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/dyntar/main.py +0 -0
  59. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/dyntar/models.py +0 -0
  60. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/energysharing/__init__.py +0 -0
  61. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/energysharing/const.py +0 -0
  62. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/energysharing/data_formatting.py +0 -0
  63. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/energysharing/main.py +0 -0
  64. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/energysharing/models.py +0 -0
  65. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/enums.py +0 -0
  66. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/models.py +0 -0
  67. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/mvlr/__init__.py +0 -0
  68. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/mvlr/helpers.py +0 -0
  69. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/mvlr/main.py +0 -0
  70. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/mvlr/models.py +0 -0
  71. {openenergyid-0.1.21 → openenergyid-0.1.28}/openenergyid/mvlr/mvlr.py +0 -0
@@ -0,0 +1,41 @@
1
+ Metadata-Version: 2.3
2
+ Name: openenergyid
3
+ Version: 0.1.28
4
+ Summary: Open Source Python library for energy analytics and simulations
5
+ License: MIT
6
+ Keywords: energy,analytics,simulation
7
+ Author: Jan Pecinovsky
8
+ Author-email: jan@energieid.be
9
+ Requires-Python: >=3.11,<4.0
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: Intended Audience :: Science/Research
13
+ Classifier: License :: OSI Approved :: MIT License
14
+ Classifier: Natural Language :: English
15
+ Classifier: Operating System :: OS Independent
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Programming Language :: Python :: 3.13
20
+ Classifier: Topic :: Scientific/Engineering
21
+ Classifier: Topic :: Scientific/Engineering :: Mathematics
22
+ Classifier: Topic :: Scientific/Engineering :: Physics
23
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
24
+ Requires-Dist: numpy (>=2.0.0,<3.0.0)
25
+ Requires-Dist: pandas (>=2.2.2,<3.0.0)
26
+ Requires-Dist: pandera[polars] (>=0.22.1,<0.23.0)
27
+ Requires-Dist: patsy (>=0.5.6,<0.6.0)
28
+ Requires-Dist: polars (>=1.9.0,<2.0.0)
29
+ Requires-Dist: pydantic (>=2.8.2,<3.0.0)
30
+ Requires-Dist: statsmodels (>=0.14.2,<0.15.0)
31
+ Project-URL: Documentation, https://github.com/EnergieID/OpenEnergyID
32
+ Project-URL: Homepage, https://energyid.eu
33
+ Project-URL: Repository, https://github.com/EnergieID/OpenEnergyID
34
+ Description-Content-Type: text/markdown
35
+
36
+ # OpenEnergyID
37
+
38
+ Open Source Python library for energy data analytics and simulations
39
+
40
+ [*more info for developers*](DEVELOPERS.md)
41
+
@@ -1,6 +1,6 @@
1
1
  """Open Energy ID Python SDK."""
2
2
 
3
- __version__ = "0.1.21"
3
+ __version__ = "0.1.28"
4
4
 
5
5
  from .enums import Granularity
6
6
  from .models import TimeDataFrame, TimeSeries
@@ -1,18 +1,21 @@
1
1
  [build-system]
2
- requires = ["hatchling"]
3
- build-backend = "hatchling.build"
2
+ requires = ["poetry-core>=1.0.0"]
3
+ build-backend = "poetry.core.masonry.api"
4
4
 
5
- [project]
6
- dynamic = ["version"]
5
+ [tool.poetry]
7
6
  name = "openenergyid"
7
+ version = "0.1.28"
8
+ description = "Open Source Python library for energy analytics and simulations"
8
9
  authors = [
9
- { name = "Jan Pecinovsky", email = "jan@energieid.be" },
10
- { name = "Max Helskens", email = "max@energieid.be" },
10
+ "Jan Pecinovsky <jan@energieid.be>",
11
+ "Max Helskens <max@energieid.be>",
12
+ "Oscar Swyns <oscar@energieid.be>"
11
13
  ]
12
- maintainers = [{ name = "Jan Pecinovsky", email = "jan@energieid.be" }]
13
- description = "Open Source Python library for energy analytics and simulations"
14
14
  readme = "README.md"
15
- license = { file = "LICENSE" }
15
+ license = "MIT"
16
+ homepage = "https://energyid.eu"
17
+ repository = "https://github.com/EnergieID/OpenEnergyID"
18
+ documentation = "https://github.com/EnergieID/OpenEnergyID"
16
19
  keywords = ["energy", "analytics", "simulation"]
17
20
  classifiers = [
18
21
  "Development Status :: 3 - Alpha",
@@ -25,38 +28,18 @@ classifiers = [
25
28
  "Topic :: Scientific/Engineering",
26
29
  "Topic :: Scientific/Engineering :: Mathematics",
27
30
  "Topic :: Scientific/Engineering :: Physics",
28
- "Topic :: Software Development :: Libraries :: Python Modules",
31
+ "Topic :: Software Development :: Libraries :: Python Modules"
29
32
  ]
30
33
 
31
- [project.urls]
32
- Homepage = "https://energyid.eu"
33
- Repository = "https://github.com/EnergieID/OpenEnergyID"
34
- "Bugs Tracker" = "https://github.com/EnergieID/OpenEnergyID/issues"
35
-
36
- [tool.hatch.version]
37
- path = "openenergyid/__init__.py"
38
-
39
- [tool.ruff]
40
- line-length = 100
41
-
42
-
43
- [tool.poetry]
44
- name = "openenergyid"
45
- version = "0.1.21" # You'll need to set this manually or use a different method for dynamic versioning
46
- description = "Open Source Python library for energy analytics and simulations"
47
- authors = [
48
- "Jan Pecinovsky <jan@energieid.be>",
49
- "Max Helskens <max@energieid.be>",
50
- "Oscar Swyns <oscar@energieid.be>",
51
- ]
52
- dependencies.python = "^3.11"
53
- dependencies.polars = "^1.9.0"
54
- dependencies.pandera = {extras = ["polars"], version = "^0.22.1"}
55
- dependencies.numpy = "^2.0.0"
56
- dependencies.patsy = "^0.5.6"
57
- dependencies.statsmodels = "^0.14.2"
58
- dependencies.pydantic = "^2.8.2"
59
- dependencies.pandas = "^2.2.2"
34
+ [tool.poetry.dependencies]
35
+ python = "^3.11"
36
+ polars = "^1.9.0"
37
+ numpy = "^2.0.0"
38
+ patsy = "^0.5.6"
39
+ statsmodels = "^0.14.2"
40
+ pydantic = "^2.8.2"
41
+ pandas = "^2.2.2"
42
+ pandera = {extras = ["polars"], version = "^0.22.1"}
60
43
 
61
44
  [tool.poetry.group.dev.dependencies]
62
45
  altair = "^5.4.1"
@@ -73,6 +56,10 @@ vegafusion = {version = ">=1.5.0", extras = ["embed"]}
73
56
  vl-convert-python = "^1.7.0"
74
57
  pyarrow = "^19.0.0"
75
58
  pyinstrument = "^5.0.0"
59
+ deptry = "^0.23.0"
76
60
 
77
61
  [tool.poetry.requires-plugins]
78
62
  poetry-plugin-export = ">=1.8"
63
+
64
+ [tool.ruff]
65
+ line-length = 100
@@ -1,42 +0,0 @@
1
- {
2
- "name": "Python 3",
3
- "image": "mcr.microsoft.com/devcontainers/python:1.1.9-3.11-bookworm",
4
- "features": {},
5
- "postCreateCommand": "zsh -l .devcontainer/post-install.sh",
6
- // "postStartCommand": "",
7
- "workspaceMount": "source=${localWorkspaceFolder},target=/workspaces/${localWorkspaceFolderBasename},type=bind,consistency=cached",
8
- "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
9
- "remoteUser": "root",
10
- "customizations": {
11
- "vscode": {
12
- "extensions": [
13
- "ms-toolsai.jupyter",
14
- "charliermarsh.ruff",
15
- "ms-python.pylint",
16
- "ms-python.vscode-pylance",
17
- "visualstudioexptteam.vscodeintellicode",
18
- "esbenp.prettier-vscode",
19
- "GitHub.vscode-pull-request-github",
20
- "mhutchie.git-graph",
21
- "ms-toolsai.jupyter"
22
- ],
23
- "settings": {
24
- "python.pythonPath": "/usr/local/bin/python",
25
- "python.testing.pytestArgs": ["--no-cov"],
26
- "editor.formatOnPaste": false,
27
- "editor.formatOnSave": true,
28
- "editor.formatOnType": true,
29
- "files.trimTrailingWhitespace": true,
30
- "terminal.integrated.profiles.linux": {
31
- "zsh": {
32
- "path": "/usr/bin/zsh"
33
- }
34
- },
35
- "terminal.integrated.defaultProfile.linux": "zsh",
36
- "[python]": {
37
- "editor.defaultFormatter": "charliermarsh.ruff"
38
- }
39
- }
40
- }
41
- }
42
- }
@@ -1,22 +0,0 @@
1
- #!/bin/zsh -l
2
- # Add the current directory to Git's safe directory list
3
- git config --global --add safe.directory /workspaces/OpenEnergyID
4
-
5
- # Install Python tools
6
- pipx install ruff poetry pre-commit
7
-
8
- # Install project dependencies using Poetry
9
- poetry install
10
-
11
- # Install pre-commit hooks
12
- pre-commit install
13
-
14
- # Install ZSH plugins
15
- git clone https://github.com/zsh-users/zsh-autosuggestions ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-autosuggestions
16
- git clone https://github.com/zsh-users/zsh-syntax-highlighting.git ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-syntax-highlighting
17
-
18
- # Update .zshrc to enable plugins
19
- sed -i 's/plugins=(git)/plugins=(git zsh-autosuggestions zsh-syntax-highlighting)/' ~/.zshrc
20
-
21
- # Source the updated configuration
22
- source ~/.zshrc
@@ -1,21 +0,0 @@
1
- # Set default behavior to LF
2
- * text=auto eol=lf
3
-
4
- # Explicitly declare files that should always use LF
5
- *.py text eol=lf
6
- *.json text eol=lf
7
- *.md text eol=lf
8
- *.yaml text eol=lf
9
- *.yml text eol=lf
10
- *.sh text eol=lf
11
- *.ndjson text eol=lf
12
- *.html text eol=lf
13
- *.toml text eol=lf
14
- *.txt text eol=lf
15
- *.dat text eol=lf
16
- *.lock text eol=lf
17
-
18
- # Denote all files that are truly binary and should not be modified
19
- *.png binary
20
- *.jpg binary
21
- *.gif binary
@@ -1,38 +0,0 @@
1
- # This workflow will upload a Python Package using Twine when a release is created
2
- # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
3
-
4
- # This workflow uses actions that are not certified by GitHub.
5
- # They are provided by a third-party and are governed by
6
- # separate terms of service, privacy policy, and support
7
- # documentation.
8
-
9
- name: Upload Python Package
10
-
11
- on:
12
- release:
13
- types: [published]
14
-
15
- permissions:
16
- contents: read
17
-
18
- jobs:
19
- deploy:
20
- runs-on: ubuntu-latest
21
- permissions:
22
- id-token: write
23
- environment: release
24
-
25
- steps:
26
- - uses: actions/checkout@v3
27
- - name: Set up Python
28
- uses: actions/setup-python@v3
29
- with:
30
- python-version: '3.x'
31
- - name: Install dependencies
32
- run: |
33
- python -m pip install --upgrade pip
34
- pip install build
35
- - name: Build package
36
- run: python -m build
37
- - name: Publish package
38
- uses: pypa/gh-action-pypi-publish@release/v1
@@ -1,8 +0,0 @@
1
- name: Ruff
2
- on: [push, pull_request]
3
- jobs:
4
- ruff:
5
- runs-on: ubuntu-latest
6
- steps:
7
- - uses: actions/checkout@v3
8
- - uses: chartboost/ruff-action@v1
@@ -1,168 +0,0 @@
1
- # Byte-compiled / optimized / DLL files
2
- __pycache__/
3
- *.py[cod]
4
- *$py.class
5
-
6
- # C extensions
7
- *.so
8
-
9
- # Distribution / packaging
10
- .Python
11
- build/
12
- develop-eggs/
13
- dist/
14
- downloads/
15
- eggs/
16
- .eggs/
17
- lib/
18
- lib64/
19
- parts/
20
- sdist/
21
- var/
22
- wheels/
23
- share/python-wheels/
24
- *.egg-info/
25
- .installed.cfg
26
- *.egg
27
- MANIFEST
28
-
29
- # PyInstaller
30
- # Usually these files are written by a python script from a template
31
- # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
- *.manifest
33
- *.spec
34
-
35
- # Installer logs
36
- pip-log.txt
37
- pip-delete-this-directory.txt
38
-
39
- # Unit test / coverage reports
40
- htmlcov/
41
- .tox/
42
- .nox/
43
- .coverage
44
- .coverage.*
45
- .cache
46
- nosetests.xml
47
- coverage.xml
48
- *.cover
49
- *.py,cover
50
- .hypothesis/
51
- .pytest_cache/
52
- cover/
53
-
54
- # Translations
55
- *.mo
56
- *.pot
57
-
58
- # Django stuff:
59
- *.log
60
- local_settings.py
61
- db.sqlite3
62
- db.sqlite3-journal
63
-
64
- # Flask stuff:
65
- instance/
66
- .webassets-cache
67
-
68
- # Scrapy stuff:
69
- .scrapy
70
-
71
- # Sphinx documentation
72
- docs/_build/
73
-
74
- # PyBuilder
75
- .pybuilder/
76
- target/
77
-
78
- # Jupyter Notebook
79
- .ipynb_checkpoints
80
-
81
- # IPython
82
- profile_default/
83
- ipython_config.py
84
-
85
- # pyenv
86
- # For a library or package, you might want to ignore these files since the code is
87
- # intended to run in multiple environments; otherwise, check them in:
88
- # .python-version
89
-
90
- # pipenv
91
- # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
- # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
- # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
- # install all needed dependencies.
95
- #Pipfile.lock
96
-
97
- # poetry
98
- # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99
- # This is especially recommended for binary packages to ensure reproducibility, and is more
100
- # commonly ignored for libraries.
101
- # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102
- #poetry.lock
103
-
104
- # pdm
105
- # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106
- #pdm.lock
107
- # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108
- # in version control.
109
- # https://pdm.fming.dev/#use-with-ide
110
- .pdm.toml
111
-
112
- # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113
- __pypackages__/
114
-
115
- # Celery stuff
116
- celerybeat-schedule
117
- celerybeat.pid
118
-
119
- # SageMath parsed files
120
- *.sage.py
121
-
122
- # Environments
123
- .env
124
- .venv
125
- env/
126
- venv/
127
- ENV/
128
- env.bak/
129
- venv.bak/
130
-
131
- # Spyder project settings
132
- .spyderproject
133
- .spyproject
134
-
135
- # Rope project settings
136
- .ropeproject
137
-
138
- # mkdocs documentation
139
- /site
140
-
141
- # mypy
142
- .mypy_cache/
143
- .dmypy.json
144
- dmypy.json
145
-
146
- # Pyre type checker
147
- .pyre/
148
-
149
- # pytype static type analyzer
150
- .pytype/
151
-
152
- # Cython debug symbols
153
- cython_debug/
154
-
155
- # PyCharm
156
- # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157
- # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
158
- # and can be added to the global gitignore or merged into this file. For a more nuclear
159
- # option (not recommended) you can uncomment the following to ignore the entire idea folder.
160
- #.idea/
161
- .DS_Store
162
- secrets.json
163
-
164
- private_data/
165
- figures/
166
- temp_notebooks/
167
- *.pkl
168
- vis/
@@ -1,43 +0,0 @@
1
- repos:
2
- - repo: https://github.com/astral-sh/ruff-pre-commit
3
- # Ruff version.
4
- rev: v0.5.5
5
- hooks:
6
- # Run the linter.
7
- - id: ruff
8
- types_or: [python, pyi, jupyter]
9
- args: [--fix]
10
- # Run the formatter.
11
- - id: ruff-format
12
- types_or: [python, pyi, jupyter]
13
-
14
- - repo: https://github.com/asottile/pyupgrade
15
- rev: v3.16.0
16
- hooks:
17
- - id: pyupgrade
18
- args: [--py311-plus]
19
-
20
- - repo: https://github.com/pre-commit/pre-commit-hooks
21
- rev: v4.6.0
22
- hooks:
23
- - id: mixed-line-ending
24
- args: [--fix=lf] # Force LF line endings
25
- - id: check-yaml
26
- - id: end-of-file-fixer
27
- - id: trailing-whitespace
28
- - id: check-added-large-files
29
-
30
- - repo: local
31
- hooks:
32
- - id: poetry-export-prod
33
- name: Poetry export production requirements
34
- entry: poetry export -f requirements.txt --output requirements.txt --without-hashes
35
- language: system
36
- pass_filenames: false
37
- files: ^(pyproject\.toml|poetry\.lock)$
38
- - id: poetry-export-dev
39
- name: Poetry export development requirements
40
- entry: poetry export -f requirements.txt --output requirements-dev.txt --without-hashes --only dev
41
- language: system
42
- pass_filenames: false
43
- files: ^(pyproject\.toml|poetry\.lock)$
@@ -1,4 +0,0 @@
1
- {
2
- "python.analysis.typeCheckingMode": "basic",
3
- "remote.autoForwardPortsFallback": 0
4
- }
@@ -1,63 +0,0 @@
1
- # Development Environment Setup
2
-
3
- This guide outlines the setup process for our development environment, focusing on packaging and dependency management.
4
-
5
- ## Info on dev setup
6
-
7
- ### Commit practices (pre-commit)
8
-
9
- we use [pre-commit ](https://pre-commit.com/)to run RUFF.
10
-
11
- ### Poetry for Packaging and Dependency Management
12
-
13
- 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.
14
-
15
- For the most detailed and up-to-date information, please refer to the [official Poetry 📚](https://python-poetry.org/docs/main/#installation).
16
-
17
- ### Installing Python CLI Applications Globally with pipx
18
-
19
- To ensure that Python CLI applications are installed globally on your system while being isolated in their own virtual environments, we utilize `pipx`.
20
-
21
- ## Steps to Install pipx and Poetry
22
-
23
- 1. First, [install pipx](https://pipx.pypa.io/stable/installation/) following the instructions on the official website.
24
- 2. Once pipx is installed, you can easily install Poetry by running the following command in your terminal:
25
- `pipx install poetry`
26
- 3. (_optional_) [install](vscode:extension/zeshuaro.vscode-python-poetry) vscode extension for poetry
27
-
28
- ### Setup with Poetry
29
-
30
- ```shell
31
- poetry install
32
- ```
33
-
34
- ### publishing with poetry
35
-
36
- https://python-poetry.org/docs/repositories/
37
-
38
- ## Remarks for devcontainer
39
-
40
- You can also work inside a docker container(devcontainer).
41
-
42
- ```bash
43
- whoami
44
- sudo chown -R $USER:$USER /workspaces/ -R
45
- ```
46
-
47
- ### some info about devcontainers:
48
-
49
- - [poetry in a devcontainer](https://marioscalas.medium.com/using-python-and-poetry-inside-a-dev-container-33c80bc5a22c)
50
-
51
- - [our python/container version](https://github.com/devcontainers/images/blob/main/src/python/history/1.1.9.md#variant-311-bookworm)
52
-
53
- - notes on [devcontainer git authentication](https://code.visualstudio.com/remote/advancedcontainers/sharing-git-credentials). dont forget to ssh-add if you use keys.
54
-
55
- # Useful commands for dev work
56
-
57
- ## clean up
58
-
59
- [vulture](https://github.com/jendrikseipp/vulture) for finding dead python 🐍
60
- `pipx run vulture . --exclude venv`
61
-
62
- [deptry](https://github.com/fpgmaas/deptry) for checking dependencies
63
- `pipx run deptry . --ignore-notebooks`
@@ -1,50 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: openenergyid
3
- Version: 0.1.21
4
- Summary: Open Source Python library for energy analytics and simulations
5
- Project-URL: Homepage, https://energyid.eu
6
- Project-URL: Repository, https://github.com/EnergieID/OpenEnergyID
7
- Project-URL: Bugs Tracker, https://github.com/EnergieID/OpenEnergyID/issues
8
- Author-email: Jan Pecinovsky <jan@energieid.be>, Max Helskens <max@energieid.be>
9
- Maintainer-email: Jan Pecinovsky <jan@energieid.be>
10
- License: MIT License
11
-
12
- Copyright (c) 2023 EnergieID cvba-so
13
-
14
- Permission is hereby granted, free of charge, to any person obtaining a copy
15
- of this software and associated documentation files (the "Software"), to deal
16
- in the Software without restriction, including without limitation the rights
17
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18
- copies of the Software, and to permit persons to whom the Software is
19
- furnished to do so, subject to the following conditions:
20
-
21
- The above copyright notice and this permission notice shall be included in all
22
- copies or substantial portions of the Software.
23
-
24
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
27
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30
- SOFTWARE.
31
- License-File: LICENSE
32
- Keywords: analytics,energy,simulation
33
- Classifier: Development Status :: 3 - Alpha
34
- Classifier: Intended Audience :: Developers
35
- Classifier: Intended Audience :: Science/Research
36
- Classifier: License :: OSI Approved :: MIT License
37
- Classifier: Natural Language :: English
38
- Classifier: Operating System :: OS Independent
39
- Classifier: Programming Language :: Python :: 3
40
- Classifier: Topic :: Scientific/Engineering
41
- Classifier: Topic :: Scientific/Engineering :: Mathematics
42
- Classifier: Topic :: Scientific/Engineering :: Physics
43
- Classifier: Topic :: Software Development :: Libraries :: Python Modules
44
- Description-Content-Type: text/markdown
45
-
46
- # OpenEnergyID
47
-
48
- Open Source Python library for energy data analytics and simulations
49
-
50
- [*more info for developers*](DEVELOPERS.md)