Skip to content

albertlauncher/python

Repository files navigation

Official Albert Python plugin repository

This repository is shipped with Albert. Credits go to our contributors 👍

Contribution

  • Fork this repository.
  • Clone it into the Python user plugin location.
    # on linux
    git clone https://github.com/<username>/python.git ~/.local/share/albert/python/plugins
    
    # on macos
    git clone https://github.com/<username>/python.git ~/Library/Application\ Support/albert/python/plugins
  • Open the directory in your favorite IDE (PyCharmCE is a good choice).
  • The Python plugins plugin installs a python stub file in your user plugin directory. This file serves as API documentation and gives you coding assistance if you are using a decent IDE.
  • Write your plugin. Make sure it is polished (No bugs, few to no linting warnings, efficient, readable, maintainable, …).
  • Commit, push, send a PR.