-
-
Notifications
You must be signed in to change notification settings - Fork 158
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3a22cb4
commit f594264
Showing
1 changed file
with
18 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,23 @@ | ||
### This is the official repository for python plugins. | ||
## Official Albert Python plugin repository | ||
|
||
This repository is shipped with albert. If you want to have bleeding edge plugins or share your work clone the repository. Check the [docs on Python plugins](https:/albertlauncher/plugins/blob/master/python/README.md). To install the plugins in user space type the following in your terminal: | ||
|
||
```shell | ||
git clone https:/albertlauncher/python.git ~/.local/share/albert/python/plugins | ||
``` | ||
|
||
Credits go to our contributors | ||
This repository is shipped with Albert. Credits go to our contributors 👍 | ||
|
||
<a href = "https:/albertlauncher/python/graphs/contributors"> | ||
<img src = "https://contrib.rocks/image?repo=albertlauncher/python"/> | ||
</a> | ||
|
||
### Contribution | ||
|
||
* Fork this repository. | ||
* Clone it into the Python user plugin location. | ||
```shell | ||
# on linux | ||
git clone https:/<username>/python.git ~/.local/share/albert/python/plugins | ||
|
||
# on macos | ||
git clone https:/<username>/python.git ~/Library/Application\ Support/albert/python/plugins | ||
``` | ||
* Open the directory in your favorite IDE (PyCharmCE is a good choice). | ||
* Write your plugin (Make sure it is upstream-polished-enough though). | ||
This repository ships a [python stub file](https:/albertlauncher/python/blob/master/albert.pyi) which gives you coding assistance. | ||
* Commit, push, send a PR. |