Skip to content

Commit 16834d7

Browse files
authored
Merge branch 'master' into sounds_setters
2 parents a2176dc + 6c56cc0 commit 16834d7

File tree

3 files changed

+63
-2
lines changed

3 files changed

+63
-2
lines changed

docs/changelog.rst

+9
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,18 @@ Master
77
- Fix :func:`~twitchio.Client.search_categories` due to :attr:`~twitchio.Game.igdb_id` being added to :class:`~twitchio.Game`
88
- Made Chatter :attr:`~twitchio.Chatter.id` property public
99

10+
1011
- ext.sounds
1112
- Bug fixes
1213
- Added setters for Sounds.rate and Sounds.channels properties
14+
15+
- Other
16+
- [speed] extra
17+
- Added wheels on external pypi index for cchardet and ciso8601
18+
- Bumped ciso8601 from >=2.2,<2.3 to >=2.2,<3
19+
- Bumped cchardet from >=2.1,<2.2 to >=2.1,<3
20+
21+
1322
2.6.0
1423
======
1524
- TwitchIO

docs/installing.rst

+52
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,55 @@ Make sure you have the latest version of Python installed, or if you prefer, a P
2525

2626
If you have have any other issues feel free to search for duplicates and then create a new issue on GitHub with as much detail as
2727
possible. Including providing the output of pip, your OS details and Python version.
28+
29+
30+
Extras
31+
-------
32+
Twitchio has some extra downloaders available to modify the library.
33+
Due to some outdated binaries on the pypi package index, when using Python 3.11+, you'll want to make use of our custom pypi
34+
index for these extras. You can access this index by doing the following (replace your-extra with the extra you want to use):
35+
36+
.. code:: sh
37+
38+
python3 -m pip install -U twitchio[your-extra] --extra-index-url https://pip.twitchio.dev/
39+
40+
Or, on windows:
41+
42+
.. code:: sh
43+
44+
py -3.11 -m pip install -U twitchio[your-extra] --extra-index-url https://pip.twitchio.dev/
45+
46+
47+
If you do not wish to use our custom index, you can build the wheels yourself by installing cython through pip prior to installing the extra.
48+
Note that you will need C build tools installed to be able to do this.
49+
50+
Extra: speed
51+
++++++++++++++
52+
The speed extra will install dependancies built in C that are considerably faster than their pure-python equivalents.
53+
You can install the speed extra by doing:
54+
55+
.. code:: sh
56+
57+
python3 -m pip install -U twitchio[speed] --extra-index-url https://pip.twitchio.dev/
58+
59+
Or, on windows:
60+
61+
.. code:: sh
62+
63+
py -3.11 -m pip install -U twitchio[speed] --extra-index-url https://pip.twitchio.dev/
64+
65+
Extra: sounds
66+
+++++++++++++++
67+
The sounds extra installs extra dependancies for using the sounds ext.
68+
If you wish to use the sounds ext, you will need to install this extra, which you can do by doing the following:
69+
70+
71+
.. code:: sh
72+
73+
python3 -m pip install -U twitchio[sounds] --extra-index-url https://pip.twitchio.dev/
74+
75+
Or, on windows:
76+
77+
.. code:: sh
78+
79+
py -3.11 -m pip install -U twitchio[sounds] --extra-index-url https://pip.twitchio.dev/

setup.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@
5454
]
5555
speed = [
5656
"ujson>=5.2,<6",
57-
"ciso8601>=2.2,<2.3",
58-
"cchardet>=2.1,<2.2"
57+
"ciso8601>=2.2,<3",
58+
"cchardet>=2.1,<3"
5959
]
6060
extras_require = {"sounds": sounds, "speed": speed}
6161

0 commit comments

Comments
 (0)