Theming whitelabel.py script #214

rnr · 2023-12-19T14:47:13Z

Added the theming `whitelabel.py` script

This script can override Assets (images, colors, app Icon) and change project settings (app bundle ID and development team ID). Please follow this documentation to install Python dependencies if needed and to read how to work/configure.

Changes

1) Allocated colors for more flexibility:

loginNavigationText
loginBackground
accentButtonColor
SplashBackground

2) Added `ThemeConfig` for feature flags related to Theming

3) Changed `textInputShape` and `buttonShape` to support rounded and rectangle corners.

Custom edX theme example

Clone https://github.com/edx/edx-mobile-config into the OpenEdX root folder and switch to the anton/openedX-theming branch.
From the OpenEdX root folder, run the script as:

python config_script/whitelabel.py --config-file=edx-mobile-config/openEdXAssets/whitelabel.yaml -v

Install on your simulator or device

All possible config parameters are described in this documentation

…nt.json

miankhalid · 2023-12-22T06:03:50Z

@shafqat-muneer will be reviewing this PR from Axinite's side.

shafqat-muneer · 2023-12-22T14:13:23Z

PR review is in progress from my side.

shafqat-muneer · 2023-12-26T16:43:39Z

After running this command on terminal:

python3 config_script/whitelabel.py --config-file=path/to/configfile/whitelabel.yaml -v

Got this error:

File "/path/to/config_script/whitelabel.py", line 6, in <module>
    import yaml
ModuleNotFoundError: No module named 'yaml'

Resolved the issue by installing pyyaml by following command:

pip3 install pyyaml

Suggestion: I think we should document every dependency in Theming_implementation.md file so that it can easily be configured on new system independently.

…rs in project file

shafqat-muneer · 2023-12-26T17:21:42Z

We utilize distinct bundle identifiers for our Development (Dev), Staging (Stage), and Production (Prod) environments. Is it possible to modify the bundle identifiers for all environments simultaneously, or do we need to execute the script multiple times to update each environment's bundle identifier individually?

shafqat-muneer · 2023-12-26T13:12:17Z

Documentation/Theming_implementation.md

+The `whitelabel.py` theming script requires the following Python dependencies to be installed:
+- `pip install coloredlogs`
+- `pip install pillow`


I need to execute the following command for installing dependencies. I believe it would be beneficial to include these statements as well.

pip3 install coloredlogs

pip3 install pillow

added to documentation all dependencies which are not default python's libs

shafqat-muneer · 2023-12-26T13:34:44Z

Documentation/Theming_implementation.md

+- `pip install pillow`
+
+## How to Run the Script
+The theming script `whitelabel.py` can be ran from the OpenEdX iOS root project folder with the following command:


Typo: can be ran to can be run

Documentation/Theming_implementation.md

shafqat-muneer · 2023-12-26T16:59:13Z

config_script/whitelabel.py

