Fixed open_browser issue and added functionality for map and config file #6

ikespand · 2020-07-17T15:46:00Z

Fixed issue-2 regarding the 'open_browser=False still opens browser '
added functionality to save maps at custom location
added functionality to use a custom json config file
added corresponding changes to the README.md

…ation

…fault config JSON

ashirwad · 2022-09-01T04:42:52Z

Hey @kylebarron, do you plan to merge this pull request? The addition of output_map and config_file arguments make this excellent tool that you have written even more flexible!

kylebarron · 2022-09-01T09:00:09Z

This PR is stale and has merge conflicts/needs to be updated with master. but in principle not opposed to merging

ashirwad · 2022-09-01T15:47:35Z

Ok. Do you plan to add those two arguments in the near future? That would be really helpful!

kylebarron · 2022-09-01T15:50:04Z

I don't have plans to work on this repo myself, but PRs are welcome. It probably wouldn't be too hard to update this PR with changes in master

ikespand · 2022-09-01T15:51:09Z

Hey guys. I will resolve the conflicts by today and will commit again.

…SON and provide open_browser in init

ikespand · 2022-09-01T20:38:37Z

@kylebarron : Resolved and revised. If you've any feedbacks then let me know. And if you decide to merge then you might need to change date in CHANGELOG.md.

ashirwad · 2022-09-01T20:41:06Z

Thanks @ikespand! Hope @kylebarron merges these changes soon. :)

kylebarron

Generally a good approach but some comments. Also, any new parameters to the Python API should also be reflected in the CLI as well

kylebarron · 2022-09-03T14:21:00Z

keplergl_cli/keplergl_cli.py

+                `config_file` provides the path of config file.
+                `output_map` provides the location html file, if none then will
+                be dumped to temporaty files.
+                `open_browser` enables the browser opening if data is provided.


These params should be in the same format as data above

kylebarron · 2022-09-03T14:22:05Z

keplergl_cli/keplergl_cli.py

@@ -40,14 +40,21 @@ def __init__(
            names=None,
            read_only=False,
            api_key=None,
-            style=None):
+            style=None,
+            config_file=None,


IMO this should accept a config as a python dict, not as a path to a file

kylebarron · 2022-09-03T14:24:45Z

keplergl_cli/keplergl_cli.py

+            style=None,
+            config_file=None,
+            output_map=None,
+            open_browser=False):


I originally didn't intend open_browser to be exposed through __init__. The rationale being that passing data into here is just a shortcut for using render directly, and we don't need to expose all the same params

kylebarron · 2022-09-03T14:25:31Z

README.md

@@ -124,7 +123,7 @@ html_path = vis.render(open_browser=True, read_only=False)
 **Visualize**

 ```py
-Visualize(data=None, names=None, read_only=False, api_key=None, style=None)
+Visualize(data=None, names=None, read_only=False, api_key=None, style=None, config_file=None, output_map=None)


See below for discussion of whether open_browser should exist as a param to __init__, but if it does exist then it should be documented here

kylebarron · 2022-09-03T14:26:07Z

keplergl_cli/keplergl_cli.py

+        else:
+            self.config_file = config_file
+        if output_map is not None:
+            self.path = output_map+'_vis.html'


If the user passes in a specific path, we shouldn't change it

kylebarron · 2022-09-03T14:28:42Z

setup.py

@@ -55,6 +55,6 @@
    test_suite='tests',
    tests_require=test_requirements,
    url='https://github.com/kylebarron/keplergl_cli',
-    version='0.3.3',
+    version='0.3.4',


You shouldn't change the version here; we'll have a separate PR to bump the version, which will probably be 0.4.0

kylebarron · 2022-09-03T14:29:01Z

keplergl_cli/keplergl_cli.py

-
-        return path
+            webbrowser.open_new_tab('file://' + self.path)
+        return self.path


Nit: here and below are missing a newline at the end of the file

kylebarron · 2022-09-03T14:29:15Z

keplergl_cli/keplergl_cli.py

@@ -143,14 +156,10 @@ def add_data(self, data, names=None):
            self.map.add_data(data=datum, name=name)

    def render(self, open_browser=True, read_only=False, center_map=True):
-        """Export kepler.gl map to HTML file and open in Chrome
+        """Export kepler.gl map to HTML file and open in defauly system browser


Suggested change

"""Export kepler.gl map to HTML file and open in defauly system browser

"""Export kepler.gl map to HTML file and open in default system browser

kylebarron · 2022-09-03T14:30:55Z

keplergl_cli/keplergl_cli.py


        # First load config file as string, replace {MAPBOX_API_KEY} with the
        # actual api key, then parse as JSON
-        with open(config_file) as f:
+        with open(self.config_file) as f:


This function shouldn't touch a user-provided config file.

kylebarron · 2022-09-03T14:31:56Z

keplergl_cli/keplergl_cli.py

@@ -40,14 +40,21 @@ def __init__(
            names=None,
            read_only=False,
            api_key=None,
-            style=None):
+            style=None,


8 params is too many to allow to be positional imo. I'd rather not change the existing API but we should add * before config_file to make the new params keyword-only

ashirwad · 2022-10-10T19:39:25Z

@ikespand, did you get a chance to work on this?

ikespand · 2022-10-10T19:46:51Z

Sorry @ashirwad .. Things were little chaotic here. But, will commit the suggestions within 2 weeks.

ashirwad · 2022-10-10T20:15:03Z

No worries, @ikespand! Hope you are doing well. And thanks again for all your help with this. :)

Sandeep Pandey and others added 9 commits June 26, 2020 18:17

added option to save map dir, config file dir, fixed browserless oper…

fdd2922

…ation

Readme for edited class

b537073

Fixed output map name

e55d8e4

Fixed a bug for default config file

cf87092

Updated readme to install this specific version

873f7fb

Updated version number

94fa57a

Update requirements.txt

2430f27

Renamed the map output file name

ac6b6e1

Fixed the issue for map auto-centering by deleting the mapState in de…

2bf44df

…fault config JSON

ikespand added 3 commits September 1, 2022 18:47

Changes to resolve the merge conflict

fb7bf39

Minor changes in documentation, rollback to original default config J…

8b8f9f2

…SON and provide open_browser in init

Bump version: 0.3.3 → 0.3.4

404bd13

kylebarron reviewed Sep 3, 2022

View reviewed changes

	"""Export kepler.gl map to HTML file and open in defauly system browser
	"""Export kepler.gl map to HTML file and open in default system browser

Fixed open_browser issue and added functionality for map and config file #6

Are you sure you want to change the base?

Fixed open_browser issue and added functionality for map and config file #6

Uh oh!

Conversation

ikespand commented Jul 17, 2020

Uh oh!

ashirwad commented Sep 1, 2022

Uh oh!

kylebarron commented Sep 1, 2022

Uh oh!

ashirwad commented Sep 1, 2022

Uh oh!

kylebarron commented Sep 1, 2022

Uh oh!

ikespand commented Sep 1, 2022

Uh oh!

ikespand commented Sep 1, 2022

Uh oh!

ashirwad commented Sep 1, 2022

Uh oh!

kylebarron left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ashirwad commented Oct 10, 2022

Uh oh!

ikespand commented Oct 10, 2022

Uh oh!

ashirwad commented Oct 10, 2022

Uh oh!

Uh oh!