Contributer Instructions

Pull requests are always welcome :) We love pull requests :)

1- Use "4 spaces" for tab, please.

2- Please create clear! pull requests. Please add comments to your codes and ... :)

We prefer longer but MORE CLEAR codes!

3- Try to use PEP 8 style guide for python codes. Please checkout .pep8 file.

We use camelCase method for naming functions and methods.

4- Persepolis developers are linux users but we develope persepolis for BSD, Windows and Mac too. So please make sure that your codes don't have any problem with other platforms.

you can specify a platform in your codes. see this for example.

5- We put all the codes that related to UI in persepolis/gui folder and we put other codes in persepolis/scripts folder .

I want to edit UI

Please DON'T use QtDesigner for creating or modifing UIs for persepolis. code yourself! because QtDesigner creates some additional and unnecessary codes in python.

I want to add some new icons to the Persepolis

1- Create a folder for your icons in resources folder. You can find icons name from other icons folder. Please create SVG icons.

2- After creating all of your icons, you must add your icons path to the resources.qrc file. You can find example here.

3- Open your terminal, change directory with cd command to the icons folder, and run this command: bash resources_generator.sh -r

4- Go to persepolis/scripts and edit setting.py and add your icons name to the file(see iconSizeComboBoxChanged method).

5- Run persepolis from test folder(see this)

6- Select preferences from edit menu. select your icons and please test your icons in all sizes!(16, 24, 32, 48, 128)

I want to add some new color schemes

1- See persepolis/gui/palletes.py file. You can also use qss file.

2- Create separate class for you color scheme(If you don't want to use qss). If you are new you can copy/paste a class and edit that class :)

Read this to learn about QPallete Read this to learn about QSS files

3- Go to persepolis/scripts/persepolis.py file. See setPersepolisColorScheme method. add your color scheme to the method. Please pay attention to setStyleSheet :)

4- Go to persepolis/scripts and edit setting.py and add your color scheme to the file(find "set color_scheme comment").

5- Run persepolis from test folder(see this)

6- Select preferences from edit menu.Select Fusion style. Select your color scheme. Restart persepolis.

I want to add new sites to "Video Finder"

Persepolis uses yt-dlp for finding media files. So video finder supported sites is related to yt-dlp, not persepolis! Persepolis web extensions detects youtube links automatically and you can send them to persepolis's video finder with a simple write-click in your browser. If you want add your favorite site, see "supported_sites_list" list in this file.

Good Luck!