Introduce a command-line interface #675

tfuxu · 2022-12-10T17:33:05Z

Description

This PR introduces a CLI (command-line interface) for Gradience. ~~It is currently highly work-in-progress, as I still need to write functions for the majority of commands, and some of the options doesn't yet have any help information.~~ We are now at reviewing process, so in following days this PR should be merged into upstream.

CLI to-do list:

Fixes #671

Type of change

Bugfix (Change which fixes a issue)
New feature (Change which adds new functionality)
Enhancement (Change which slightly improves existing code)
Breaking change (This change will introduce incompatibility with existing functionality)

Changelog

Added new command-line interface,
Moved many functions used for preset manipulation to backend/ modules,
Rewritten models/preset module to make it more readable,
Converted some backend modules to classes,
Made changes to log messages structure

Testing

I have tested my changes and verified that they work as expected

How to test the changes

Currently known working build types:

Notes:

To run CLI in Flatpak builds, use this command: flatpak run --command=gradience-cli com.github.GradienceTeam.Gradience.Devel

For local builds there is a small guide on how to get CLI working:

Rebuild Gradience using either local.sh or Makefile,
Run CLI with this command: ./local_cli.sh [command]

This commit is the first in a series of commits that will introduce new CLI interface for Gradience. Currently we need to move some parts of code that reside mostly in frontend modules to their new backend modules, and this commit is the beggining of this whole ordeal. * Refactor Preset model object, in order to make it more readable and to allow `new` function that directly takes new values for properties * Move presets_dir from models/preset to new backend/globals module * Create new utils/colors module (will be used in later commits) * Update all modules that are affected by above changes

…ckend

* add more checks in new_preset_from_monet function * return full Preset object instead of dict data * remove some unused code

This commit adds a new CLI interface made using argparse library. Current status of CLI interface is very WIP, as it lacks logic for the majority of commands and doesn't work properly on Flatpak and local builds. Currently working commands: monet, version

gradience/backend/theming/monet.py

0xMRTT · 2022-12-10T19:02:53Z

Thanks again @tfuxu for your contribution, if you need help for refactoring or things like that, i'll be glad to help.

Also, since that you refactored the repo structure, it'll be nice to be able to have multiple preset open at the same time or when a preset is opening by the user instead of erasing the current one, create a new window with the new preset. (@daudix-UFO will be happy 🚀 )

daudix · 2022-12-10T19:05:14Z

Yep, I would like to have an option to open new gradience window, this would be really helpful when creating themes with multiple variants

tfuxu · 2022-12-10T19:46:59Z

Thanks again @tfuxu for your contribution, if you need help for refactoring or things like that, i'll be glad to help.

I currently need to move functions for accessing a list of installed and favorited presets from frontend to backend, so if you want, you can try to move them (put them in theming/preset_utils module) while I'm adding logic to other commands.

Also, since that you refactored the repo structure, it'll be nice to be able to have multiple preset open at the same time or when a preset is opening by the user instead of erasing the current one, create a new window with the new preset. (daudix-UFO will be 🚀 )

Sure, should be relatively easy to add, but I think that this exceeds the point of this PR, so maybe in a later date I could look into that.

0xMRTT · 2022-12-10T20:14:44Z

Thanks again @tfuxu for your contribution, if you need help for refactoring or things like that, i'll be glad to help.

I currently need to move functions for accessing a list of installed and favorited presets from frontend to backend, so if you want, you can try to move them (put them in theming/preset_utils module) while I'm adding logic to other commands.

Also, since that you refactored the repo structure, it'll be nice to be able to have multiple preset open at the same time or when a preset is opening by the user instead of erasing the current one, create a new window with the new preset. (daudix-UFO will be 🚀 )

Sure, should be relatively easy to add, but I think that this exceeds the point of this PR, so maybe in a later date I could look into that.

Ofc

…t specifying an Adw.ToastOverlay object

…globals module

…pak_theming commands

* add more exception handling to backend/preset_downloader and backend/models/preset modules

tfuxu · 2022-12-12T21:01:25Z

