Recommended installation

[ArjixWasTaken]

Personally, I recommend installing this project using pipx.

pipx install git+https://github.com/KraXen72/shira

If you get a missing dependency error, you can simply inject it.
e.g.

pipx inject shira pillow
pipx inject shira mediafile

This way you won't pollute your system packages, if you are on ubuntu for example.

[ArjixWasTaken]

Note:

Installing via a link also works with normal pip, e.g. pip install git+https://github.com/KraXen72/shira
But I wouldn't recommend doing that if you are on linux.

[KraXen72]

i have not heard of pipx before. i'll look it up and possibly add it to the install instructions if it proves to be simpler for users to install. my end goal would be publishing the package in pypi, but even then, it's still some extra setup due to ffmpeg.

[ArjixWasTaken]

From pypa

pip is a general-purpose package installer for both libraries and apps with no environment isolation.

pipx is made specifically for application installation, as it adds isolation yet still makes the apps available in your shell;
pipx creates an isolated environment for each application and its associated packages.

So really, the only difference is that with pipx you are not polluting your global packages.

Note: Just like with npx (for nodejs)

[KraXen72]

can i provide a list of dependencies for pipx? would be better than having to install manually

[KraXen72]

hmm, i see there's this open pr, but there might be a better solution in the meantime - are you aware of one? thanks!

[ArjixWasTaken]

pipx uses the same build system as pip, so you only have to list your dependencies in pyproject.toml

https://github.com/KraXen72/shira/blob/master/pyproject.toml#L6

you are missing mediafile and pillow

[KraXen72]

okay, i added them. could you please test if it all works with pipx install git+https://github.com/KraXen72/shira? i'll test it later as well. then, if it works, you can open a pr which adds this way on top of the install instructions in README, keeping the old way as a fallback. if you don't want to open a pr, let me know, i'll change it later. thanks for tellling me about this.

[ArjixWasTaken]

Works

(ignore the --force flag, I was testing smth)

[KraXen72]

w

[KraXen72]

since you can get pipx off of scoop i'll change the recommended windows install method to first install scoop, then pipx & ffmpeg and then this. sounds like a nice way to kill 2 birds with one stone. i'll add a mention about linux as well, that you can just install ffmpeg & pipx from wherever and then use the same pipx command. i'll keep the current install instructions under some later section about contributing.

[thegu5]

Pipx is now the suggested method, what's left now is windows vs linux vs contributing