Skip to content

Commit eb94bd6

Browse files
committed
Update installing instructions
1 parent 03ebf64 commit eb94bd6

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

docs/getting-started/installing.rst

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,24 @@ Installing
77
TwitchIO 3 currently supports the following `Python <https://www.python.org/downloads/>`_ versions:
88

99

10-
+---------------------+-------------------------------------------------+-------------------------------+
11-
| Python Version | Status | Notes |
12-
+=====================+=================================================+===============================+
13-
| **<= 3.10** | .. raw:: html | ... |
14-
| | | |
15-
| | <span class="error-tio">Not Supported</span> | |
16-
| | | |
17-
+---------------------+-------------------------------------------------+-------------------------------+
18-
| **3.11, 3.12** | .. raw:: html | ... |
19-
| | | |
20-
| | <span class="success-tio">Supported</span> | |
21-
| | | |
22-
+---------------------+-------------------------------------------------+-------------------------------+
23-
| **3.13, 3.14** | .. raw:: html | May require custom index |
24-
| | | |
25-
| | <span class="warn-tio">Check Notes</span> | |
26-
| | | |
27-
+---------------------+-------------------------------------------------+-------------------------------+
10+
+-----------------------------+-------------------------------------------------------+-------------------------------+
11+
| Python Version | Status | Notes |
12+
+=============================+=======================================================+===============================+
13+
| **<= 3.10** | .. raw:: html | ... |
14+
| | | |
15+
| | <span class="error-tio">Not Supported</span> | |
16+
| | | |
17+
+-----------------------------+-------------------------------------------------------+-------------------------------+
18+
| **3.11, 3.12m 3.13** | .. raw:: html | ... |
19+
| | | |
20+
| | <span class="success-tio">Fully Supported</span> | |
21+
| | | |
22+
+-----------------------------+-------------------------------------------------------+-------------------------------+
23+
| **3.14** | .. raw:: html | May require custom index |
24+
| | | |
25+
| | <span class="warn-tio">Check Notes</span> | |
26+
| | | |
27+
+-----------------------------+-------------------------------------------------------+-------------------------------+
2828

2929

3030
Virtual Environments
@@ -55,7 +55,7 @@ Windows
5555
venv/Scripts/Activate
5656
5757
# Install your packages...
58-
pip install -U twitchio
58+
pip install -U twitchio --pre
5959
6060
# You can use your venv python while it's activated simply by running py
6161
# E.g. py main.py
@@ -88,7 +88,7 @@ Linux & MacOS
8888
source venv/bin/activate
8989
9090
# Install your packages...
91-
pip install -U twitchio
91+
pip install -U twitchio --pre
9292
9393
# You can use your venv python while it's activated simply by running python
9494
# E.g. python main.py
@@ -120,27 +120,27 @@ The following commands can be used to install TwitchIO with optional features:
120120

121121
.. code:: shell
122122
123-
pip install -U twitchio[starlette]
123+
pip install -U twitchio[starlette] --pre
124124
125125
126126
**For development purposes**:
127127

128128
.. code:: shell
129129
130-
pip install -U twitchio[dev]
130+
pip install -U twitchio[dev] --pre
131131
132132
133133
**For documentation purposes**:
134134

135135
.. code:: shell
136136
137-
pip install -U twitchio[docs]
137+
pip install -U twitchio[docs] --pre
138138
139139
140140
Custom Index
141141
============
142142

143-
Using TwitchIO with ``Python >= 3.13`` may require the use of a custom pip index.
143+
Using TwitchIO with ``Python >= 3.14`` may require the use of a custom pip index.
144144
The index allows pip to fetch pre-built wheels for some dependencies that may require build-tools for C/C++ due to not having released their own wheels for recent versions of Python.
145145

146146
Usually with time, dependencies will eventually release wheels for new Python releases.
@@ -151,7 +151,7 @@ For convenience we provide an index thanks to `Abstract Umbra <https://github.co
151151

152152
.. code:: shell
153153
154-
pip install -U twitchio --extra-index-url https://pip.pythonista.gg
154+
pip install -U twitchio --pre --extra-index-url https://pip.pythonista.gg
155155
156156
157157
Installation Issues

0 commit comments

Comments
 (0)