Releases: xability/py-maidr
v0.10.4
v0.10.3
v0.10.3 (2024-12-06)
Bug Fixes
- Update repository references from 'py_maidr' to 'py-maidr' (
9749835
)
Chores
- vscode: Format settings.json for clarity (
2040c4a
)
Documentation
-
Update quartodoc to include getting started and examples (#110,
a95ff96
) -
example: Simplify plot titles in demo.qmd for clarity (
1e72335
)
Detailed Changes: v0.10.2...v0.10.3
v0.10.2
v0.10.1
v0.10.0
v0.9.2
v0.9.1
v0.9.1 (2024-10-08)
Chores
- chore(semantic-release): update
exclude_commit_patterns
in pyproject.toml to clean up CHANGELOG (794816d
)
Documentation
Fixes
v0.9.0
v0.9.0 (2024-09-13)
Feature
- feat: fetch LLM API keys from user env variables (#102)
<!-- Suggested PR Title: [feat/fix/refactor/perf/test/ci/docs/chore]
brief description of the change -->
<!-- Please follow Conventional Commits:
https://www.conventionalcommits.org/en/v1.0.0/ -->
Description
This pull request fixes the handling of API keys for LLMs in the code.
It adds a JavaScript script to handle the API keys for LLMs and
initializes the LLM secrets in the MAIDR instance. The script injects
the LLM API keys into the MAIDR instance and sets the appropriate
settings based on the presence of the Gemini and OpenAI API keys. This
ensures that the LLM functionality works correctly with the updated API
key handling.
closes #76
Type of Change
- Bug fix
- New feature
- Breaking change (fix or feature that would cause existing
functionality to not work as expected) - Documentation update
Checklist
- My code follows the style guidelines of this project
- I have performed a self-review of my 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
- Any dependent changes have been merged and published in downstream
modules
Pull Request
Description
- Added a new method called
initialize_llm_secrets()
in
environment.py which fetches the keys from the environment variable. - Injected the script when the maidr iframe loads initially.
Checklist
<!-- Please select all applicable options. -->
<!-- To select your options, please put an 'x' in the all boxes that
apply. -->
- I have read the Contributor Guidelines.
- I have performed a self-review of my own code and ensured it
follows the project's coding standards. - I have tested the changes locally following
ManualTestingProcess.md
, and all tests related to this pull request
pass. - I have commented my code, particularly in hard-to-understand
areas. - I have updated the documentation, if applicable.
- I have added appropriate unit tests, if applicable.
Additional Notes
<!-- Add any additional notes or comments here. -->
<!-- Template credit: This pull request template is based on Embedded
Artistry
{https://github.com/embeddedartistry/templates/blob/master/.github/PULL_REQUEST_TEMPLATE.md},
Clowder
{https://github.com/clowder-framework/clowder/blob/develop/.github/PULL_REQUEST_TEMPLATE.md},
and TalAter {https://github.com/TalAter/open-source-templates}
templates. --> (fc84593
)
v0.8.0
v0.7.0
v0.7.0 (2024-08-24)
Ci
- ci: rectify commit-lint job crash (#92)
<!-- Suggested PR Title: [feat/fix/refactor/perf/test/ci/docs/chore]
brief description of the change -->
<!-- Please follow Conventional Commits:
https://www.conventionalcommits.org/en/v1.0.0/ -->
Description
This PR resolves an issue related to the commit-lint
job in
.github/workflows/ci.yml
.
Closes [#91]
Type of Change
- Bug fix
- New feature
- Breaking change (fix or feature that would cause existing
functionality to not work as expected) - Documentation update
Checklist
- My code follows the style guidelines of this project
- I have performed a self-review of my 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
- Any dependent changes have been merged and published in downstream
modules
Pull Request
Description
This PR addresses an issue where commit-lint
job crashes when
validating pull requests.
Changes Made
Currently, the commitlint config file is getting loaded as an ES module
whilst it contains vanilla javascript configurations. This causes the
job to crash because it expects a common javascript config but finds an
ES module config. To address this issue The commit-lint config file has
been changed to a common-js
file instead of a js
file and the
conventional commit dependancy will now be installed during the job via
npm.
Screenshots (if applicable)
After making the changes, I tested the commit-lint job locally and here
is an excerpt of the execution:
(py-maidr) ➜ py_maidr git:(Krishna/fix-commitlint) act -j commit-lint -W .github/workflows/ci.yml --container-architecture linux/amd64
INFO[0000] Using docker host 'unix:///var/run/docker.sock', and daemon socket 'unix:///var/run/docker.sock'
[CI/commit-lint] 🚀 Start image=catthehacker/ubuntu:act-latest
INFO[0000] Parallel tasks (0) below minimum, setting to 1
[CI/commit-lint] 🐳 docker pull image=catthehacker/ubuntu:act-latest platform=linux/amd64 username= forcePull=true
[CI/commit-lint] using DockerAuthConfig authentication for docker pull
INFO[0001] Parallel tasks (0) below minimum, setting to 1
[CI/commit-lint] 🐳 docker create image=catthehacker/ubuntu:act-latest platform=linux/amd64 entrypoint=["tail" "-f" "/dev/null"] cmd=[] network="host"
[CI/commit-lint] 🐳 docker run image=catthehacker/ubuntu:act-latest platform=linux/amd64 entrypoint=["tail" "-f" "/dev/null"] cmd=[] network="host"
[CI/commit-lint] ☁ git clone 'https://github.com/wagoid/commitlint-github-action' # ref=v6
[CI/commit-lint] ⭐ Run Main actions/checkout@v3
[CI/commit-lint] 🐳 docker cp src=/Users/krishnaanandan/Desktop/maidr_krishna/py_maidr/. dst=/Users/krishnaanandan/Desktop/maidr_krishna/py_maidr
[CI/commit-lint] ✅ Success - Main actions/checkout@v3
[CI/commit-lint] ⭐ Run Main Install commitlint dependencies
[CI/commit-lint] 🐳 docker exec cmd=[bash --noprofile --norc -e -o pipefail /var/run/act/workflow/1] user= workdir=
|
| added 11 packages in 3s
|
| 1 package is looking for funding
| run `npm fund` for details
[CI/commit-lint] ✅ Success - Main Install commitlint dependencies
[CI/commit-lint] ⭐ Run Main Lint commit messages
[CI/commit-lint] 🐳 docker pull image=wagoid/commitlint-github-action:6.1.1 platform=linux/amd64 username= forcePull=true
[CI/commit-lint] using DockerAuthConfig authentication for docker pull
[CI/commit-lint] 🐳 docker create image=wagoid/commitlint-github-action:6.1.1 platform=linux/amd64 entrypoint=[] cmd=[] network="container:act-CI-commit-lint-6b355268bbbb8e27234c3c935b66fc686b070544b9a3b02b47d79688837a12ff"
[CI/commit-lint] 🐳 docker run image=wagoid/commitlint-github-action:6.1.1 platform=linux/amd64 entrypoint=[] cmd=[] network="container:act-CI-commit-lint-6b355268bbbb8e27234c3c935b66fc686b070544b9a3b02b47d79688837a12ff"
| Lint free! 🎉
[CI/commit-lint] ✅ Success - Main Lint commit messages
[CI/commit-lint] ⚙ ::set-output:: results=[]
[CI/commit-lint] Cleaning up container for job commit-lint
[CI/commit-lint] 🏁 Job succeeded
(py-maidr) ➜ py_maidr git:(Krishna/fix-commitlint)
Checklist
<!-- Please select all applicable options. -->
<!-- To select your options, please put an 'x' in the all boxes that
apply. -->
- I have read the Contributor Guidelines.
- I have performed a self-review of my own code and ensured it
follows the project's coding standards. - I have tested the changes locally following
ManualTestingProcess.md
, and all tests related to this pull request
pass. - I have commented my code, particularly in hard-to-understand
areas. - I have updated the documentation, if applicable.
- I have added appropriate unit tests, if applicable. (
ae50904
)
- ci(commitlint): disable commitlint line length and total length checking (#87)