Skip to content

Commit

Permalink
tweaks to docs for 0.9.5 and to make it easier to identify individual…
Browse files Browse the repository at this point in the history
… install methods
  • Loading branch information
obriencj committed Dec 18, 2020
1 parent c4ef974 commit c82601b
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 8 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,14 +83,18 @@ available by default system-wide, then the package needs to be
installed into the default site-packages for the python
installation.

### Using RPM

If using an RPM-based distribution, this is easily achieved using the
included spec to produce an RPM and install that.

```bash
make clean rpm
dnf install dist/noarch/python3-kojismokydingo-0.9.4-1.fc32.noarch.rpm
dnf install dist/noarch/python3-kojismokydingo-0.9.5-1.fc32.noarch.rpm
```

### System-wide Using Python

Using traditional setuptools or pip installation methods can also
achieve this by specifying the specific root or prefix parameter

Expand All @@ -100,21 +104,23 @@ sudo python setup.py clean build install --root=/

# Python 2.7 global install
python3 setup.py bdist_wheel
pip3 install --prefix /usr -I dist/kojismokydingo-0.9.4-py2-none-any.whl
pip3 install --prefix /usr -I dist/kojismokydingo-0.9.5-py2-none-any.whl

# Python 3 global install
python3 setup.py bdist_wheel
pip3 install --prefix /usr -I dist/kojismokydingo-0.9.4-py3-none-any.whl
pip3 install --prefix /usr -I dist/kojismokydingo-0.9.5-py3-none-any.whl
```

### User-only Using Python

However, if you only want the plugin available for yourself, you can
install it anywhere and tell koji to look in that particular
`site-package/koji_cli_plugins` instance

```bash
# Python 3 user install
python3 setup.py bdist_wheel
pip3 install --user -I dist/kojismokydingo-0.9.4-py3-none-any.whl
pip3 install --user -I dist/kojismokydingo-0.9.5-py3-none-any.whl
```

And the following setting in ~/.koji/config assuming Python version
Expand Down
17 changes: 13 additions & 4 deletions docs/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,13 +126,19 @@ Because of how koji loads client plugins, if you want the meta plugin
available by default system-wide, then the package needs to be installed
into the default site-packages for the python installation.

Using RPM
~~~~~~~~~

If using an RPM-based distribution, this is easily achieved using the
included spec to produce an RPM and install that.

.. code:: bash
make clean rpm
dnf install dist/noarch/python3-kojismokydingo-0.9.4-1.fc32.noarch.rpm
dnf install dist/noarch/python3-kojismokydingo-0.9.5-1.fc32.noarch.rpm
System-wide Using Python
~~~~~~~~~~~~~~~~~~~~~~~~

Using traditional setuptools or pip installation methods can also
achieve this by specifying the specific root or prefix parameter
Expand All @@ -144,11 +150,14 @@ achieve this by specifying the specific root or prefix parameter
# Python 2.7 global install
python3 setup.py bdist_wheel
pip3 install --prefix /usr -I dist/kojismokydingo-0.9.4-py2-none-any.whl
pip3 install --prefix /usr -I dist/kojismokydingo-0.9.5-py2-none-any.whl
# Python 3 global install
python3 setup.py bdist_wheel
pip3 install --prefix /usr -I dist/kojismokydingo-0.9.4-py3-none-any.whl
pip3 install --prefix /usr -I dist/kojismokydingo-0.9.5-py3-none-any.whl
User-only Using Python
~~~~~~~~~~~~~~~~~~~~~~

However, if you only want the plugin available for yourself, you can
install it anywhere and tell koji to look in that particular
Expand All @@ -158,7 +167,7 @@ install it anywhere and tell koji to look in that particular
# Python 3 user install
python3 setup.py bdist_wheel
pip3 install --user -I dist/kojismokydingo-0.9.4-py3-none-any.whl
pip3 install --user -I dist/kojismokydingo-0.9.5-py3-none-any.whl
And the following setting in ~/.koji/config assuming Python version 3.7
– read the output of the install command above to verify your install
Expand Down

0 comments on commit c82601b

Please sign in to comment.