installation.rst 2.05 KB
Newer Older
1
2
3
4
5
6
.. _installation:

============
Installation
============

7
8
9
10
11
12
13
14
15
Repod is available on the Python Package Index (PyPi):
https://pypi.org/project/repod/

You can install the latest released version of repod by executing

.. code:: sh

  pip install repod

16
17
18
19
20
21
22
23
24
.. note::

  Installing a wheel distributable (e.g. via ``pip install``) does not create
  required directories for system-mode (see :ref:`repod.conf`), nor does it
  provide the man pages.
  Users requiring system-mode and downstream packagers should therefore use the
  provided |justfile| for installation on a system level. Refer to ``just -l``
  to learn more about the provided targets.

25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
Requirements
------------

Installing repod automatically installs its dependencies as well.

A few optional dependencies offer different functionality over the defaults.

Pyalpm
^^^^^^

By default repod makes use of an internal implementation of |vercmp|. If |pyalpm|
is detected it is used for version comparison instead.

Python-magic
^^^^^^^^^^^^
40

41
42
By default repod makes use of |python-magic| for file type detection. If
``file-magic`` (provided by |file|) is detected, it is used instead.
43

44
45
46
47
Development environment
-----------------------

The repod project can be used from a git clone of the project, with the help of
48
|pdm|.
49
50
51

.. code:: sh

David Runge's avatar
David Runge committed
52
53
  git clone https://gitlab.archlinux.org/archlinux/repod/
  cd repod
54
  pdm install
55

56
57
Afterwards it is possible to make use of existing :ref:`tooling <manuals>` with
the help of ``pdm run`` (e.g. ``pdm run repod-file --help``).
58

59
60
61
62
.. |justfile| raw:: html

  <a target="blank" href="https://just.systems/man/en/">justfile</a>

63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
.. |vercmp| raw:: html

  <a target="blank" href="https://man.archlinux.org/man/vercmp.8">vercmp</a>

.. |pyalpm| raw:: html

  <a target="blank" href="https://pypi.org/project/pyalpm/">pyalpm</a>

.. |python-magic| raw:: html

  <a target="blank" href="https://pypi.org/project/python-magic/">python-magic</a>

.. |file| raw:: html

  <a target="blank" href="https://darwinsys.com/file/">file</a>

79
.. |pdm| raw:: html
80

81
  <a target="blank" href="https://pdm.fming.dev/latest/">pdm</a>