+    EXAMPLE_CONFIG_FILE = """
+        ---
+        # Notes:
+        # Config file can contain next optins:


Typo: optins to options

shafqat-muneer · 2023-12-26T17:32:39Z

Review is in progress.

shafqat-muneer · 2023-12-27T06:58:05Z

@rnr Getting SyntaxWarning after running command:

python3 config_script/whitelabel.py --config-file=/path/to/whitelabel.yaml

Error Details:

/path/to/config_script/whitelabel.py:317: SyntaxWarning: invalid escape sequence '\*'
  return f"/\* {build_config} \*/ = {{\n\t\t\tisa = XCBuildConfiguration;\n\t\t\tbaseConfigurationReference = [\s|\S]*\t\t\tname = {build_config};"
/path/to/config_script/whitelabel.py:317: SyntaxWarning: invalid escape sequence '\*'
  return f"/\* {build_config} \*/ = {{\n\t\t\tisa = XCBuildConfiguration;\n\t\t\tbaseConfigurationReference = [\s|\S]*\t\t\tname = {build_config};"
/path/to/config_script/whitelabel.py:317: SyntaxWarning: invalid escape sequence '\s'
  return f"/\* {build_config} \*/ = {{\n\t\t\tisa = XCBuildConfiguration;\n\t\t\tbaseConfigurationReference = [\s|\S]*\t\t\tname = {build_config};"

rnr · 2023-12-27T09:40:07Z

@rnr Getting SyntaxWarning after running command:

python3 config_script/whitelabel.py --config-file=/path/to/whitelabel.yaml

Error Details:

/path/to/config_script/whitelabel.py:317: SyntaxWarning: invalid escape sequence '\*'
  return f"/\* {build_config} \*/ = {{\n\t\t\tisa = XCBuildConfiguration;\n\t\t\tbaseConfigurationReference = [\s|\S]*\t\t\tname = {build_config};"
/path/to/config_script/whitelabel.py:317: SyntaxWarning: invalid escape sequence '\*'
  return f"/\* {build_config} \*/ = {{\n\t\t\tisa = XCBuildConfiguration;\n\t\t\tbaseConfigurationReference = [\s|\S]*\t\t\tname = {build_config};"
/path/to/config_script/whitelabel.py:317: SyntaxWarning: invalid escape sequence '\s'
  return f"/\* {build_config} \*/ = {{\n\t\t\tisa = XCBuildConfiguration;\n\t\t\tbaseConfigurationReference = [\s|\S]*\t\t\tname = {build_config};"

@shafqat-muneer Could you show what is content of whitelabel.yaml file for this error please

shafqat-muneer · 2023-12-27T10:44:47Z

@rnr Getting SyntaxWarning after running command:

python3 config_script/whitelabel.py --config-file=/path/to/whitelabel.yaml

Error Details:

/path/to/config_script/whitelabel.py:317: SyntaxWarning: invalid escape sequence '\*'
  return f"/\* {build_config} \*/ = {{\n\t\t\tisa = XCBuildConfiguration;\n\t\t\tbaseConfigurationReference = [\s|\S]*\t\t\tname = {build_config};"
/path/to/config_script/whitelabel.py:317: SyntaxWarning: invalid escape sequence '\*'
  return f"/\* {build_config} \*/ = {{\n\t\t\tisa = XCBuildConfiguration;\n\t\t\tbaseConfigurationReference = [\s|\S]*\t\t\tname = {build_config};"
/path/to/config_script/whitelabel.py:317: SyntaxWarning: invalid escape sequence '\s'
  return f"/\* {build_config} \*/ = {{\n\t\t\tisa = XCBuildConfiguration;\n\t\t\tbaseConfigurationReference = [\s|\S]*\t\t\tname = {build_config};"

@shafqat-muneer Could you show what is content of whitelabel.yaml file for this error please

@rnr I tried it with just import_dir content. whitelabel.yaml looks like this:

import_dir: '/Users/shafqatmuneer/msmq/Projects/2U/_Daily/20231226/Images' # folder where importing images are placed

I also checked with same sample file content in config repo, it's also giving error. With whitelabel.yaml file in config repo, error is this:

/Users/shafqatmuneer/msmq/Projects/2U/CodeBase/openedx-app-ios/config_script/whitelabel.py:317: SyntaxWarning: invalid escape sequence '\*'
  return f"/\* {build_config} \*/ = {{\n\t\t\tisa = XCBuildConfiguration;\n\t\t\tbaseConfigurationReference = [\s|\S]*\t\t\tname = {build_config};"
/Users/shafqatmuneer/msmq/Projects/2U/CodeBase/openedx-app-ios/config_script/whitelabel.py:317: SyntaxWarning: invalid escape sequence '\*'
  return f"/\* {build_config} \*/ = {{\n\t\t\tisa = XCBuildConfiguration;\n\t\t\tbaseConfigurationReference = [\s|\S]*\t\t\tname = {build_config};"
/Users/shafqatmuneer/msmq/Projects/2U/CodeBase/openedx-app-ios/config_script/whitelabel.py:317: SyntaxWarning: invalid escape sequence '\s'
  return f"/\* {build_config} \*/ = {{\n\t\t\tisa = XCBuildConfiguration;\n\t\t\tbaseConfigurationReference = [\s|\S]*\t\t\tname = {build_config};"

rnr · 2023-12-27T14:06:14Z

@rnr Getting SyntaxWarning after running command:

python3 config_script/whitelabel.py --config-file=/path/to/whitelabel.yaml

Error Details:

/path/to/config_script/whitelabel.py:317: SyntaxWarning: invalid escape sequence '\*'
  return f"/\* {build_config} \*/ = {{\n\t\t\tisa = XCBuildConfiguration;\n\t\t\tbaseConfigurationReference = [\s|\S]*\t\t\tname = {build_config};"
/path/to/config_script/whitelabel.py:317: SyntaxWarning: invalid escape sequence '\*'
  return f"/\* {build_config} \*/ = {{\n\t\t\tisa = XCBuildConfiguration;\n\t\t\tbaseConfigurationReference = [\s|\S]*\t\t\tname = {build_config};"
/path/to/config_script/whitelabel.py:317: SyntaxWarning: invalid escape sequence '\s'
  return f"/\* {build_config} \*/ = {{\n\t\t\tisa = XCBuildConfiguration;\n\t\t\tbaseConfigurationReference = [\s|\S]*\t\t\tname = {build_config};"

@shafqat-muneer Could you show what is content of whitelabel.yaml file for this error please

@rnr I tried it with just import_dir content. whitelabel.yaml looks like this:

import_dir: '/Users/shafqatmuneer/msmq/Projects/2U/_Daily/20231226/Images' # folder where importing images are placed

I also checked with same sample file content in config repo, it's also giving error. With whitelabel.yaml file in config repo, error is this:

/Users/shafqatmuneer/msmq/Projects/2U/CodeBase/openedx-app-ios/config_script/whitelabel.py:317: SyntaxWarning: invalid escape sequence '\*'
  return f"/\* {build_config} \*/ = {{\n\t\t\tisa = XCBuildConfiguration;\n\t\t\tbaseConfigurationReference = [\s|\S]*\t\t\tname = {build_config};"
/Users/shafqatmuneer/msmq/Projects/2U/CodeBase/openedx-app-ios/config_script/whitelabel.py:317: SyntaxWarning: invalid escape sequence '\*'
  return f"/\* {build_config} \*/ = {{\n\t\t\tisa = XCBuildConfiguration;\n\t\t\tbaseConfigurationReference = [\s|\S]*\t\t\tname = {build_config};"
/Users/shafqatmuneer/msmq/Projects/2U/CodeBase/openedx-app-ios/config_script/whitelabel.py:317: SyntaxWarning: invalid escape sequence '\s'
  return f"/\* {build_config} \*/ = {{\n\t\t\tisa = XCBuildConfiguration;\n\t\t\tbaseConfigurationReference = [\s|\S]*\t\t\tname = {build_config};"

@shafqat-muneer added extra escaping to regex inside python script. should be fine now. please check

shafqat-muneer

LGTM

Script is working
Documentation related improvements are done
Dependencies are listed
Sample whitelabel.yaml file added

volodymyr-chekyrta · 2024-01-02T08:49:49Z

Hello everyone!

I was wondering if we are waiting for @eyatsenkoperpetio review before merging this PR, or if we can go ahead and merge it now?

rnr · 2024-01-02T15:57:13Z

Hello everyone!

I was wondering if we are waiting for @eyatsenkoperpetio review before merging this PR, or if we can go ahead and merge it now?

Hello @volodymyr-chekyrta
I think we are ready to merge since @eyatsenkoperpetio just approved
Thank you

rnr added 30 commits December 1, 2023 11:02

chore: added whitelabel script, added login background color

3d0eb60

style: added rounded corner FF

103cfec

chore: changed assets for progress bar and unibutton color

7d16778

chore: added multiple assets supporting

038db77

chore: move whitelabel config into config repo

e3b3622

Merge branch 'develop' into config-whitelabel-script

2fc4cac

chore: moved extra Assets to Theme target

53be070

chore: return back splash screen background color

7b18e9f

chore: added logs for whitelabel script

c1a6922

chore: rounded buttons theming

5b4d976

chore: changes in whitelabel script

4667c1f

Merge branch 'develop' into config-whitelabel-script

4d13924

chore: fix after merge

cc20eba

chore: added themed button shape for social login buttons

9053dc0

style: add login navigation text color as separate

91822f4

Merge branch 'develop' into config-whitelabel-script

d58f45d

chore: added app icon changing

97116ff

chore: add comment

0093d29

chore: added bundle id changing

af35119

chore: set dev team in project file

676c616

chore: got rid original images names from config, now read from Conte…

228ae3d

…nt.json

Merge branch 'develop' into config-whitelabel-script

fb32c9c

chore: reorder configs

33c2fa6

chore: added documentation

abb16b8

chore: missed quotes

20da8aa

refactor: theme config

2beed67

chore: backbutton color on sign in view

54d8bcf

chore: fixed misspelling

3d9e4dd

refactor: change to snake_style stage1

d1cb76a

refactor: changed to snake_style stage2

9827da1

rnr requested review from saeedbashir, eyatsenkoperpetio and volodymyr-chekyrta December 19, 2023 14:47

rnr linked an issue Dec 19, 2023 that may be closed by this pull request

[iOS] iOS build script for Custom Application Configuration #151

Closed

Merge branch 'develop' into config-whitelabel-script

ecb65a9

miankhalid requested a review from shafqat-muneer December 22, 2023 06:03

rnr removed the request for review from saeedbashir December 26, 2023 10:33

rnr added 2 commits December 26, 2023 18:11

chore: added app versions, refactor and unify code to search paramete…

4beb029

…rs in project file

chore: added install dependencies to documentation

29f866a

shafqat-muneer requested changes Dec 26, 2023

View reviewed changes

rnr added 2 commits December 27, 2023 14:59

chore: fixed according feedback, improved documentation

a20c810

chore: fixed how to get config example

1d9ceea

rnr requested a review from shafqat-muneer December 27, 2023 14:07

chore: improve documentation

f964e81

shafqat-muneer approved these changes Dec 27, 2023

View reviewed changes

volodymyr-chekyrta approved these changes Dec 29, 2023

View reviewed changes

eyatsenkoperpetio approved these changes Jan 2, 2024

View reviewed changes

volodymyr-chekyrta merged commit 1bc4a75 into openedx:develop Jan 2, 2024
3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Theming whitelabel.py script #214

Theming whitelabel.py script #214

rnr commented Dec 19, 2023

miankhalid commented Dec 22, 2023

shafqat-muneer commented Dec 22, 2023

shafqat-muneer commented Dec 26, 2023

shafqat-muneer commented Dec 26, 2023

shafqat-muneer Dec 26, 2023

rnr Dec 27, 2023

shafqat-muneer Dec 26, 2023

rnr Dec 27, 2023

shafqat-muneer Dec 26, 2023

rnr Dec 27, 2023

shafqat-muneer commented Dec 26, 2023

shafqat-muneer commented Dec 27, 2023

rnr commented Dec 27, 2023

shafqat-muneer commented Dec 27, 2023

rnr commented Dec 27, 2023

shafqat-muneer left a comment

volodymyr-chekyrta commented Jan 2, 2024

rnr commented Jan 2, 2024

Theming whitelabel.py script #214

Theming whitelabel.py script #214

Conversation

rnr commented Dec 19, 2023

Added the theming whitelabel.py script

Changes

1) Allocated colors for more flexibility:

2) Added ThemeConfig for feature flags related to Theming

3) Changed textInputShape and buttonShape to support rounded and rectangle corners.

Custom edX theme example

miankhalid commented Dec 22, 2023

shafqat-muneer commented Dec 22, 2023

shafqat-muneer commented Dec 26, 2023

shafqat-muneer commented Dec 26, 2023

shafqat-muneer Dec 26, 2023

Choose a reason for hiding this comment

rnr Dec 27, 2023

Choose a reason for hiding this comment

shafqat-muneer Dec 26, 2023

Choose a reason for hiding this comment

rnr Dec 27, 2023

Choose a reason for hiding this comment

shafqat-muneer Dec 26, 2023

Choose a reason for hiding this comment

rnr Dec 27, 2023

Choose a reason for hiding this comment

shafqat-muneer commented Dec 26, 2023

shafqat-muneer commented Dec 27, 2023

rnr commented Dec 27, 2023

shafqat-muneer commented Dec 27, 2023

rnr commented Dec 27, 2023

shafqat-muneer left a comment

Choose a reason for hiding this comment

volodymyr-chekyrta commented Jan 2, 2024

rnr commented Jan 2, 2024

Added the theming `whitelabel.py` script

2) Added `ThemeConfig` for feature flags related to Theming

3) Changed `textInputShape` and `buttonShape` to support rounded and rectangle corners.