-
-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
30 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
------------ | ||
|
@@ -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 | ||
|