-
Notifications
You must be signed in to change notification settings - Fork 113
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
1 changed file
with
46 additions
and
7 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,61 @@ | ||
Installation | ||
============ | ||
|
||
## Package repositories | ||
|
||
toot is packaged for various platforms. If possible use your OS's package manager to install toot. | ||
|
||
[![Packaging status](https://repology.org/badge/vertical-allrepos/toot.svg)](https://repology.org/project/toot/versions) | ||
<details> | ||
<summary>Packaging status</summary> | ||
<a href="https://repology.org/project/toot/versions" style="display: block; margin-top: 2rem"> | ||
<img src="https://repology.org/badge/vertical-allrepos/toot.svg" alt="Packaging status" /> | ||
</a> | ||
</details> | ||
|
||
## Python Package Index | ||
## Homebrew | ||
|
||
Install from PyPI using pip, preferably into a virtual environment. | ||
For Mac users, toot is available [in homebrew](https://formulae.brew.sh/formula/toot#default). | ||
|
||
pip install toot | ||
brew install toot | ||
|
||
## Homebrew | ||
## Using pipx | ||
|
||
For Mac OSX users, toot is available [in homebrew](https://formulae.brew.sh/formula/toot#default). | ||
pipx installs packages from PyPI into isolated environments. It is the | ||
recommended installation method if there is no OS package or the package is | ||
outdated. | ||
|
||
brew install toot | ||
Firstly, install pipx following their [installation instructions](https://pipx.pypa.io/stable/installation/). | ||
|
||
Install toot: | ||
|
||
pipx install toot | ||
|
||
Install with optional image support: | ||
|
||
pipx install "toot[images]" | ||
|
||
Upgrade to latest version: | ||
|
||
pipx upgrade toot | ||
|
||
## From source | ||
|
||
You can get the latest source distribution [from Github](https://github.com/ihabunek/toot/releases/latest/). | ||
|
||
Clone the project and install into a virtual environment. | ||
|
||
``` | ||
git clone [email protected]:ihabunek/toot.git | ||
cd toot | ||
python3 -m venv .venv | ||
source .venv/bin/activate | ||
pip install . | ||
``` | ||
|
||
After this, the executable is available at `.venv/bin/toot`. | ||
|
||
To install with optonal image support: | ||
|
||
``` | ||
pip install ".[images]" | ||
``` |