PR: Add API to start/stop animations to the Spin class

[ccordoba12]

• This also adds a kwarg to decide if the animation should be automatically started (in some situations that's not desired).
• I realized this is necessary to stop the spinner based on a QtAwesome we added to Spyder in PR: Create loading screen for the Dependencies widget, and added new icons for dependencies, debug, console-off and console-remote-off spyder#21271. Without this, the spinner keeps running forever, even when the widget that contains it is hidden.
• To fix that problem we also need an accompanying PR on the Spyder side, which I'll create once a new version of QtAwesome is released (but I tested this PR locally with the necessary changes in Spyder and it's working as expected).

Fixes #165.

[dalthviz]

Should we mark this as the fix for #165 @ccordoba12 ?

[ccordoba12]

Yep, you're totally right (I didn't know about that issue).

[ccordoba12]

And my question for you: should we add documentation for this new feature? And if so, where should I put it?

[dalthviz]

should we add documentation for this new feature?

That's a good point, I would say yes 👍

And if so, where should I put it?

Probably we could expand the Animations usage example at least:

qtawesome/README.md

Lines 158 to 166 in d1371a7

	- Animations
	```python
	# Spining icons
	spin_button = QtWidgets.QPushButton(' Spinning icon')
	spin_icon = qta.icon('fa5s.spinner', color='red',
	animation=qta.Spin(spin_button))
	spin_button.setIcon(spin_icon)
	```

qtawesome/docs/source/usage.rst

Lines 171 to 179 in d1371a7

	- Animations:
	.. code:: python
	# Spin icons
	spin_button = QtWidgets.QPushButton(' Spinning icon')
	spin_icon = qta.icon('fa5s.spinner', color='red',
	animation=qta.Spin(spin_button))
	spin_button.setIcon(spin_icon)

qtawesome/example.py

Lines 123 to 127 in d1371a7

	# Spin icons
	spin_button = QtWidgets.QPushButton(' Spinning icon')
	spin_icon = qta.icon('fa5s.spinner', color='red',
	animation=qta.Spin(spin_button))
	spin_button.setIcon(spin_icon)

Maybe in the future we should try to expand the API reference to cover not only the qtawesome/__init__.py but also improve other places docstrings and use those to autogenerate more docs reference pages 🤔

[ccordoba12]

Probably we could expand the Animations usage example at least:

Done in the three places you referenced above.

[dalthviz]

Note: Seems like on Windows with PyQt5 running the example.py script (or maybe pytest?) is failing with exit code 127. Other checks were failing due to the coverage upload step failing but a couple of reruns help with that 🤔

[ccordoba12]

Fixed in my last commit by skip running the example file when using PyQt5.

[dalthviz]

Thanks @ccordoba12 ! Regarding your last comment:

Fixed in my last commit by skip running the example file when using PyQt5.

I think is fine for the moment but probably worthy to understand why the running the example.py run is failing over CI, no? Should we at least create a follow up issue for that before merging this as it is? What do you think?

[ccordoba12]

I think is fine for the moment but probably worthy to understand why the running the example.py run is failing over CI, no?

Yeah, that's a good point. I think the problem has to do with the new timers I added to start/stop animations of some icons.

Should we at least create a follow up issue for that before merging this as it is? What do you think?

Agreed. I'll create one and take a look at it after Spyder 6 alpha3 is released.

[dalthviz]

Created #254 to proceed with the merge here