systemair-api-promises 0.1.0__tar.gz

systemair_api_promises-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,43 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: '[BUG] '
+labels: bug
+assignees: ''
+---
+
+## Bug Description
+A clear and concise description of what the bug is.
+
+## To Reproduce
+Steps to reproduce the behavior:
+1. Use function/class '...'
+2. With parameters '....'
+3. Execute code '....'
+4. See error
+
+## Expected Behavior
+A clear and concise description of what you expected to happen.
+
+## Actual Behavior
+A clear and concise description of what actually happened.
+
+## Error Messages
+If applicable, add error messages or stack traces you received.
+
+```
+Paste error messages here
+```
+
+## Environment
+ - OS: [e.g. Windows 10, macOS 12.0, Ubuntu 22.04]
+ - Python version: [e.g. 3.8.10]
+ - SystemAIR-API version: [e.g. 0.1.0]
+ - Systemair device model: [e.g. Save VTC 300, SaveCair]
+
+## Additional Context
+Add any other context about the problem here, such as code snippets showing how you're using the library.
+
+```python
+# Your code example here
+```

systemair_api_promises-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: '[FEATURE] '
+labels: enhancement
+assignees: ''
+---
+
+## Is your feature request related to a problem? Please describe.
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+## Describe the solution you'd like
+A clear and concise description of what you want to happen. Include any API design ideas or features you would like to see.
+
+## Describe alternatives you've considered
+A clear and concise description of any alternative solutions or features you've considered.
+
+## Use case
+Explain how this feature would be used and who would use it.
+
+## Additional context
+Add any other context or screenshots about the feature request here.

systemair_api_promises-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,34 @@
+## Description
+Please provide a brief summary of the changes. If this PR is fixing an issue, please reference it.
+
+## Type of change
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+- [ ] Refactoring (no functional changes, no API changes)
+- [ ] Performance enhancement
+- [ ] Test addition or update
+- [ ] Build-related changes
+- [ ] Other (please describe):
+
+## How Has This Been Tested?
+Please describe the tests that you added or existing tests that you ran to verify your changes. 
+
+- [ ] Unit tests
+- [ ] Integration tests
+- [ ] Functional tests
+- [ ] Manual tests
+
+## Checklist:
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
+- [ ] I have checked my code and corrected any misspellings

