From ee9057e74c8129c8a364fb8fc6bb354667734545 Mon Sep 17 00:00:00 2001 From: Paul-Emmanuel Raoul Date: Fri, 13 Dec 2024 17:09:56 +0100 Subject: [PATCH] Update installation instructions --- docs/development/documentation.rst | 2 +- docs/installation.rst | 25 ++++++++++++++++++++----- 2 files changed, 21 insertions(+), 6 deletions(-) diff --git a/docs/development/documentation.rst b/docs/development/documentation.rst index 14e59f2..6606f3c 100644 --- a/docs/development/documentation.rst +++ b/docs/development/documentation.rst @@ -15,7 +15,7 @@ To install the dependencies in `docs`: :: - pip3 install .[docs] + pip install .[docs] Build the documentation diff --git a/docs/installation.rst b/docs/installation.rst index 96f20a9..cbc5782 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -5,9 +5,22 @@ Installation From PyPI (recommended) ----------------------- -:: +To install Faker Wi-Fi ESSID from `PyPI`_ with pip: - pip3 install --upgrade faker-wifi-essid +.. code:: sh + + pip install --upgrade faker-wifi-essid + +However, as Faker Wi-Fi ESSID is a programming library (a `module `_ in Python parlance), it is most likely to be added as a dependency +to the `pyproject.toml` file of your project or its equivalent configuration +file: + +.. code:: toml + + dependencies = [ + "faker_wifi_essid", + ] From sources ------------ @@ -17,10 +30,12 @@ Faker Wi-Fi ESSID is packaged with `Setuptools`_. The default Git branch is `develop`. To install the latest stable version, you need to clone the `main` branch. -:: +.. code:: sh - git clone -b main git@github.com:SkypLabs/faker-wifi-essid.git + git clone -b main https://github.com/SkypLabs/faker-wifi-essid.git cd faker-wifi-essid - pip3 install . + pip install . +.. _Python Modules: https://docs.python.org/3/tutorial/modules.html +.. _PyPI: https://pypi.org/ .. _Setuptools: https://pypi.org/project/setuptools/