@0xMRTT
Are you going to port these functions? Just asking, because I did most of the logic already and wanted to finish doing it for list commands too.

niksingh710 · 2022-12-17T13:35:33Z

Will the be added in aur as gradience-cli ? for testing??

tfuxu · 2022-12-17T15:12:53Z

Will the be added in aur as gradience-cli ? for testing??

No, you won't be able to install CLI as a standalone package, because it is tied directly to Gradience code. The only way to get CLI will be to download a full Gradience package.

daudix · 2022-12-18T16:50:07Z

how I can download a preset? for some reason it does not work for me

❯ flatpak run --command=gradience-cli com.github.GradienceTeam.Gradience.Devel download -n tokyonight-dark
[Gradience] ERROR: No presets found with text: tokyonight-dark

tfuxu · 2022-12-18T16:51:33Z

You need to type display name (don't forget to put it in quotes if it has spaces in name)

daudix · 2022-12-18T16:52:46Z

❯ flatpak run --command=gradience-cli com.github.GradienceTeam.Gradience.Devel download --preset-name "Tokyo Night Dark"
[Gradience] ERROR: No presets found with text: Tokyo Night Dark

tfuxu · 2022-12-18T16:57:14Z

❯ flatpak run --command=gradience-cli com.github.GradienceTeam.Gradience.Devel download --preset-name "Tokyo Night Dark"
[Gradience] ERROR: No presets found with text: Tokyo Night Dark

Looks like a bug. Well, I'll check what's wrong here, and try to fix that.

daudix · 2022-12-18T17:04:29Z

apply command acts oddly too, looks like flatpak does not have access to home folder

flatpak run --env=LANG=en --command=gradience-cli com.github.GradienceTeam.Gradience.Devel import -p ~/cobalt-dark.json

(process:2): Gtk-WARNING **: 20:02:45.321: Locale not supported by C library.
	Using the fallback 'C' locale.
[Gradience] �[1;36mINFO:�[0m Importing preset: cobalt-dark.json
Traceback (most recent call last):
  File "/app/bin/gradience-cli", line 361, in <module>
    cli = CLI()
  File "/app/bin/gradience-cli", line 117, in __init__
    self.__parse_args()
  File "/app/bin/gradience-cli", line 138, in __parse_args
    self.import_preset(args)
  File "/app/bin/gradience-cli", line 226, in import_preset
    shutil.copy(
  File "/usr/lib/python3.10/shutil.py", line 417, in copy
    copyfile(src, dst, follow_symlinks=follow_symlinks)
  File "/usr/lib/python3.10/shutil.py", line 254, in copyfile
    with open(src, 'rb') as fsrc:
FileNotFoundError: [Errno 2] No such file or directory: '/var/home/daudix/cobalt-dark.json'

tfuxu · 2022-12-18T17:06:59Z

~~That's because you try to import preset from /var/home/daudix location where it doesn't exist. You need to put absolute path.~~ Nevermind, it actually works with ~ symbol.

daudix · 2022-12-18T17:09:36Z

hmm, strange

tfuxu · 2022-12-18T17:28:08Z

Well, that's a bummer. I've checked import command now on Flatpak, and you actually need to give permissions to get it to work.

tfuxu · 2022-12-18T17:32:49Z

I think I have an idea how to fix this.
Maybe I've could create a function which would execute if it was detected that CLI is running in sandbox, that would ask user from what directory he wants to import a preset. It will then temporary add a permission in flatpak overrides which will give Gradience an access to that directory, and after importing is done, it will remove this permission. If it will work, I'll could implement this also in monet command to get it working as well.

daudix · 2022-12-18T17:45:01Z

If only libportal were working from cli

tfuxu · 2022-12-18T18:03:44Z

Fixed bug from #675 (comment)

tfuxu · 2022-12-18T20:39:47Z

Okay, I was able to create a function from functions in backend/flatpak_overrides that gives read/write access to a directory specified by a user. The only problem is that Flatpak (of course) doesn't dynamically load permission changes into running sandboxed application, so user will have to type two different commands to get it working 😒️

daudix · 2022-12-18T20:44:49Z

OK, it's not a big deal to enable one checkbox in Flatseal, or we can add access to downloads folder and say user that you need to put preset there?

tfuxu · 2022-12-18T21:39:31Z

we can add access to downloads folder and say user that you need to put preset there?

That might be an idea to consider

tfuxu · 2022-12-19T14:13:01Z

Okay, another idea.
I'll do a mishmash of both mine and yours idea, so we will allow Gradience to access Downloads folder by default, but I'll use my function to create a command in CLI that will allow users to choose which additional directories they want to allow Gradience to read.

tfuxu · 2022-12-19T14:15:34Z

This is how it will look as a command:

usage: gradience-cli access-file [-h] [-l] [-a PATH] [-d PATH]

options:
  -h, --help            show this help message and exit
  -l, --list            list allowed directories and files
  -a PATH, --allow PATH
                        allow Gradience to access this file or directory
  -d PATH, --disallow PATH
                        disallow Gradience access to this file or directory

* add try..except statement to shutil.copy operation in `import` command

* move sandbox check from `frontend/cli` module to `backend/globals`

tfuxu · 2022-12-19T20:28:10Z

Okay, I've tested new commits on Flatpak and now everything works as expected.

tfuxu · 2022-12-20T22:08:25Z

Alright, @daudix-UFO everything tested? Can we merge?

daudix · 2022-12-20T22:47:51Z

@tfuxu I think we can! 🚀

niksingh710 · 2022-12-21T04:32:11Z

As it is merged now.
Is it accessible in flatpak build or have to wait for the release?
and will it be available in Aur?

daudix · 2022-12-21T11:47:33Z

As it is merged now. Is it accessible in flatpak build or have to wait for the release? and will it be available in Aur?

You have to wait for the release, yes it will be available in aur

tfuxu added 6 commits December 8, 2022 12:43

backend: create new modules for preset generation utilities

22f476f

backend/theming: move apply, restore and reset preset functions to ba…

e1e244d

…ckend

backend: include backend/theming modules in meson compilation

674848e

backend: seperate JSON encoding in Preset module to a new function

527a9dc

* add more checks in new_preset_from_monet function * return full Preset object instead of dict data * remove some unused code

tfuxu linked an issue Dec 10, 2022 that may be closed by this pull request

track: add missing screenshots and new curated themes GradienceTeam/Community#61

Open

tfuxu removed a link to an issue Dec 10, 2022

track: add missing screenshots and new curated themes GradienceTeam/Community#61

Open

Merge branch 'main' into cli-support

1245d24

0xMRTT reviewed Dec 10, 2022

View reviewed changes

gradience/backend/theming/monet.py Outdated Show resolved Hide resolved

Lucki mentioned this pull request Dec 10, 2022

Multiple Sources (Requires #143) ifl0w/RandomWallpaperGnome3#141

Merged

tfuxu changed the title ~~Introduce new CLI~~ Introduce a command-line interface Dec 10, 2022

tfuxu added 6 commits December 11, 2022 12:53

backend: allow functions in flatpak_override module to be used withou…

c74bd9b

…t specifying an Adw.ToastOverlay object

backend/globals: move official Gradience preset repositories list to …

24d3429

…globals module

frontend/cli: add rudimentary logic code for apply, download and flat…

7c1a295

…pak_theming commands

Merge branch 'main' into cli-support

ffe09dc

backend: convert preset_downloader module to class

7f8e3cc

* add more exception handling to backend/preset_downloader and backend/models/preset modules

frontend/cli: add logic to import command, and finish download command

b36669b

Lucki mentioned this pull request Dec 12, 2022

Allow running post commands (Requires #147) ifl0w/RandomWallpaperGnome3#148

Merged

tfuxu added 3 commits December 13, 2022 12:07

Merge branch 'main' into cli-support

1d1654d

frontend/cli: change some help messages

3c85038

Merge branch 'main' into cli-support

38bb148

Merge branch 'main' into cli-support

9db8eaa

frontend/cli: fix download command failing after indexing first preset

354010a

tfuxu added 4 commits December 19, 2022 20:16

backend/flatpak_overrides: add new functions for file access overrides

c9d101d

frontend/cli: add new access-file command

03a63e7

* add try..except statement to shutil.copy operation in `import` command

build-aux/flatpak: add xdg-download read-only as a allowed directory

ca84565

frontend/cli: reenable monet command on Flatpak builds

61eb5fb

* move sandbox check from `frontend/cli` module to `backend/globals`

daudix approved these changes Dec 20, 2022

View reviewed changes

tfuxu merged commit b5a4dc0 into main Dec 20, 2022

tfuxu deleted the cli-support branch December 20, 2022 23:15

daudix mentioned this pull request Jan 9, 2023

feat: change preset from cli #696

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce a command-line interface #675

Introduce a command-line interface #675

tfuxu commented Dec 10, 2022 •

edited

Loading

0xMRTT commented Dec 10, 2022

daudix commented Dec 10, 2022 •

edited

Loading

tfuxu commented Dec 10, 2022

0xMRTT commented Dec 10, 2022

tfuxu commented Dec 12, 2022

niksingh710 commented Dec 17, 2022

tfuxu commented Dec 17, 2022

daudix commented Dec 18, 2022

tfuxu commented Dec 18, 2022 •

edited

Loading

daudix commented Dec 18, 2022

tfuxu commented Dec 18, 2022 •

edited

Loading

daudix commented Dec 18, 2022

tfuxu commented Dec 18, 2022 •

edited

Loading

daudix commented Dec 18, 2022

tfuxu commented Dec 18, 2022

tfuxu commented Dec 18, 2022 •

edited

Loading

daudix commented Dec 18, 2022

tfuxu commented Dec 18, 2022

tfuxu commented Dec 18, 2022 •

edited

Loading

daudix commented Dec 18, 2022

tfuxu commented Dec 18, 2022

tfuxu commented Dec 19, 2022

tfuxu commented Dec 19, 2022

tfuxu commented Dec 19, 2022

tfuxu commented Dec 20, 2022

daudix commented Dec 20, 2022

niksingh710 commented Dec 21, 2022

daudix commented Dec 21, 2022

Introduce a command-line interface #675

Introduce a command-line interface #675

Conversation

tfuxu commented Dec 10, 2022 • edited Loading

Description

CLI to-do list:

Type of change

Changelog

Testing

How to test the changes

Currently known working build types:

Notes:

0xMRTT commented Dec 10, 2022

daudix commented Dec 10, 2022 • edited Loading

tfuxu commented Dec 10, 2022

0xMRTT commented Dec 10, 2022

tfuxu commented Dec 12, 2022

niksingh710 commented Dec 17, 2022

tfuxu commented Dec 17, 2022

daudix commented Dec 18, 2022

tfuxu commented Dec 18, 2022 • edited Loading

daudix commented Dec 18, 2022

tfuxu commented Dec 18, 2022 • edited Loading

daudix commented Dec 18, 2022

tfuxu commented Dec 18, 2022 • edited Loading

daudix commented Dec 18, 2022

tfuxu commented Dec 18, 2022

tfuxu commented Dec 18, 2022 • edited Loading

daudix commented Dec 18, 2022

tfuxu commented Dec 18, 2022

tfuxu commented Dec 18, 2022 • edited Loading

daudix commented Dec 18, 2022

tfuxu commented Dec 18, 2022

tfuxu commented Dec 19, 2022

tfuxu commented Dec 19, 2022

tfuxu commented Dec 19, 2022

tfuxu commented Dec 20, 2022

daudix commented Dec 20, 2022

niksingh710 commented Dec 21, 2022

daudix commented Dec 21, 2022

tfuxu commented Dec 10, 2022 •

edited

Loading

daudix commented Dec 10, 2022 •

edited

Loading

tfuxu commented Dec 18, 2022 •

edited

Loading

tfuxu commented Dec 18, 2022 •

edited

Loading

tfuxu commented Dec 18, 2022 •

edited

Loading

tfuxu commented Dec 18, 2022 •

edited

Loading

tfuxu commented Dec 18, 2022 •

edited

Loading