1. Shortcuts and app configurations

1.9.1. Tips & tricks

• I've been using PyCharm (professional edition) for more than 3 years now, even if I used VSCode for 2 years before that, the Intellij suite is just amazing. Intellij suite with all the plugins for students is completely free.

• Change the default location of projects : instead of PycharmProjects. Settings -> Appearance & behavior -> system settings

• If you are on Windows, use pycharm with WSL.

• Sync pycharm settings : https://www.jetbrains.com/help/pycharm/sharing-your-ide-settings.html#IDE_settings_sync

• You can save your current layout (all plugin positions) by going to Window | Layouts | Save Current Layout as New and switch to it from new projects by Window | Layouts |

  | Apply.

• Project settings : Everytime you start a project make sure to

  • Change the source folder for imports (https://stackoverflow.com/a/34304165).

  • Edit the configuration template of python and python tests(autodetect and pytest) to select a default working directory for all your scripts. If you changed the source folder, it should match it. This will prevent you from having problems with working directory location when running from the terminal and pycharm.

• I always use the run button (or shortcut) instead of the terminal to run my files (specifically fastapi or streamlit) so pycharm can highlight the errors and make them easily clickable.

• Use the debug function when needed.

• You can Run pytest just by right-clicking on a function bloc, file, or folder!

• Git Clone: You can directly clone a repository from your git accounts by going to the Menu bar | VCS | Get from Version Control | GitHub | and select the right repository.

• You can write a #TODO in the .py files or [//]: # (TODO Add Google TV setup ) in the markdown files to see them in the TODO panel.

• Commits : doc

  • pre-commit hooks: Just run in the interminal pre-commit install. Pycharm should detect it. After the installation, see in the commit panel (where you enter the commit message) (wheel button) next to the message if Run git hooks is there. If it isn't, then restart pycharm. Next time your commit, pycharm will run the pre-commit hooks

  • When you write in your terminal: pip list | grep pre-commit you should see the package. Running pre-commit --version should also work.

  • Check the Amend commit box if you want to concatenate commits

  • If you want to delete a pushed commit :

    • Make sure that the branch isn't protected: open IDE settings Ctrl+Alt+S then go to git settings. You will see in the Push settings the protected branches. Note that if a branch is marked as protected on GitHub, PyCharm will automatically mark it as protected when you check it out, but you can modify it.

    • To delete a pushed commit, you have to options: drop a commit, or reset a current branch to a specific commit. After doing one or the other, open the push panel and instead of selecting 'push', select 'force push'. Remember that you need to force push, otherwise pycharm will tell you that there are changes on the remote that need to be merged.

• Docker :

  • Use docker with pycharm, straightforward to pull and create images & containers. Specially, if you want to test your app, you can create an ubuntu container in less then 5sec.

  • In Pycharm settings, configure docker to run under WSL & not Windows. It will automatically detect the ports.

• Remote/local terminal & interpreter :

  • When creating a project with pycharm, you should use the anaconda python (windows or wsl) and not install python or using another one like virtualenv.

  • You can use ubuntu as default terminal in pycharm: tools>terminal and put in a shell path: ubuntu run

  • Add WSL interpreter in Pycharm (add interpreter -> WSL). For example, Conda, installed in WSL, will be available in Pycharm.

  • You can use docker as an interpreter in Pycharm (If you have a powerful computer like a desktop or a Macbook, otherwise, a laptop with Windows 11 + WSL2 + pycharm + docker isn't a good idea). To set Docker Port Bindings When Using Pycharm Run/Debug Go to: Python file > Edit Configuration > Docker container settings (click on open folder icon) At Edit Docker Container Settings, you can add Port bindings. Or set the python configuration to use this so all the python files can use the same configuration.

• Always use Markdown code and add py to tell the Markdown that it's python code. When you will do refactor. It will change the python code in the readme.

• Plugins: You can download plugins from the settings menu. I recommend the following plugins:

  • GitHub copilot (autocomplete, but also provides functions when you right-click on something like: explain, generate tests...etc.)

  • default plugins: services with docker...

  • TBD

• PyCharm has keyboard shortcuts for most of its commands related to editing, navigation, refactoring, debugging, and other tasks. Memorizing these hotkeys can help you stay more productive by keeping your hands on the keyboard. Link to Cheatsheet

• If the plugin Table of contents doesn't work on a Markdown file, create a small table with the title & two<!-- TOC -->, it should detect it.

• Pycharm has fuzzy search when creating a file. For example, 'alt+p' then 'alt+ins' then 'pf' to create a python file

• (To confirm) Pycharm Jupyter Notebook: Use the one provided in Pycharm. It provides better autocomplete.

• WriterSide issue : files eit

1.9.2. Personal pycharm shortcuts

OfficialLink to Cheatsheet

Some of them are re-mapped :

Panels & windows :

Code editor

1.9.3. Python remote interpreter (SSH /WSL)

• add a remote python interpreter: usually found with which python on the remote server or WSL.

• PyCharm envs: You can clean out old PyCharm interpreters that are no longer associated with a project see the image here.

• This gives you a listing where you can get rid of old virtualenvs that PyCharm thinks are still around

1.9.4. Pycharm remote deployment

WARNING: project folder needs to be on windows and not WSL to use the remote ssh. Do not host folders outside WSL if you are not using a remote interpreter, there are WSL perforamance issues)

Defining a server as default: A deployment server is considered default if its settings apply by default during automatic upload of changed files. To define a deployment server as the default one, follow these steps:

Choose the desired server on the Deployment page. You can open this page it two possible ways: either Settings/Preferences | Build, Execution, Deployment | Deployment, or Tools | Deployment | You will see your servers, right click on the one you want to set it as default, and click 'use as default'

Enabling automatic upload: As soon as the default server is set, you can make upload to this server automatic. This can be done in the following two ways:

Open the deployment Options (Settings/Preferences | Deployment | Options or Tools | Deployment | Options from the main menu), and in the Upload changed files automatically to the default server field choose Always, or On explicit save action. The difference between these two choices is explained in the field description. In the main menu, select Tools | Deployment | Automatic upload. Note that automatic upload in this case is performed in the Always mode.

1.9.5. Remote SSH for ReactJS

• First, make sure that in the server, the React project is running when you run yarn dev run

• In pycharm, go to configuration and create a new config for npm

• select package.json from the local folder

• select command: run

• select scripts: dev

• Node interpreter: copy and paste the result of the command which node in the remote server

• package manager: yarn, for example

• environment: PATH= put the result of the command echo $PATH

1.13.1. Installation:

• Always use the desktop app to install addons & configure them, settings will be synchronized between all your devices

• (Update July 2024): You need both stremio and stremio service on PC to make it work perfectly.

• Setup : Tutorial

  • Force stop or restart the app on your deivces to synchronize the settings if you add an addon with the desktop app.

  • My recommended official addons: Watchhub, Cinemeta, Opensubtitles V3, Opensubtitles, Local Files

  • My recommended community addons : Streaming Catalogs, Trakt TV (with two websites : trakt.tv + couchmoney, Torrentio (With real-debrid), YggStremio (for french), debrid search (with real-debrid)

    • Order of installed community addons: Trakt TV, Streaming Catalogs, Torrentio, YggStremio, Debrid search

    • Trakt addon uses trakt.tv (requires login) and couchmoney (if you want recommendations)

    • Ratings & history: I rank my movies (and series) on trakt (they will automatically mark as watched if you activate that setting in trakt's website : settings -> Mark Watched After Rating: Automatically mark unwatched items with today's date).

    • If you want to syncronize everything with IMDB and/or the streaming platforms, you can use these two applications:

      • Universal Trakt Scrobbler - a Chrome extension for synchronizing Streaming platforms (netflix, prime,...) watched history with Trakt

      • IMDB-Trakt-Syncera python app to synchronize IMDB ratings, watchlist... with Trakt both ways (You can use it in WSL2, install Google Chrome in WSL2 first)

  Tips :

  • Use Stremio desktop to configure addons. ALl settings & addons will sync between your devices if you use the same account.

  • You can install multiple times addons with different configurations (for example, a Torrentio specific for french audio).

  • Order of a list in Stremio home is determined by the installation order.

  • Sort and filter movies inside a list by clicking on 'see more' on a list.

  • You can find and safely download all the torrents from real debrid in the torrents section. Click on the green box to either download or stream the torrent.

  • You can also use stremio on iOS with VLC: go to stremio web and follow this tutorial. It works with torrents and everything.

  • Remember to rate what you watch on IMDB or trakt and run the Chrome extension & python app to sync everything.

  • If you didn't rate some movies & tv shows, you can add them to history in Trakt to avoid being recommended in couchmoney (no need to rate them if you forget how good or bad the movie was)