pydiagral 1.0.0__tar.gz → 1.2.0__tar.gz

Sign up to get free protection for your applications and to get access to all the features.
Files changed (40) hide show
  1. {pydiagral-1.0.0 → pydiagral-1.2.0}/.github/workflows/labeler.yml +1 -1
  2. {pydiagral-1.0.0 → pydiagral-1.2.0}/.github/workflows/pytest.yaml +1 -1
  3. pydiagral-1.0.0/.github/workflows/release.yaml → pydiagral-1.2.0/.github/workflows/release_and_doc.yaml +38 -2
  4. {pydiagral-1.0.0 → pydiagral-1.2.0}/.github/workflows/semantic-prs.yml +1 -1
  5. {pydiagral-1.0.0 → pydiagral-1.2.0}/.gitignore +2 -2
  6. {pydiagral-1.0.0 → pydiagral-1.2.0}/.releaserc +1 -0
  7. {pydiagral-1.0.0 → pydiagral-1.2.0}/CHANGELOG.md +14 -0
  8. {pydiagral-1.0.0 → pydiagral-1.2.0}/PKG-INFO +3 -3
  9. {pydiagral-1.0.0 → pydiagral-1.2.0}/README.md +2 -2
  10. {pydiagral-1.0.0 → pydiagral-1.2.0}/src/pydiagral/api.py +1 -4
  11. pydiagral-1.2.0/test.txt +1 -0
  12. pydiagral-1.0.0/.github/workflows/docs.yaml +0 -39
  13. {pydiagral-1.0.0 → pydiagral-1.2.0}/.devcontainer/Dockerfile.dev +0 -0
  14. {pydiagral-1.0.0 → pydiagral-1.2.0}/.devcontainer/devcontainer.json +0 -0
  15. {pydiagral-1.0.0 → pydiagral-1.2.0}/.github/FUNDING.yml +0 -0
  16. {pydiagral-1.0.0 → pydiagral-1.2.0}/.github/dependabot.yml +0 -0
  17. {pydiagral-1.0.0 → pydiagral-1.2.0}/.github/labels.yml +0 -0
  18. {pydiagral-1.0.0 → pydiagral-1.2.0}/.github/workflows/lint.yaml +0 -0
  19. {pydiagral-1.0.0 → pydiagral-1.2.0}/.github/workflows/lock.yml +0 -0
  20. {pydiagral-1.0.0 → pydiagral-1.2.0}/.vscode/extensions.json +0 -0
  21. {pydiagral-1.0.0 → pydiagral-1.2.0}/.vscode/settings.json +0 -0
  22. {pydiagral-1.0.0 → pydiagral-1.2.0}/LICENSE +0 -0
  23. {pydiagral-1.0.0 → pydiagral-1.2.0}/docs/api.md +0 -0
  24. {pydiagral-1.0.0 → pydiagral-1.2.0}/docs/exceptions.md +0 -0
  25. {pydiagral-1.0.0 → pydiagral-1.2.0}/docs/how-to-find-diagral-serial.png +0 -0
  26. {pydiagral-1.0.0 → pydiagral-1.2.0}/docs/index.md +0 -0
  27. {pydiagral-1.0.0 → pydiagral-1.2.0}/docs/models.md +0 -0
  28. {pydiagral-1.0.0 → pydiagral-1.2.0}/docs/pydiagral-Logo.png +0 -0
  29. {pydiagral-1.0.0 → pydiagral-1.2.0}/example_code.py +0 -0
  30. {pydiagral-1.0.0 → pydiagral-1.2.0}/mkdocs.yml +0 -0
  31. {pydiagral-1.0.0 → pydiagral-1.2.0}/pyproject.toml +0 -0
  32. {pydiagral-1.0.0 → pydiagral-1.2.0}/src/pydiagral/__init__.py +0 -0
  33. {pydiagral-1.0.0 → pydiagral-1.2.0}/src/pydiagral/constants.py +0 -0
  34. {pydiagral-1.0.0 → pydiagral-1.2.0}/src/pydiagral/exceptions.py +0 -0
  35. {pydiagral-1.0.0 → pydiagral-1.2.0}/src/pydiagral/models.py +0 -0
  36. {pydiagral-1.0.0 → pydiagral-1.2.0}/src/pydiagral/utils.py +0 -0
  37. {pydiagral-1.0.0 → pydiagral-1.2.0}/tests/__init__.py +0 -0
  38. {pydiagral-1.0.0 → pydiagral-1.2.0}/tests/data/configuration_sample.json +0 -0
  39. {pydiagral-1.0.0 → pydiagral-1.2.0}/tests/data/system_details_sample.json +0 -0
  40. {pydiagral-1.0.0 → pydiagral-1.2.0}/tests/test_pydiagral_api.py +0 -0
@@ -16,6 +16,6 @@ jobs:
16
16
  uses: actions/checkout@v4
17
17
 
18
18
  - name: Run Labeler
19
- uses: crazy-max/ghaction-github-labeler@v5.0.0
19
+ uses: crazy-max/ghaction-github-labeler@v5.2.0
20
20
  with:
