- Update actions/cache to v4
(
4cd8533)
-
Add CNAME under docs directory (
54de423) -
Adjust figure sizes and formatting in examples.qmd (#126,
5bf07f3) -
Simplify Google Colab link in examples.qmd (
229a3ac) -
Update endpoint url in quartodoc (
9aa93b5) -
Update keyboard shortcuts for Windows, Linux, and Mac (
c1ff8c8) -
Update README to include user guide and example pointers (
dd3fe56)
- Add CNAME file to redirect to py.maidr.ai
(
0268394)
- Update repository references from 'py_maidr' to 'py-maidr'
(
9749835)
- vscode: Format settings.json for clarity
(
2040c4a)
-
Update index.qmd to improve example clarity and remove unused plots (
783d7d8) -
Update quartodoc to include getting started and examples (#110,
a95ff96) -
example: Simplify plot titles in demo.qmd for clarity (
1e72335)
-
Address dynamic resizing of iframes on ipython (#123,
3159fc1) -
Correct import statement in maidr.py (
e7d072a)
- example: Replace
py-shinyfolder name withshiny(4bb9e77)
Co-authored-by: JooYoung Seo [email protected]
- semantic-release: Update
exclude_commit_patternsin pyproject.toml to clean up CHANGELOG (794816d)
-
vscode: Add a missing space to window title format in
.vscode/settings.json(aa739d3) -
vscode: Add Copilot instructions for coding style and documentation (
b7037d8) -
vscode: Refine Copilot instruction (
f049b44)
-
Sort out semantic release config to display
featandfixfirst in the release notes (529c721) -
semantic-release: Exclude non-conventional commits from
CHANGELOG(#106,d40a95c)
This pull request updates the exclude_commit_patterns in the pyproject.toml file. The previous
commits that don't match the conventional commits prefixes and internal changes that do not
necessarily affect end-user interactions, such as chore, ci, and style, are excluded from
our CHANGELOG and GitHub release note moving forward. This is not a direct fix, but after this
change, it ensures that only relevant commits are included in the release changelog as a fair
stopgap solution.
Closes #99
capabilities with maidr.
closes #84
- Bug fix - [ ] New feature - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] Documentation update
- My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [x] I have commented my code, particularly in hard-to-understand areas - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] Any dependent changes have been merged and published in downstream modules
directory.
src="https://github.com/user-attachments/assets/bf3b5630-2e71-4057-87ad-5b9ca0940769">
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
- Bug fix - [ ] New feature - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] Documentation update
- My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [x] I have commented my code, particularly in hard-to-understand areas - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] Any dependent changes have been merged and published in downstream modules
fetches the keys from the environment variable. 2. Injected the script when the maidr iframe loads initially.
an 'x' in the all boxes that apply. -->
- I have read the Contributor Guidelines. - [x] I have performed a
self-review of my own code and ensured it follows the project's coding standards. - [x] I have
tested the changes locally following
ManualTestingProcess.md, and all tests related to this pull request pass. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation, if applicable. - [x] I have added appropriate unit tests, if applicable.
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. -->
-
Move
blackformatter todevdependencies (ca460b4) -
Remove
sphinxfrom package dev dependencies (41f61a9)
-
Clean up messy CHANGELOG (
20785a8) -
Hide
choreandciupdates from future release notes (e886067) -
Update
poetry.lock(ac89fd7)
This PR resolves an issue related to the commit-lint job in .github/workflows/ci.yml.
Closes [#91]
- Bug fix - [ ] New feature - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] Documentation update
- My code follows the style guidelines of this project - [X] 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 - [X] My changes generate no new warnings - [ ] Any dependent changes have been merged and published in downstream modules
requests.
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.
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) ```
an 'x' in the all boxes that apply. -->
-
I have read the Contributor Guidelines. - [X] I have performed a self-review of my own code and ensured it follows the project's coding standards. - [X] 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. -
commitlint: Disable commitlint line length and total length checking (#87,
3f718a7)
closes #86
Added bug report and feature request templates to improve the issue creation process. These templates provide a standardized structure for reporting bugs and requesting new features, making it easier for contributors to provide clear and concise information. This will help streamline the issue triage and resolution process.
The bug report template includes sections for describing the bug, steps to reproduce, actual and expected behavior, screenshots, and additional information. The feature request template includes sections for describing the requested feature, motivation, proposed solution, and additional context.
This commit follows the established commit message convention of starting with a verb in the imperative form, followed by a brief description of the change. It also includes a type prefix ("feat") to indicate that it is a new feature.
closes #80
- vscode: Update shiny extension
(
483a075)
- vscode: Update settings to use numpy docstring
(
e9b0c4d)
- example: Take out unused param from seaborn barplot example
(
a58001d)
Bumps black from 23.3.0 to 24.3.0. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: black dependency-type: direct:development
...
Signed-off-by: dependabot[bot] [email protected]
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
docs.yml automates the publishing of py-maidr documentation to GitHub Pages. This builds the
static sources using quarto for the website and quartodoc for the API Reference. The rendering
and publishing are accomplished using Quarto's github actions, which can be found at
https://github.com/quarto-dev/quarto-actions.
Resolves: #43
Combined the black, commit-message-lint, and the unit test workflow into one called ci.yml. This is beneficial because it could be reused in the release pipeline.
Resolves: #39
release.yml configures the github workflow to lint the commit message, format of the code, and the
unit tests. After successfully completing those jobs, the pipeline builds the package, updates the
semantic version according to the commit message and publishes to the GitHub Release as well as to
the PyPi.
Resolves: #41
_quarto.yml includes the base structure of the static website with a navbar and the main site. The
navbar includes 'Overview', 'Get Started', and 'API Referece' sections, which are structured in
_index.qmd, _get_started.qmd, and the quartodoc section of _quarto.yml respectively.
Currently, the 'Overview' and 'Get Started' sections are left empty, which will be generated in
the upcoming releases. The 'API Reference' section will include the docstring in a neat format
generated by quartodoc.
Resolves: #17
-
feat: use htmltools instead of str
-
feat: show html using htmltools
-
chore: move mixin to utils package
-
Update pyproject.toml version and htmltools dependency (#14,
fcaca48) -
version: Start from 0.0.1 (
6bf23bb)
-
Add homepage URL to pyproject.toml (
582a23f) -
Add more vscode settings and extensions (
0bf19ba) -
Remove spellright extension (
85b7bdf) -
Update project homepage URL (
2aeb15c) -
Update pyproject.toml with additional metadata (
314cd38) -
Use copilot to describe pr (
5bc8803) -
.vscode: 🔧 add conventional commits settings (
7cb39cd) -
.vscode: 🔧 add conventional commits settings (
e8e782f) -
.vscode: Add conventional commits extensions (
492d23f) -
vscode: Add git.ignoreRebaseWarning setting to .vscode/settings.json (
97c27a8) -
vscode: Add GitLens extension (
3491ecc) -
vscode: Add ms-python.debugpy extension to extensions.json (
ac1b619) -
vscode: Remove brackets from the title (
99ecd10) -
vscode: Update window title in VS Code settings.json (
065800e)
-
✨ add conventional commits linter to gh action (
fc4b758) -
🔧 add python-semantic-release dependencies and settings (
f928eff) -
🔧 fix commmit linter gh action to be triggered against the latest commit only (
dbb86d3) -
🔧 fix commmit linter gh action to be triggered against the latest commit only (
f53251c) -
Add conventional commits linter to gh workflowFixes #5 (
f1babab)
- ci: add conventional commits linter to gh workflow Fixes #5
-
Add CHANGELOG file (
f19c78c) -
Add code of conduct (
777f850) -
Add CONTRIBUTING.md file (
2e4cf10) -
Add development environment setup instructions (
36ecba2)
-
docs: add documentation for classes and methods, following numpy docstring style
-
fix: convert maidr data to numpy array
-
docs: add docstring
-
chore: change | none to optional typing
-
chore: rever to | none typing
Co-authored-by: SaaiVenkat [email protected]
-
Update installation instructions in README.md (
a5134ed) -
Update py-maidr installation instructions (
0185aec) -
readme: Add logo (
8702ce5) -
readme: Update base URL (
6463477)
-
feat: redesign python binder
-
docs: add example bar plot
-
scatter: Support matplotlib and seaborn library (#30,
d2d1202) -
stacked: Support maidr for matplotlib and seaborn (#28,
9e95186)
-
test(barplot): add unit tests for barplot
-
chore: add mocks for inputs
-
test: add common fixtures
-
chore: correct test input
-
test: add unit tests for bar plot
-
test: add tox workflow
-
test: add correct python version
-
test: remove non-deterministic assert comment