Skip to content

Commit

Permalink
update docs installation
Browse files Browse the repository at this point in the history
  • Loading branch information
claromes committed Jul 4, 2024
1 parent 95850a2 commit 2b2169b
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
38 changes: 29 additions & 9 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
.. _installation:

Installation
================

**It is compatible with Python versions 3.10 and above.**

Using pip
------------
Expand All @@ -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 [email protected]: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
Expand Down

0 comments on commit 2b2169b

Please sign in to comment.