systemair_api_promises-0.1.0/.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,29 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.9'
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build twine
+    
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python -m build
+        twine upload dist/*

systemair_api_promises-0.1.0/.github/workflows/python-tests.yml

@@ -0,0 +1,42 @@
+name: Python Tests
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.7', '3.8', '3.9', '3.10']
+
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[dev]"
+    
+    - name: Lint with flake8
+      run: |
+        flake8 systemair_api
+    
+    - name: Check types with mypy
+      run: |
+        mypy systemair_api
+    
+    - name: Test with pytest
+      run: |
+        pytest --cov=systemair_api
+    
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v3

systemair_api_promises-0.1.0/.gitignore

@@ -0,0 +1,77 @@
+# .gitignore
+
+# Environment variables
+.env
+
+# Python cache files
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# IDE specific files
+.idea/
+.vscode/
+*.swp
+*.swo
+.DS_Store
+
+# Logs
+*.log
+logs/
+
+# Virtual environments
+venv/
+env/
+ENV/
+.env/
+.venv/
+env.bak/
+venv.bak/
+
+# Local development configuration
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# Jupyter notebook
+.ipynb_checkpoints
+*.ipynb
+
+# Package files
+*.tar.gz
+*.tgz
+*.zip
+
+# private notes
+notes/
+# Testing
+.coverage
+htmlcov/
+.pytest_cache/
+coverage.xml
+.pytest_cache/
+.tox/
+nosetests.xml
+.hypothesis/
+
+# Documentation
+/CLAUDE.md
+/TODO.md

systemair_api_promises-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+    -   id: debug-statements
+    -   id: check-merge-conflict
+    -   id: check-toml
+
+-   repo: https://github.com/psf/black
+    rev: 23.7.0
+    hooks:
+    -   id: black
+        language_version: python3
+
+-   repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+    -   id: isort
+
+-   repo: https://github.com/pycqa/flake8
+    rev: 6.1.0
+    hooks:
+    -   id: flake8
+        additional_dependencies: [flake8-docstrings]
+
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.5.1
+    hooks:
+    -   id: mypy
+        additional_dependencies: [types-requests]

systemair_api_promises-0.1.0/CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- GitHub issue templates
+- Pre-commit hooks configuration
+- More comprehensive error handling
+- CONTRIBUTING.md with contribution guidelines
+- CHANGELOG.md to track changes
+- LICENSE file with MIT license
+- MANIFEST.in file for package distribution
+- Development dependencies in requirements-dev.txt
+
+### Changed
+- Improved package setup with proper metadata
+- Enhanced documentation with more usage examples
+- Updated README with PyPI installation instructions
+- Refactored code structure for better organization
+- Improved logging throughout the codebase
+
+### Fixed
+- Token refresh handling
+
+## [0.1.0] - 2025-03-15
+
+### Added
+- Initial release
+- Authentication with Systemair Home Solutions cloud
+- Token management with automatic refresh
+- Real-time monitoring via WebSocket connection
+- Retrieve unit information and status
+- Control ventilation modes and airflow levels
+- Monitor temperatures, humidity, and air quality
+- View and manage alarms
+- Track active functions (heating, cooling, etc.)
+- Unit testing suite with >85% code coverage

systemair_api_promises-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,154 @@
+# Contributing to SystemAIR-API
+
+First off, thank you for considering contributing to SystemAIR-API! We appreciate your time and effort, and every contribution helps make this project better for everyone.
+
+This document provides guidelines and instructions for contributing to the project. Please read it before making any contributions.
+
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [How Can I Contribute?](#how-can-i-contribute)
+- [Development Environment Setup](#development-environment-setup)
+- [Code Style](#code-style)
+- [Testing](#testing)
+- [Pull Request Process](#pull-request-process)
+- [Release Process](#release-process)
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by a Code of Conduct that establishes expected behavior for our community. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+This section guides you through submitting a bug report. Following these guidelines helps maintainers understand your report and reproduce the issue.
+
+- **Use the GitHub issue tracker**
+- **Check if the bug has already been reported**
+- **Use the bug report template**
+- **Provide detailed steps to reproduce**
+- **Describe the behavior you observed and what you expected to see**
+- **Include relevant details about your environment** (OS, Python version, package versions, etc.)
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality.
+
+- **Use the GitHub issue tracker**
+- **Check if the enhancement has already been suggested**
+- **Use the feature request template**
+- **Provide a clear description of the enhancement**
+- **Explain why this enhancement would be useful**
+
+### Code Contributions
+
+#### Pull Requests
+
+- **Submit pull requests from a new branch, not master/main**
+- **Follow the [pull request template](/.github/PULL_REQUEST_TEMPLATE.md)**
+- **Make sure all tests pass**
+- **Add new tests for new functionality**
+- **Update documentation for new features**
+
+## Development Environment Setup
+
+Here's how to set up your development environment to work on SystemAIR-API:
+
+1. **Fork the repository** (click the Fork button at the top right of the repository page)
+
+2. **Clone your fork**:
+   ```bash
+   git clone https://github.com/your-username/SystemAIR-API.git
+   cd SystemAIR-API
+   ```
+
+3. **Set up upstream remote**:
+   ```bash
+   git remote add upstream https://github.com/Promises/SystemAIR-API.git
+   ```
+
+4. **Create a virtual environment and install dependencies**:
+   ```bash
+   python -m venv .venv
+   source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+   
+   # Install the package in development mode
+   pip install -e ".[dev]"
+   # Or install dependencies separately
+   pip install -r requirements.txt
+   pip install -r requirements-dev.txt
+   ```
+
+5. **Set up pre-commit hooks**:
+   ```bash
+   pre-commit install
+   ```
+
+## Code Style
+
+This project follows these code style guidelines:
+
+- **Black** for code formatting with a line length of 88 characters
+- **isort** for import sorting (configured to be compatible with Black)
+- **mypy** for static type checking
+- **flake8** for linting
+
+Pre-commit hooks are set up to run these tools automatically before each commit.
+
+## Testing
+
+All code contributions should include appropriate tests:
+
+- **Write tests for all new functionality**
+- **Ensure existing tests pass for bug fixes**
+- **Run the test suite before submitting a PR**:
+  ```bash
+  pytest
+  ```
+
+- **Check test coverage**:
+  ```bash
+  pytest --cov=systemair_api --cov-report=term --cov-report=html
+  ```
+
+## Pull Request Process
+
+1. **Update your fork with the latest changes from upstream**:
+   ```bash
+   git fetch upstream
+   git checkout main
+   git merge upstream/main
+   git push origin main
+   ```
+
+2. **Create a new branch for your feature or bugfix**:
+   ```bash
+   git checkout -b feature/your-feature-name
+   # or
+   git checkout -b fix/your-bugfix-name
+   ```
+
+3. **Make your changes and commit them with clear, descriptive messages**
+
+4. **Push your branch to GitHub**:
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+5. **Submit a pull request** through the GitHub website
+
+6. **Update your PR if requested** after code review
+
+## Release Process
+
+The project maintainers follow this process for releases:
+
+1. Update version number in appropriate files (setup.py, __init__.py, etc.)
+2. Update CHANGELOG.md with notable changes
+3. Create a new GitHub release with a tag matching the version number
+4. Publish to PyPI
+
+## Questions?
+
+If you have any questions or need help with the contribution process, please open an issue or contact the project maintainers.

systemair_api_promises-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Henning Berge
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

systemair_api_promises-0.1.0/MANIFEST.in

@@ -0,0 +1,14 @@
+include LICENSE
+include README.md
+include requirements.txt
+include pytest.ini
+include pyproject.toml
+include example.env
+recursive-exclude tests *
+recursive-exclude notes *
+recursive-exclude htmlcov *
+recursive-exclude .venv *
+global-exclude *.pyc
+global-exclude __pycache__
+global-exclude *.py[cod]
+global-exclude *$py.class