Skip to content

Commit

Permalink
Merge branch 'feature/table_component_MS' of https://github.com/mckin…
Browse files Browse the repository at this point in the history
…sey/vizro into feat/table_filter_interaction
  • Loading branch information
petar-qb committed Oct 26, 2023
2 parents f79a8e6 + 5a6d6a8 commit 16b3a1c
Show file tree
Hide file tree
Showing 18 changed files with 491 additions and 598 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/check-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ jobs:
cd "${{ needs.check-version.outputs.package_name }}"
git checkout -b "release/version_bump_next_minor/${formatted_date}"
hatch version patch,dev
hatch run docs:changelog
hatch run changelog:add
hatch run schema
hatch run lint || hatch run lint
git config user.email "[email protected]"
Expand Down
9 changes: 3 additions & 6 deletions .github/workflows/lint-vizro-core.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,11 @@ jobs:
run: hatch run all.py${{ matrix.python-version }}:schema --check

- name: Check requirements for Snyk are up to date
run: |
pwd
hatch run all.py${{ matrix.python-version }}:update-snyk-requirements --check
run: hatch run all.py${{ matrix.python-version }}:update-snyk-requirements --check

- name: Find added changelog fragments
id: added-files
run: |
pwd
if ${{ github.event_name == 'pull_request' }}; then
echo "added_files=$(git diff --name-only --diff-filter=A -r HEAD^1 HEAD -- changelog.d/*.md | xargs)" >> $GITHUB_OUTPUT
else
Expand All @@ -68,9 +65,9 @@ jobs:
run: |
if [ -z "${{ steps.added-files.outputs.added_files }}" ];
then
echo "No changelog fragment .md file within changelog.d was detected. Run 'hatch run docs:changelog' to create such a fragment.";
echo "No changelog fragment .md file within changelog.d was detected. Run 'hatch run changelog:add' to create such a fragment.";
echo "If your PR contains changes that should be mentioned in the CHANGELOG in the next release, please uncomment the relevant section in your created fragment and describe the changes to the user."
echo "If your changes are not relevant for the CHANGELOG, please save and commit the file as."
echo "If your changes are not relevant for the CHANGELOG, please save and commit the file as is."
exit 1
else
echo "${{ steps.added-files.outputs.added_files }} was added - ready to go!";
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<!--
A new scriv changelog fragment.
Uncomment the section that is right (remove the HTML comment wrapper).
-->

<!--
### Removed
- A bullet item for the Removed category.
-->
<!--
### Added
- A bullet item for the Added category.
-->
<!--
### Changed
- A bullet item for the Changed category.
-->
<!--
### Deprecated
- A bullet item for the Deprecated category.
-->

### Fixed

- `CapturedCallable` now handles variadic keywords arguments (`**kwargs`) correctly ([#121](https://github.com/mckinsey/vizro/pull/121))

<!--
### Security
- A bullet item for the Security category.
-->
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<!--
A new scriv changelog fragment.
Uncomment the section that is right (remove the HTML comment wrapper).
-->

<!--
### Removed
- A bullet item for the Removed category.
-->
<!--
### Added
- A bullet item for the Added category.
-->
<!--
### Changed
- A bullet item for the Changed category.
-->
<!--
### Deprecated
- A bullet item for the Deprecated category.
-->
<!--
### Fixed
- A bullet item for the Fixed category.
-->
<!--
### Security
- A bullet item for the Security category.
-->
42 changes: 42 additions & 0 deletions vizro-core/changelog.d/20231025_154920_antony.milne_scriv.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<!--
A new scriv changelog fragment.
Uncomment the section that is right (remove the HTML comment wrapper).
-->

<!--
### Removed
- A bullet item for the Removed category.
-->
<!--
### Added
- A bullet item for the Added category.
-->
<!--
### Changed
- A bullet item for the Changed category.
-->
<!--
### Deprecated
- A bullet item for the Deprecated category.
-->
<!--
### Fixed
- A bullet item for the Fixed category.
-->
<!--
### Security
- A bullet item for the Security category.
-->
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified vizro-core/docs/assets/user_guides/table/table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion vizro-core/docs/pages/development/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ a changelog fragment has been created in the folder `changelog.d`. This fragment
You can easily create such a fragment by running

```bash
hatch run docs:changelog
hatch run changelog:add
```

Please begin by uncommenting the relevant section(s) you wish to describe. If your PR includes changes that are not relevant to `CHANGELOG.md`, please leave everything commented out. If you are uncertain about what to add or whether to add anything, please refer to [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). The rule of thumb should be, if in doubt, or if the user is affected in any way, it should be described in the `CHANGELOG.md`.
Expand Down
7 changes: 7 additions & 0 deletions vizro-core/docs/pages/user_guides/custom_charts.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,3 +153,10 @@ The below examples shows a more involved use-case. We create and style a waterfa
[![Graph3]][Graph3]

[Graph3]: ../../assets/user_guides/custom_charts/custom_chart_waterfall.png


???+ warning

Please note that users of this package are responsible for the content of any custom-created component,
function or integration they write - especially with regard to leaking any sensitive information or exposing to
any security threat during implementation.
13 changes: 8 additions & 5 deletions vizro-core/docs/pages/user_guides/custom_components.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,6 @@ In general, you can create a custom component based on any dash-compatible compo
[dash-bootstrap-components](https://dash-bootstrap-components.opensource.faculty.ai/), [dash-html-components](https://github.com/plotly/dash/tree/dev/components/dash-html-components), etc.).


!!!warning
When creating your own custom components, you are responsible for the security of your component (e.g. prevent setting HTML from code which might expose users to cross-site scripting). Vizro cannot guarantee
the security of custom created components, so make sure you keep this in mind when publicly deploying your dashboard.


Vizro's public API is deliberately kept small in order to facilitate quick and easy configuration of a dashboard. However,
at the same time, Vizro is easily extensible, so that you can tweak any component to your liking or even create entirely new ones.

Expand Down Expand Up @@ -354,3 +349,11 @@ vm.Page.add_type("components", Jumbotron)
[![CustomComponent2]][CustomComponent2]

[CustomComponent2]: ../../assets/user_guides/custom_components/customcomponent_2.png



???+ warning

Please note that users of this package are responsible for the content of any custom-created component,
function or integration they write - especially with regard to leaking any sensitive information or exposing to
any security threat during implementation.
8 changes: 8 additions & 0 deletions vizro-core/docs/pages/user_guides/integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,11 @@ register the datasets with [`kedro_datasets.pandas`](https://docs.kedro.org/en/s
for dataset_name, dataset in kedro_integration.datasets_from_catalog(catalog).items():
data_manager[dataset_name] = dataset
```



???+ warning

Please note that users of this package are responsible for the content of any custom-created component,
function or integration they write - especially with regard to leaking any sensitive information or exposing to
any security threat during implementation.
Loading

0 comments on commit 16b3a1c

Please sign in to comment.