From 2b2169bb7da7b0613d54782ccc97cb2c7bfe4ed8 Mon Sep 17 00:00:00 2001 From: Claromes Date: Thu, 4 Jul 2024 16:34:46 -0300 Subject: [PATCH] update docs installation --- docs/contribute.rst | 2 +- docs/installation.rst | 38 +++++++++++++++++++++++++++++--------- 2 files changed, 30 insertions(+), 10 deletions(-) diff --git a/docs/contribute.rst b/docs/contribute.rst index 54376ac..edaab0c 100644 --- a/docs/contribute.rst +++ b/docs/contribute.rst @@ -19,7 +19,7 @@ These are the prerequisites: - Python 3.10+ - Poetry -Install from the source, following the :ref:`installation` instructions. +Install from the source, following the :ref:`installation_from_source` instructions. Brief explanation about the code under the Wayback Tweets directory: diff --git a/docs/installation.rst b/docs/installation.rst index 52e614d..dd35b7a 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,8 +1,7 @@ -.. _installation: - Installation ================ +**It is compatible with Python versions 3.10 and above.** Using pip ------------ @@ -11,47 +10,68 @@ Using pip pip install waybacktweets +Using Poetry +------------ + + .. code-block:: shell + + poetry add waybacktweets + +.. _installation_from_source: + From source ------------- - Clone the repository: + **Clone the repository:** .. code-block:: shell git clone git@github.com:claromes/waybacktweets.git - Change directory: + **Change directory:** .. code-block:: shell cd waybacktweets - Install poetry, if you haven't already: + **Install Poetry, if you haven't already:** .. code-block:: shell pip install poetry - Install the dependencies: + **Install the dependencies:** .. code-block:: shell poetry install - Run the CLI: + **Install the pre-commit:** + + .. code-block:: shell + + poetry run pre-commit install + + **Run the CLI:** .. code-block:: shell poetry run waybacktweets [SUBCOMMANDS] - Run the Streamlit App: + **Starts a new shell and activates the virtual environment:** + + .. code-block:: shell + + poetry shell + + **Run the Streamlit App:** .. code-block:: shell streamlit run app/app.py - Build the docs: + **Build the docs:** .. code-block:: shell -- 2.34.1