From 410a0ba0b3065acd3db09bcd511036975fa0967f Mon Sep 17 00:00:00 2001 From: Anton Hvornum Date: Mon, 28 Sep 2020 16:38:10 +0200 Subject: Added documentation for: https://python-archinstall.readthedocs.io/en/latest/ --- docs/installing/python.rst | 49 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 docs/installing/python.rst (limited to 'docs/installing/python.rst') 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 `_ as `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 `_ to install it into the module path. + +.. code-block:: + + sudo python setup.py install \ No newline at end of file -- cgit v1.2.3-54-g00ecf