From 3a6288d0896061550f5093ed1dffd4c8d5705b4d Mon Sep 17 00:00:00 2001 From: lamesjaidler Date: Mon, 3 Jun 2024 13:57:37 +0100 Subject: [PATCH 1/5] Added __init__ to assets folder --- agridable/assets/__init__.py | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 agridable/assets/__init__.py diff --git a/agridable/assets/__init__.py b/agridable/assets/__init__.py new file mode 100644 index 0000000..e69de29 From f1c6f4af9194244aacb8b4b56f41580f2a01016b Mon Sep 17 00:00:00 2001 From: lamesjaidler Date: Mon, 3 Jun 2024 13:57:55 +0100 Subject: [PATCH 2/5] Added include_package_data=True to setup.py --- setup.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 5d15d0f..4fbdd87 100644 --- a/setup.py +++ b/setup.py @@ -40,5 +40,7 @@ ], python_requires='>=3.12', long_description=long_description, - long_description_content_type='text/markdown' + long_description_content_type='text/markdown', + + include_package_data=True ) From a85f06a9d13d27a897d0c1a49a01e6963ce35d9a Mon Sep 17 00:00:00 2001 From: lamesjaidler Date: Mon, 3 Jun 2024 13:58:09 +0100 Subject: [PATCH 3/5] Added include_package_data=True to setup.py --- setup.py | 1 - 1 file changed, 1 deletion(-) diff --git a/setup.py b/setup.py index 4fbdd87..6c894d5 100644 --- a/setup.py +++ b/setup.py @@ -41,6 +41,5 @@ python_requires='>=3.12', long_description=long_description, long_description_content_type='text/markdown', - include_package_data=True ) From 28d7562ab741f4575b295c926081e99daa5c8994 Mon Sep 17 00:00:00 2001 From: lamesjaidler Date: Mon, 3 Jun 2024 13:58:34 +0100 Subject: [PATCH 4/5] Added MANIFEST.in with include agridable/assets/* (ensures JS and CSS files included in python package) --- MANIFEST.in | 1 + 1 file changed, 1 insertion(+) create mode 100644 MANIFEST.in diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..97219cf --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1 @@ +include agridable/assets/* \ No newline at end of file From 18451b82803288029649d9e7c90c2391467210da Mon Sep 17 00:00:00 2001 From: lamesjaidler Date: Mon, 3 Jun 2024 13:58:58 +0100 Subject: [PATCH 5/5] Updated readme.md (removed old instructions for copying JS and CSS files) --- readme.md | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/readme.md b/readme.md index 17c9da7..3c944ec 100644 --- a/readme.md +++ b/readme.md @@ -15,7 +15,7 @@ whilst working at [Electrify Video Partners](https://electrify.video/). # Quickstart -## Install Python Library +## Install AGridable First, it's good practice to create a virtual environment to install **AGridable** into; here, we're using conda: @@ -35,15 +35,6 @@ Then install the AGridable library: pip install agridable ``` -## Transfer JS and CSS files - -**AGridable** relies on some standard Javascript functions and CSS formats; -these can be found in the [assets](./agridable/assets) folder. You must either: - -1) Copy these files into the assets folder of your Dash app, or; -2) If you already have versions of these files, append the functions and -formats in these files to the relevant files of your Dash app. - ## Use AGridable The best way to get started with **AGridable** is to look at the examples in the [examples](./examples) folder. These contain simple Dash apps that showcase how **AGridable** can be used to quickly and easily format a dataframe.