Skip to content

Commit 61006f0

Browse files
committed
Improve installation documentation
`pipx` is a lot simpler on any setup where this it is available.
1 parent 9b48bcc commit 61006f0

File tree

3 files changed

+26
-23
lines changed

3 files changed

+26
-23
lines changed

CHANGELOG.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Version 0.19.1
1414

1515
- Fixed crash when operating on Google Contacts. :gh:`994`
1616
- The ``HTTP_PROXY`` and ``HTTPS_PROXY`` are now respected. :gh:`1031`
17+
- Various documentation updates.
1718

1819
Version 0.19.0
1920
==============

docs/installation.rst

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,33 @@ way to do this, for example, using Ubuntu::
5555
Then you have several options. The following text applies for most Python
5656
software by the way.
5757

58+
pipx: The clean, easy way
59+
~~~~~~~~~~~~~~~~~~~~~~~~~
60+
61+
pipx_ is a new package manager for Python-based software that automatically
62+
sets up a virtual environment for each program you install. Assuming you have
63+
it installed on your operating system, you can do::
64+
65+
pipx install vdirsyncer
66+
67+
and ``~/.local/pipx/venvs/vdirsyncer`` will be your new vdirsyncer installation. To
68+
update vdirsyncer to the latest version::
69+
70+
pipx upgrade vdirsyncer
71+
72+
If you're done with vdirsyncer, you can do::
73+
74+
pipx uninstall vdirsyncer
75+
76+
and vdirsyncer will be uninstalled, including its dependencies.
77+
78+
.. _pipx: https://github.com/pipxproject/pipx
79+
5880
The dirty, easy way
5981
~~~~~~~~~~~~~~~~~~~
6082

61-
The easiest way to install vdirsyncer at this point would be to run::
83+
If pipx is not available on your distirbution, the easiest way to install
84+
vdirsyncer at this point would be to run::
6285

6386
pip install --ignore-installed vdirsyncer
6487

@@ -92,25 +115,4 @@ This method has two advantages:
92115
distro-specific issues.
93116
- You can delete ``~/vdirsyncer_env/`` to uninstall vdirsyncer entirely.
94117

95-
The clean, easy way
96-
~~~~~~~~~~~~~~~~~~~
97-
98-
pipx_ is a new package manager for Python-based software that automatically
99-
sets up a virtualenv for each program you install. Assuming you have it
100-
installed on your operating system, you can do::
101-
102-
pipx install vdirsyncer
103-
104-
and ``~/.local/pipx/venvs/vdirsyncer`` will be your new vdirsyncer installation. To
105-
update vdirsyncer to the latest version::
106-
107-
pipx upgrade vdirsyncer
108-
109-
If you're done with vdirsyncer, you can do::
110-
111-
pipx uninstall vdirsyncer
112-
113-
and vdirsyncer will be uninstalled, including its dependencies.
114-
115118
.. _virtualenv: https://virtualenv.readthedocs.io/
116-
.. _pipx: https://github.com/pipxproject/pipx

docs/problems.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,5 @@ package that don't play well with packages assuming a normal ``requests``. This
1818
is due to stubbornness on both sides.
1919

2020
See :gh:`82` and :gh:`140` for past discussions. You have one option to work
21-
around this, that is, to install vdirsyncer in a virtualenv, see
21+
around this, that is, to install vdirsyncer in a virtual environment, see
2222
:ref:`manual-installation`.

0 commit comments

Comments
 (0)