Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/docs/installing/python.rst
diff options
context:
space:
mode:
authorAnton Hvornum <anton@hvornum.se>2023-11-22 22:45:25 +0100
committerGitHub <noreply@github.com>2023-11-22 22:45:25 +0100
commite28ba953708cee089161a795fb3191cfd5c3d93a (patch)
tree6cc746c2f4d36582d7add747a8f08349ebec9d44 /docs/installing/python.rst
parentf3b4858a26308b33918226ce18a71de4b3caebb1 (diff)
Restoring back the docs with a commit, as I'm clearly incapable of grasping git's reset/revert features.. (#2249)
Diffstat (limited to 'docs/installing/python.rst')
-rw-r--r--docs/installing/python.rst59
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/installing/python.rst b/docs/installing/python.rst
new file mode 100644
index 00000000..edd55138
--- /dev/null
+++ b/docs/installing/python.rst
@@ -0,0 +1,59 @@
+.. _installing.python:
+
+Python library
+==============
+
+Archinstall ships on `PyPi <https://pypi.org/>`_ as `archinstall <pypi.org/project/archinstall/>`_.
+But the library can be installed manually as well.
+
+.. warning::
+ These steps are not required if you want to use archinstall on the official Arch Linux ISO.
+
+Installing with pacman
+----------------------
+
+Archinstall is on the `official repositories <https://wiki.archlinux.org/index.php/Official_repositories>`_.
+And it will also install archinstall as a python library.
+
+To install both the library and the archinstall script:
+
+.. code-block:: console
+
+ pacman -S archinstall
+
+Alternatively, you can install only the library and not the helper executable using the ``python-archinstall`` package.
+
+Installing with PyPi
+--------------------
+
+The basic concept of PyPi applies using `pip`.
+
+.. code-block:: console
+
+ pip install archinstall
+
+.. _installing.python.manual:
+
+Install using source code
+-------------------------
+
+| You can also install using the source code.
+| For sake of simplicity we will use ``git clone`` in this example.
+
+.. code-block:: console
+
+ git clone https://github.com/archlinux/archinstall
+
+You can either move the folder into your project and simply do
+
+.. code-block:: python
+
+ import archinstall
+
+Or you can PyPa's `build <https://github.com/pypa/build>`_ and `installer <https://github.com/pypa/installer>`_ to install it into pythons module path.
+
+.. code-block:: console
+
+ $ cd archinstall
+ $ python -m build .
+ $ python -m installer dist/*.whl \ No newline at end of file