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.feeds+github@gmail.com>2020-09-28 16:38:10 +0200
committerAnton Hvornum <anton.feeds+github@gmail.com>2020-09-28 16:38:10 +0200
commit410a0ba0b3065acd3db09bcd511036975fa0967f (patch)
tree59d843498db308059f0388eb8315c42f187ccfc2 /docs/installing/python.rst
parentd44c671661707282e6ec06dc4a0c0cafb8ba19aa (diff)
Added documentation for: https://python-archinstall.readthedocs.io/en/latest/
Diffstat (limited to 'docs/installing/python.rst')
-rw-r--r--docs/installing/python.rst49
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/installing/python.rst b/docs/installing/python.rst
new file mode 100644
index 00000000..6ca2adb6
--- /dev/null
+++ b/docs/installing/python.rst
@@ -0,0 +1,49 @@
+.. _installing.python:
+
+Python library
+==============
+
+Archinstall shipps on `PyPi <https://pypi.org/>`_ as `archinstall <pypi.org/project/archinstall/>`_.
+But the library can be installed manually as well.
+
+Using PyPi
+----------
+
+The basic concept of PyPi applies using `pip`.
+Either as a global library:
+
+.. code-block::
+
+ sudo pip install archinstall
+
+Or as a user module:
+
+.. code-block::
+
+ pip --user install archinstall
+
+Which will allow you to start using the library.
+
+.. _installing.python.manual
+
+Manual installation
+-------------------
+
+You can either download the github repo as a zip archive.
+Or you can clone it, we'll clone it here but both methods work the same.
+
+.. code-block::
+
+ git clone https://github.com/Torxed/archinstall
+
+Either you can move the folder into your project and simply do
+
+.. code-block:: python
+
+ import archinstall
+
+Or you can use `setuptools <https://pypi.org/project/setuptools/>`_ to install it into the module path.
+
+.. code-block::
+
+ sudo python setup.py install \ No newline at end of file