Skip to content

Commit 418f5ea

Browse files
erwindounaerwindouna
authored
Merge pull request #1 from erwindouna/dev
Initial release for PyPi
2 parents a0f2a66 + 9a6bdbf commit 418f5ea

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+4109
-132
lines changed

‎.devcontainer/devcontainer.json‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
{
2+
"containerEnv": {
3+
"POETRY_VIRTUALENVS_IN_PROJECT": "true"
4+
},
5+
"customizations": {
6+
"codespaces": {
7+
"openFiles": [
8+
"README.md"
9+
]
10+
},
11+
"vscode": {
12+
"extensions": [
13+
"ms-python.python",
14+
"redhat.vscode-yaml",
15+
"esbenp.prettier-vscode",
16+
"GitHub.vscode-pull-request-github",
17+
"charliermarsh.ruff",
18+
"GitHub.vscode-github-actions",
19+
"ryanluker.vscode-coverage-gutters"
20+
],
21+
"settings": {
22+
"[python]": {
23+
"editor.codeActionsOnSave": {
24+
"source.fixAll": true,
25+
"source.organizeImports": true
26+
}
27+
},
28+
"coverage-gutters.customizable.context-menu": true,
29+
"coverage-gutters.customizable.status-bar-toggler-watchCoverageAndVisibleEditors-enabled": true,
30+
"coverage-gutters.showGutterCoverage": false,
31+
"coverage-gutters.showLineCoverage": true,
32+
"coverage-gutters.xmlname": "coverage.xml",
33+
"python.analysis.extraPaths": [
34+
"${workspaceFolder}/src"
35+
],
36+
"python.defaultInterpreterPath": ".venv/bin/python",
37+
"python.formatting.provider": "black",
38+
"python.linting.enabled": true,
39+
"python.linting.mypyEnabled": true,
40+
"python.linting.pylintEnabled": true,
41+
"python.testing.cwd": "${workspaceFolder}",
42+
"python.testing.pytestArgs": [
43+
"--cov-report=xml"
44+
],
45+
"python.testing.pytestEnabled": true,
46+
"ruff.importStrategy": "fromEnvironment",
47+
"ruff.interpreter": [
48+
".venv/bin/python"
49+
],
50+
"terminal.integrated.defaultProfile.linux": "zsh"
51+
}
52+
}
53+
},
54+
"name": "Asynchronous Python API for MelCloud",
55+
"image": "mcr.microsoft.com/vscode/devcontainers/python:3.12",
56+
"features": {
57+
"ghcr.io/devcontainers-contrib/features/poetry:2": {},
58+
"ghcr.io/devcontainers/features/github-cli:1": {},
59+
"ghcr.io/devcontainers/features/node:1": {},
60+
"ghcr.io/devcontainers/features/python:1": {
61+
"installTools": false
62+
}
63+
},
64+
"updateContentCommand": ". ${NVM_DIR}/nvm.sh && nvm install && nvm use && npm install && poetry install && poetry run pre-commit install",
65+
"postStartCommand": ". ${NVM_DIR}/nvm.sh && nvm install && nvm use && npm install && poetry install && poetry run pre-commit install"
66+
}

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.github/* @erwindouna

‎.github/CONTRIBUTING.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish
4+
to make via issue, email, or any other method with the owners of this repository
5+
before making a change.
6+
7+
Please note we have a code of conduct, please follow it in all your interactions
8+
with the project.
9+
10+
## Issues and feature requests
11+
12+
You've found a bug in the source code, a mistake in the documentation or maybe
13+
you'd like a new feature? You can help us by submitting an issue to our
14+
[GitHub Repository][github]. Before you create an issue, make sure you search
15+
the archive, maybe your question was already answered.
16+
17+
Even better: You could submit a pull request with a fix / new feature!
18+
19+
## Pull request process
20+
21+
1. Search our repository for open or closed [pull requests][prs] that relates
22+
to your submission. You don't want to duplicate effort.
23+
24+
1. You may merge the pull request in once you have the sign-off of two other
25+
developers, or if you do not have permission to do that, you may request
26+
the second reviewer to merge it for you.
27+
28+
[github]: https://github.com/erwindouna/python-melcloud/issues
29+
[prs]: https://github.com/erwindouna/python-melcloud/pulls

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
2+
# Problem/Motivation
3+
4+
> (Why the issue was filed)
5+
6+
## Expected behavior
7+
8+
> (What you expected to happen)
9+
10+
## Actual behavior
11+
12+
> (What actually happened)
13+
14+
## Steps to reproduce
15+
16+
> (How can someone else make/see it happen)
17+
18+
## Proposed changes
19+
20+
> (If you have a proposed change, workaround or fix,
21+
> describe the rationale behind it)

‎LICENSE‎ renamed to ‎.github/LICENSE.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
The MIT License
1+
2# MIT License
22

3-
Copyright (c) 2019 Vilppu Vuorinen, [email protected]
3+
Copyright (c) 2025 Erwin Douna
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
99
copies of the Software, and to permit persons to whom the Software is
1010
furnished to do so, subject to the following conditions:
1111

12-
The above copyright notice and this permission notice shall be included in
13-
all copies or substantial portions of the Software.
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
1414

1515
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
1616
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
1717
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1818
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21-
THE SOFTWARE.
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Proposed Changes
2+
3+
> (Describe the changes and rationale behind them)
4+
5+
## Related Issues
6+
7+
> ([Github link][autolink-references] to related issues or pull requests)
8+
9+
[autolink-references]: https://help.github.com/articles/autolinked-references-and-urls/

‎.github/labels.yml‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
- name: "breaking-change"
3+
color: ee0701
4+
description: "A breaking change for existing users."
5+
- name: "bugfix"
6+
color: ee0701
7+
description: "Inconsistencies or issues which will cause a problem for users or implementers."
8+
- name: "documentation"
9+
color: 0052cc
10+
description: "Solely about the documentation of the project."
11+
- name: "enhancement"
12+
color: 1d76db
13+
description: "Enhancement of the code, not introducing new features."
14+
- name: "refactor"
15+
color: 1d76db
16+
description: "Improvement of existing code, not introducing new features."
17+
- name: "performance"
18+
color: 1d76db
19+
description: "Improving performance, not introducing new features."
20+
- name: "new-feature"
21+
color: 0e8a16
22+
description: "New features or options."
23+
- name: "maintenance"
24+
color: 2af79e
25+
description: "Generic maintenance tasks."
26+
- name: "ci"
27+
color: 1d76db
28+
description: "Work that improves the continue integration."
29+
- name: "dependencies"
30+
color: 1d76db
31+
description: "Upgrade or downgrade of project dependencies."
32+
33+
- name: "in-progress"
34+
color: fbca04
35+
description: "Issue is currently being resolved by a developer."
36+
- name: "stale"
37+
color: fef2c0
38+
description: "There has not been activity on this issue or PR for quite some time."
39+
- name: "no-stale"
40+
color: fef2c0
41+
description: "This issue or PR is exempted from the stable bot."
42+
43+
- name: "security"
44+
color: ee0701
45+
description: "Marks a security issue that needs to be resolved asap."
46+
- name: "incomplete"
47+
color: fef2c0
48+
description: "Marks a PR or issue that is missing information."
49+
- name: "invalid"
50+
color: fef2c0
51+
description: "Marks a PR or issue that is missing information."
52+
53+
- name: "beginner-friendly"
54+
color: 0e8a16
55+
description: "Good first issue for people wanting to contribute to the project."
56+
- name: "help-wanted"
57+
color: 0e8a16
58+
description: "We need some extra helping hands or expertise in order to resolve this."
59+
60+
- name: "hacktoberfest"
61+
description: "Issues/PRs are participating in the Hacktoberfest."
62+
color: fbca04
63+
- name: "hacktoberfest-accepted"
64+
description: "Issues/PRs are participating in the Hacktoberfest."
65+
color: fbca04
66+
67+
- name: "priority-critical"
68+
color: ee0701
69+
description: "This should be dealt with ASAP. Not fixing this issue would be a serious error."
70+
- name: "priority-high"
71+
color: b60205
72+
description: "After critical issues are fixed, these should be dealt with before any further issues."
73+
- name: "priority-medium"
74+
color: 0e8a16
75+
description: "This issue may be useful, and needs some attention."
76+
- name: "priority-low"
77+
color: e4ea8a
78+
description: "Nice addition, maybe... someday..."
79+
80+
- name: "major"
81+
color: b60205
82+
description: "This PR causes a major version bump in the version number."
83+
- name: "minor"
84+
color: 0e8a16
85+
description: "This PR causes a minor version bump in the version number."

‎.github/release-drafter.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
name-template: "v$RESOLVED_VERSION"
3+
tag-template: "v$RESOLVED_VERSION"
4+
change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
5+
sort-direction: ascending
6+
7+
categories:
8+
- title: "🚨 Breaking changes"
9+
labels:
10+
- "breaking-change"
11+
- title: "✨ New features"
12+
labels:
13+
- "new-feature"
14+
- title: "🐛 Bug fixes"
15+
labels:
16+
- "bugfix"
17+
- title: "🚀 Enhancements"
18+
labels:
19+
- "enhancement"
20+
- "refactor"
21+
- "performance"
22+
- title: "🧰 Maintenance"
23+
labels:
24+
- "maintenance"
25+
- "ci"
26+
- title: "📚 Documentation"
27+
labels:
28+
- "documentation"
29+
- title: "⬆️ Dependency updates"
30+
labels:
31+
- "dependencies"
32+
33+
version-resolver:
34+
major:
35+
labels:
36+
- "major"
37+
- "breaking-change"
38+
minor:
39+
labels:
40+
- "minor"
41+
- "new-feature"
42+
patch:
43+
labels:
44+
- "bugfix"
45+
- "chore"
46+
- "ci"
47+
- "dependencies"
48+
- "documentation"
49+
- "enhancement"
50+
- "performance"
51+
- "refactor"
52+
default: patch
53+
54+
template: |
55+
## What’s changed
56+
57+
$CHANGES

‎.github/renovate.json‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
{
2+
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
3+
"schedule": ["before 2am"],
4+
"rebaseWhen": "behind-base-branch",
5+
"dependencyDashboard": true,
6+
"labels": ["dependencies", "no-stale"],
7+
"lockFileMaintenance": {
8+
"enabled": true,
9+
"automerge": true
10+
},
11+
"commitMessagePrefix": "⬆️",
12+
"packageRules": [
13+
{
14+
"matchManagers": ["poetry"],
15+
"addLabels": ["python"]
16+
},
17+
{
18+
"matchManagers": ["poetry"],
19+
"matchDepTypes": ["dev"],
20+
"rangeStrategy": "pin"
21+
},
22+
{
23+
"matchManagers": ["poetry"],
24+
"matchUpdateTypes": ["minor", "patch"],
25+
"automerge": true
26+
},
27+
{
28+
"matchManagers": ["npm", "nvm"],
29+
"addLabels": ["javascript"],
30+
"rangeStrategy": "pin"
31+
},
32+
{
33+
"matchManagers": ["npm", "nvm"],
34+
"matchUpdateTypes": ["minor", "patch"],
35+
"automerge": true
36+
},
37+
{
38+
"matchManagers": ["github-actions"],
39+
"addLabels": ["github_actions"],
40+
"rangeStrategy": "pin"
41+
},
42+
{
43+
"matchManagers": ["github-actions"],
44+
"matchUpdateTypes": ["minor", "patch"],
45+
"automerge": true
46+
}
47+
]
48+
}

‎.github/workflows/codeql.yaml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: "CodeQL"
3+
4+
# yamllint disable-line rule:truthy
5+
on:
6+
push:
7+
branches: [main]
8+
pull_request:
9+
branches: [main]
10+
workflow_dispatch:
11+
schedule:
12+
- cron: "30 1 * * 0"
13+
14+
jobs:
15+
codeql:
16+
name: Scanning
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: ⤵️ Check out code from GitHub
20+
uses: actions/[email protected]
21+
- name: 🏗 Initialize CodeQL
22+
uses: github/codeql-action/[email protected]
23+
- name: 🚀 Perform CodeQL Analysis
24+
uses: github/codeql-action/[email protected]

0 commit comments

Comments
 (0)