Add a config file and a force option to overwrite profiles #9

Gaareth · 2021-03-02T17:32:20Z

This will add a config file using yaml, as I found this to be the easiest human readable format.

I have merged your folder_names and file_names variables into a single entries variable, as it removes some boilerplate code, in my opinion.

The config file gets copied to the right position on the executing of the install.sh script.

Note: This introduces a dependency: PyYaml, but I forgot to include a requirements.txt file, therefore I recommend to add one later.

Also I added a force option to overwrite already saved profiles, which I found quite useful

Furthermore I reformatted the file a bit, and turned the single triple quotes intro double triple quotes, as my IDE suggested this.

Note: This is my first pull request, so please tell me if it is okay.

Prayag2 · 2021-03-02T18:19:39Z

The overwrite feature is a nice one to have but I think you forgot to add it here:

Gaareth · 2021-03-02T18:38:13Z

The overwrite feature is a nice one to have but I think you forgot to add it here:

No it actually works, the args.force variable gets passed to the save_profile function

selplacei · 2021-03-03T07:35:35Z

konsave

@@ -10,38 +10,73 @@
 import os, shutil, argparse
 from zipfile import ZipFile, ZIP_DEFLATED, is_zipfile

+try:
+    import yaml
+    import bitches


I'm assuming you forgot to delete this line.

Oh my fucking god. I'm really sorry, I did this in order to test if the catch works.

~~As this is my first pull request, how can I resolve this?~~
Edit: should be fixed by the latest commit.

Prayag2 · 2021-03-03T11:25:47Z

konsave

+                           'kdeglobals', 'kglobalshortcutsrc', 'klipperrc', 'krunnerrc', 'kscreenlockerrc',
+                           'ksmserverrc', 'kwinrc', 'kwinrulesrc', 'plasma-org.kde.plasma.desktop-appletsrc',
+                           'plasmarc', 'plasmashellrc', 'gtkrc', 'gtkrc-2.0', 'lattedockrc', 'breezerc', 'oxygenrc',
+                           'lightlyrc', 'ksplashrc']


I think we could download the config file for them instead of creating a new default_entries list. Here's what we can do:

import urllib.request url = URL_OF_THE_CONF_FILE destination = PATH_TO_DOWNLOAD_LOCATION urllib.request.urlretrieve(url, destination)

urllib is a built in module so there's no problem in using it. This would improve the user experience.

Gaareth · 2021-03-03T21:38:56Z

konsave

+        except urllib.error.HTTPError:
+            fallback_url = 'https://raw.githubusercontent.com/Gaareth/konsave/add-config-and-force-option/conf.yaml'
+            urllib.request.urlretrieve(fallback_url, CONFIG_FILE)


I have added a fallback URL in case yours does not work

Prayag2 · 2021-03-04T08:51:30Z

I've updated a lot of things (bug fixes) so please update them in your repo too

Gaareth · 2021-03-05T17:58:26Z

setup.py

+    package_data={'config': ['conf.yaml']},
+    install_requires=['PyYaml'],


Added the PyYaml requirement and added the config file to package_data

Gaareth · 2021-03-05T17:59:47Z

konsave/funcs.py

+    if not os.path.exists(CONFIG_FILE):
+        print_msg(f"No config file found! Using default config ({default_config_path}).")
+        shutil.copy(default_config_path, CONFIG_FILE)
+        print_msg(f"Saved default config to: {CONFIG_FILE}")
+        return yaml.load(resource_stream('konsave', 'conf.yaml'), Loader=yaml.FullLoader)["entries"]


If the config file is not found the default config from the pip install folder will be copied to '~/.config/konsave'

Gaareth · 2021-03-05T18:00:04Z

konsave/__main__.py

+    parser.add_argument('-f', '--force', required=False, action='store_true', help='Overwrite already saved profiles')
+


Added the force option

Gaareth · 2021-03-05T18:01:21Z

konsave/vars.py

-    os.mkdirs(PROFILES_DIR)
+    os.mkdir(PROFILES_DIR)


the bug I referenced in the commit message

Prayag2 · 2021-03-05T18:06:10Z

Thanks! I'm merging your pull request now! But before that, could you update the README and change the version in setup.py to "1.0.4" too?

Prayag2 · 2021-03-05T18:09:45Z

Please update the readme too. Just add a description for the "--force" option so that the users will know it exists.

Gaareth · 2021-03-05T18:14:05Z

Should work now :D

Gaareth · 2021-03-05T18:15:21Z

wait I think I found another bug D:

Prayag2 · 2021-03-05T18:15:25Z

Thank you!

Gaareth · 2021-03-05T18:19:55Z