21
21
  skip-delete: true
@@ -21,7 +21,7 @@ jobs:
21
21
  uses: actions/checkout@v4
22
22
 
23
23
  - name: Set up Python
24
- uses: actions/setup-python@v4
24
+ uses: actions/setup-python@v5
25
25
  with:
26
26
  python-version: '3.12' # Replace with the version of Python you are using
27
27
 
@@ -1,4 +1,4 @@
1
- name: Generate Release and publish to PyPI
1
+ name: Generate Release and publish to PyPI + Doc Generation
2
2
 
3
3
  on:
4
4
  push:
@@ -13,6 +13,9 @@ jobs:
13
13
  runs-on: ubuntu-latest
14
14
  environment:
15
15
  name: Semver
16
+ outputs:
17
+ new_release_version: ${{ steps.semantic.outputs.new_release_version }}
18
+ new_release_published: ${{ steps.semantic.outputs.new_release_published }}
16
19
  steps:
17
20
  - name: Checkout
18
21
  uses: actions/checkout@v4
@@ -20,7 +23,7 @@ jobs:
20
23
  fetch-depth: 0
21
24
 
22
25
  - name: Set up Python
23
- uses: actions/setup-python@v4
26
+ uses: actions/setup-python@v5
24
27
  with:
25
28
  python-version: "3.10"
26
29
 
@@ -55,3 +58,36 @@ jobs:
55
58
  - name: Publish to PyPI
56
59
  if: steps.semantic.outputs.new_release_published == 'true'
