|
1 | | -This is a sloppy fork of [pythonBits](https://github.com/mueslo/pythonbits) that |
2 | | -fixes compatibility issues with recent tools (e.g. mediainfo and tvdb). It's not |
3 | | -a proper fork, I just fix bugs as I find them. |
4 | | - |
5 | | -Everything should work like it does with mueslo/pythonBits, except for the |
6 | | -installation. |
7 | | - |
8 | | -## Installation |
9 | | - |
10 | | -I recommend [pipx](https://pipxproject.github.io/pipx/), which installs Python |
11 | | -packages with all dependencies in a virtual environment in |
12 | | -`~/.local/pipx/<package name>` and thus makes it very easy to uninstall them. To |
13 | | -uninstall pythonBits with pip, you need to do something like this: |
14 | | - |
15 | | -```sh |
16 | | -pip3 uninstall -y appdirs attrdict attrs babelfish boto certifi chardet configparser diskcache future guessit idna imdbpie Logbook pip pkg-resources progressbar2 pymediainfo pyreadline python-dateutil python-utils pythonbits rebulk requests requests-cache setuptools six trans tvdb-api Unidecode urllib3 wheel |
17 | | -``` |
18 | | - |
19 | | -But this might break other Python packages that share dependencies with |
20 | | -pythonBits. This issue doesn't exist with pipx: |
21 | | - |
22 | | -```sh |
23 | | -$ # If possible, install pipx with your package manager, otherwise use pip |
24 | | -$ pip3 install --user pipx |
25 | | -$ # Install pythonBits |
26 | | -$ pipx install --spec git+https://github.com/plotski/pythonBits.git pythonBits |
27 | | -$ # You must also specify the git repository when upgrading |
28 | | -$ pipx upgrade --spec git+https://github.com/plotski/pythonBits.git pythonBits |
29 | | -$ # Uninstalling is straightforward |
30 | | -$ pipx uninstall pythonBits |
31 | | -``` |
32 | | - |
33 | | -If cannot use pipx for some reason, you can also use plain pip, of course. |
34 | | - |
35 | | -```sh |
36 | | -$ pip3 install --upgrade --user git+https://github.com/plotski/pythonBits.git |
37 | | -``` |
| 1 | +# pythonBits |
| 2 | +[](https://GitHub.com/mueslo/pythonBits/releases/) |
| 3 | +[](https://pypi.python.org/pypi/pythonbits/) |
| 4 | +[](https://pypi.python.org/pypi/pythonbits/) |
| 5 | +[](https://github.com/mueslo/pythonBits/commits/master) |
| 6 | +[](https://github.com/mueslo/pythonbits/blob/master/LICENSE) |
| 7 | +[](https://travis-ci.org/mueslo/pythonBits) |
| 8 | +#### A Python description generator for movies and TV shows |
| 9 | + |
| 10 | +## Install |
| 11 | +1. (Optional, highly recommended) Set up a virtualenv to avoid polluting your system with dependencies. |
| 12 | + - with virtualenvwrapper: `mkvirtualenv pythonbits` |
| 13 | + - activate the virtualenv with `workon pythonbits` |
| 14 | +2. Install pythonBits in one of the following ways |
| 15 | + - install via `pip install pythonbits` |
| 16 | + - clone and `pip install .` |
| 17 | + - (dev) clone, install requirements from setup.py and run as `python -m pythonbits` instead of `pythonbits` |
| 18 | +3. Install mediainfo, ffmpeg and mktorrent>=1.1 such that they are accessible for pythonBits |
| 19 | + - you can also manually specify things such as the torrent file or screenshots, this will prevent the programs from being called, removing the dependency |
| 20 | + |
| 21 | +If you don't want to use a virtualenv but keep system pollution with PyPI packages to a minimum, install via `pip install --user`. For more information, visit [this site](https://packaging.python.org/guides/installing-using-pip-and-virtualenv/). |
38 | 22 |
|
39 | 23 | ## Usage |
40 | 24 | ``` |
|
0 commit comments