wait I think I found another bug D:

  File "/usr/lib/python3.9/runpy.py", line 197, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "/usr/lib/python3.9/runpy.py", line 87, in _run_code
    exec(code, run_globals)
  File "/home/gareth/tools/konsave/konsave/__main__.py", line 3, in <module>
    from konsave.funcs import *
  File "/home/gareth/tools/konsave/konsave/funcs.py", line 5, in <module>
    from konsave.vars import *
  File "/home/gareth/tools/konsave/konsave/vars.py", line 15, in <module>
    os.mkdir(PROFILES_DIR)
FileNotFoundError: [Errno 2] No such file or directory: '/home/gareth/.config/konsave/profiles'

This fixes it:

if not os.path.exists(KONSAVE_DIR):
    os.mkdir(KONSAVE_DIR)

Prayag2 · 2021-03-05T18:21:54Z

I'm getting this now:

Please make a pull request and change the location of the config file to "~/.config/konsave/".

Gaareth · 2021-03-05T18:26:35Z

I'm getting this now:

Please make a pull request and change the location of the config file to "~/.config/konsave/".

eh, have you already reinstalled the package? python -m pip install -e <the konsave dir>

Prayag2 · 2021-03-05T18:28:37Z

I just ran python -m pip install konsave==1.0.5

Gaareth · 2021-03-05T18:31:36Z

I am unsure with the process, how this directory get synced with pip,
but could you try, installing it manually: python -m pip install -e <the konsave dir>

Gaareth · 2021-03-05T18:56:42Z

The pull request should hopefully fix this
#16

Add a config file and a force option to overwrite profiles

d54248b

Prayag2 mentioned this pull request Mar 3, 2021

konsave command not found #11

Closed

selplacei reviewed Mar 3, 2021

View reviewed changes

remove unnecessary import

30b834d

Prayag2 reviewed Mar 3, 2021

View reviewed changes

Add download of default config instead of using harcoded values

17bed24

Gaareth commented Mar 3, 2021

View reviewed changes

Apply config and force option, also fix bug

b24872a

Gaareth commented Mar 5, 2021

View reviewed changes

Update version from 1.0.3 to 1.0.4

0fbf0fc

Add --force option to readme

bec4f98

Prayag2 merged commit 066f3a4 into Prayag2:master Mar 5, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a config file and a force option to overwrite profiles #9

Add a config file and a force option to overwrite profiles #9

Gaareth commented Mar 2, 2021

Prayag2 commented Mar 2, 2021

Gaareth commented Mar 2, 2021

selplacei Mar 3, 2021

Gaareth Mar 3, 2021 •

edited

Prayag2 Mar 3, 2021

Gaareth Mar 3, 2021

Prayag2 commented Mar 4, 2021

Gaareth Mar 5, 2021

Gaareth Mar 5, 2021

Gaareth Mar 5, 2021

Gaareth Mar 5, 2021

Prayag2 commented Mar 5, 2021

Prayag2 commented Mar 5, 2021

Gaareth commented Mar 5, 2021

Gaareth commented Mar 5, 2021

Prayag2 commented Mar 5, 2021

Gaareth commented Mar 5, 2021

Prayag2 commented Mar 5, 2021

Gaareth commented Mar 5, 2021

Prayag2 commented Mar 5, 2021

Gaareth commented Mar 5, 2021

Gaareth commented Mar 5, 2021 •

edited

		package_data={'config': ['conf.yaml']},
		install_requires=['PyYaml'],

		parser.add_argument('-f', '--force', required=False, action='store_true', help='Overwrite already saved profiles')

Add a config file and a force option to overwrite profiles #9

Add a config file and a force option to overwrite profiles #9

Conversation

Gaareth commented Mar 2, 2021

Prayag2 commented Mar 2, 2021

Gaareth commented Mar 2, 2021

selplacei Mar 3, 2021

Choose a reason for hiding this comment

Gaareth Mar 3, 2021 • edited

Choose a reason for hiding this comment

Prayag2 Mar 3, 2021

Choose a reason for hiding this comment

Gaareth Mar 3, 2021

Choose a reason for hiding this comment

Prayag2 commented Mar 4, 2021

Gaareth Mar 5, 2021

Choose a reason for hiding this comment

Gaareth Mar 5, 2021

Choose a reason for hiding this comment

Gaareth Mar 5, 2021

Choose a reason for hiding this comment

Gaareth Mar 5, 2021

Choose a reason for hiding this comment

Prayag2 commented Mar 5, 2021

Prayag2 commented Mar 5, 2021

Gaareth commented Mar 5, 2021

Gaareth commented Mar 5, 2021

Prayag2 commented Mar 5, 2021

Gaareth commented Mar 5, 2021

Prayag2 commented Mar 5, 2021

Gaareth commented Mar 5, 2021

Prayag2 commented Mar 5, 2021

Gaareth commented Mar 5, 2021

Gaareth commented Mar 5, 2021 • edited

Gaareth Mar 3, 2021 •

edited

Gaareth commented Mar 5, 2021 •

edited