57
60
  run: twine upload dist/* -u __token__ -p "${{ secrets.PYPI_TOKEN }}"
61
+
62
+ deploy-docs:
63
+ runs-on: ubuntu-latest
64
+ needs: release
65
+ if: needs.release.outputs.new_release_published == 'true'
66
+ steps:
67
+ - name: Checkout Code
68
+ uses: actions/checkout@v4
69
+ with:
70
+ ref: ${{ github.event.inputs.release || github.ref }}
71
+
72
+ - name: Set up Python
73
+ uses: actions/setup-python@v5
74
+ with:
75
+ python-version: '3.12'
76
+
77
+ - name: Set the PYPROJECT_VERSION environment variable
78
+ run: echo "PYPROJECT_VERSION=${{ needs.release.outputs.new_release_version }}" >> $GITHUB_ENV
79
+
80
+ - name: Install dependencies
81
+ run: |
82
+ pip install --upgrade pip
83
+ pip install mkdocs mkdocstrings[python] mkdocs-material
84
+ pip install -e .
85
+
86
+ - name: Build documentation
87
+ run: mkdocs build --strict --verbose
88
+
89
+ - name: Deploy to GitHub Pages
90
+ uses: peaceiris/actions-gh-pages@v4
91
+ with:
92
+ github_token: ${{ secrets.GITHUB_TOKEN }}
93
+ publish_dir: ./site
@@ -14,7 +14,7 @@ jobs:
14
14
  name: Validate PR title
15
15
  runs-on: ubuntu-latest
16
16
  steps:
17
- - uses: ytanikin/PRConventionalCommits@1.2.0
17
+ - uses: ytanikin/PRConventionalCommits@1.3.0
18
18
  with:
19
19
  task_types: '["feat","fix","docs","test","ci","refactor","perf","chore"]'
20
20
  custom_labels: '{"feat": "feature", "fix": "bug", "docs": "documentation", "test": "testing", "ci": "ci", "refactor": "refactoring", "perf": "performance", "chore": "chore"}'
@@ -161,5 +161,5 @@ cython_debug/
161
161
  # option (not recommended) you can uncomment the following to ignore the entire idea folder.
162
162
  #.idea/
163
163
 
164
- # Exclusion of env file
165
- .env
164
+ # Exclusion of .DS_Store
165
+ .DS_Store
@@ -3,6 +3,7 @@
3
3
  "main",
4
4
  {
5
5
  "name": "beta",
6
+ "channel": "beta",
6
7
  "prerelease": true
7
8
  }
8
9
  ],
@@ -1,3 +1,17 @@
1
+ # [1.2.0](https://github.com/mguyard/pydiagral/compare/v1.1.0...v1.2.0) (2025-02-22)
2
+
3
+
4
+ ### Features
5
+
6
+ * test1 ([e7bf5e6](https://github.com/mguyard/pydiagral/commit/e7bf5e6a4a72121a98e413541a0699d195190612))
7
+
8
+ # [1.1.0](https://github.com/mguyard/pydiagral/compare/v1.0.0...v1.1.0) (2025-02-22)
9
+
10
+
11
+ ### Features
12
+
13
+ * test ([75ec27f](https://github.com/mguyard/pydiagral/commit/75ec27f885ce4e9be08b3b194446d49709d5107d))
14
+
1
15
  # 1.0.0 (2025-02-22)
2
16
 
3
17
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: pydiagral
3
- Version: 1.0.0
3
+ Version: 1.2.0
4
4
  Summary: A Python library for interacting with Diagral systems
5
5
  Project-URL: Homepage, https://github.com/mguyard/pydiagral
6
6
  Project-URL: Documentation, https://github.com/mguyard/pydiagral
@@ -720,8 +720,8 @@ Description-Content-Type: text/markdown
720
720
  <a href="https://github.com/mguyard/pydiagral/actions/workflows/lint.yaml" target="_blank">
721
721
  <img src="https://github.com/mguyard/pydiagral/actions/workflows/lint.yaml/badge.svg" alt="Python Lint Action">
722
722
  </a>
723
- <a href="https://github.com/mguyard/pydiagral/actions/workflows/docs.yaml" target="_blank">
724
- <img src="https://github.com/mguyard/pydiagral/actions/workflows/docs.yaml/badge.svg" alt="Docs Build Action">
723
+ <a href="https://github.com/mguyard/pydiagral/actions/workflows/release_and_doc.yaml" target="_blank">
724
+ <img src="https://github.com/mguyard/pydiagral/actions/workflows/release_and_doc.yaml/badge.svg" alt="Release & Doc Action">
725
725
  </a>
726
726
  <p>
727
727
  <p align="center">
@@ -19,8 +19,8 @@
19
19
  <a href="https://github.com/mguyard/pydiagral/actions/workflows/lint.yaml" target="_blank">
20
20
  <img src="https://github.com/mguyard/pydiagral/actions/workflows/lint.yaml/badge.svg" alt="Python Lint Action">
21
21
  </a>
22
- <a href="https://github.com/mguyard/pydiagral/actions/workflows/docs.yaml" target="_blank">
23
- <img src="https://github.com/mguyard/pydiagral/actions/workflows/docs.yaml/badge.svg" alt="Docs Build Action">
22
+ <a href="https://github.com/mguyard/pydiagral/actions/workflows/release_and_doc.yaml" target="_blank">
23
+ <img src="https://github.com/mguyard/pydiagral/actions/workflows/release_and_doc.yaml/badge.svg" alt="Release & Doc Action">
24
24
  </a>
25
25
  <p>
26
26
  <p align="center">
@@ -134,7 +134,7 @@ class DiagralAPI:
134
134
  method (str): The HTTP method to use for the request (e.g., 'GET', 'POST').
135
135
  endpoint (str): The API endpoint to send the request to.
136
136
  timeout (float, optional): The timeout for the request in seconds. Defaults to 30.
137
- **kwargs: Additional keyword arguments to pass to the request.
137
+ **kwargs (any): Additional keyword arguments to pass to the request.
138
138
 
139
139
  Returns:
140
140
  tuple[dict[str, Any], int]: A tuple containing:
@@ -589,7 +589,6 @@ class DiagralAPI:
589
589
  Raises:
590
590
  ConfigurationError: If the action is not one of the allowed actions.
591
591
  AuthenticationError: If the API key, secret key, or PIN code is missing.
592
- All other exceptions from _request function are propagated.
593
592
 
594
593
  """
595
594
 
@@ -714,7 +713,6 @@ class DiagralAPI:
714
713
  Raises:
715
714
  ConfigurationError: If the action is not 'activate_group' or 'disable_group', or if the groups are invalid.
716
715
  AuthenticationError: If the API key, secret key, or PIN code is not provided.
717
- All other exceptions from _request function are propagated.
718
716
 
719
717
  """
720
718
 
@@ -834,7 +832,6 @@ class DiagralAPI:
834
832
  Raises:
835
833
  ConfigurationError: If the action is not 'enable' or 'disable', or if the product type is invalid.
836
834
  AuthenticationError: If the API key, secret key, or PIN code is not provided.
837
- All other exceptions from _request function are propagated.
838
835
 
839
836
  """
840
837
 
@@ -0,0 +1 @@
1
+ test
@@ -1,39 +0,0 @@
1
- name: Generate and Deploy Documentation
2
-
3
- on:
4
- release:
5
- types: [published]
6
- workflow_dispatch:
7
- inputs:
8
- release:
9
- description: 'Release to generate and deploy documentation for'
10
- required: true
11
- default: 'latest'
12
-
13
- jobs:
14
- deploy-docs:
15
- runs-on: ubuntu-latest
16
- steps:
17
- - name: Checkout Code
18
- uses: actions/checkout@v4
19
- with:
20
- ref: ${{ github.event.inputs.release || github.ref }}
21
-
22
- - name: Set up Python
23
- uses: actions/setup-python@v4
24
- with:
25
- python-version: '3.12'
26
-
27
- - name: Install dependencies
28
- run: |
29
- pip install --upgrade pip
30
- pip install mkdocs mkdocstrings[python] mkdocs-material
31
-
32
- - name: Build documentation
33
- run: mkdocs build --strict
34
-
35
- - name: Deploy to GitHub Pages
36
- uses: peaceiris/actions-gh-pages@v4
37
- with:
38
- github_token: ${{ secrets.GITHUB_TOKEN }}
39
- publish_dir: ./site
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes