Release 1.2.0

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [master, dev]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --dev --frozen
+
+      - name: Lint
+        run: uv run ruff check .
+
+      - name: Run tests
+        run: uv run pytest -v test_pyspin.py

ChangLog → ChangLog.md

@@ -1,5 +1,18 @@
 Version numbers are following the Semantic Versioning.
 
+2026.03.21 v1.2.0
+- add
+    - context manager support for Spinner, thanks to @liiight 
+- fix
+    - flush ending output in make_spin
+    - harden TTY detection (support non-callable isatty and bool isatty)
+- change
+    - drop Python 2.x support
+    - require Python 3.10+
+- other
+    - migrate from Travis CI to GitHub Actions
+    - migrate from pip/setup.py to uv
+
 2017.04.13 v1.1.1
 - fix
     - fix incorrect futures requirement, thanks to @xoviat

MANIFEST.in

@@ -1,2 +1,4 @@
-include README.md
+include README.rst
 include LICENSE
+include test_pyspin.py
+global-exclude *.py[co]

Makefile

@@ -1,8 +1,11 @@
 test:
-	@py.test --pep8 -v test_pyspin.py pyspin/
+	@uv run pytest -v test_pyspin.py
+
+lint:
+	@uv run ruff check .
 
 create:
-	@python setup.py sdist bdist_wheel
+	@uv build
 
 upload:
-	@python setup.py sdist bdist_wheel upload
+	@uv publish

README.rst

@@ -26,8 +26,6 @@ make a spinner by hand:
 
 .. code:: python
 
-    from __future__ import print_function
-
     import sys
     import time
 
@@ -45,8 +43,6 @@ or you can use the decorator pyspin provide:
 
 .. code:: python
 
-    from __future__ import print_function
-
     import time
 
     from pyspin.spin import make_spin, Default
@@ -61,6 +57,22 @@ or you can use the decorator pyspin provide:
         download_video()
         print("Done!")
 
+You can also use ``Spinner`` as a context manager:
+
+.. code:: python
+
+    import time
+
+    from pyspin.spin import Default, Spinner
+
+    def download_video():
+        time.sleep(10)
+
+    if __name__ == '__main__':
+        print("I'm going to download a video, and it'll cost much time.")
+        with Spinner(Default, "Downloading...", "Done!\n"):
+            download_video()
+
 You can have a look at the example code in the example folder. Run it
 via:
 
@@ -86,8 +98,8 @@ MIT.
 
 .. |Latest Version| image:: http://img.shields.io/pypi/v/pyspin.svg
    :target: https://pypi.python.org/pypi/pyspin
-.. |Build Status| image:: https://travis-ci.org/lord63/py-spin.svg
-   :target: https://travis-ci.org/lord63/py-spin
+.. |Build Status| image:: https://github.com/lord63/py-spin/actions/workflows/ci.yml/badge.svg
+   :target: https://github.com/lord63/py-spin/actions/workflows/ci.yml
 .. |Python Versions| image:: https://img.shields.io/pypi/pyversions/pyspin.svg
    :target: https://pypi.python.org/pypi/pyspin
 .. |pyspin_demo| image:: https://cloud.githubusercontent.com/assets/5268051/7448038/ba152a8c-f241-11e4-86e0-50bc3b33bce5.gif

example/example_spin.py

@@ -1,42 +1,43 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
+#!/usr/bin/env python3
+# Style showcase — runs each built-in spinner style so you can see what it looks like.
 
-from __future__ import absolute_import, print_function
-
-import sys
 import time
 
 from pyspin import spin
 
+STYLES = [
+    ("Default", spin.Default),
+    ("Box1",    spin.Box1),
+    ("Box2",    spin.Box2),
+    ("Box3",    spin.Box3),
+    ("Box4",    spin.Box4),
+    ("Box5",    spin.Box5),
+    ("Box6",    spin.Box6),
+    ("Box7",    spin.Box7),
+    ("Spin1",   spin.Spin1),
+    ("Spin2",   spin.Spin2),
+    ("Spin3",   spin.Spin3),
+    ("Spin4",   spin.Spin4),
+    ("Spin5",   spin.Spin5),
+    ("Spin6",   spin.Spin6),
+    ("Spin7",   spin.Spin7),
+    ("Spin8",   spin.Spin8),
+    ("Spin9",   spin.Spin9),
+]
+
 
 def show(name, frames):
     s = spin.Spinner(frames)
     print(name)
     for i in range(50):
-        print(u"\r{0}".format(s.next()), end="")
-        sys.stdout.flush()
+        print("\r{0}".format(s.next()), end="", flush=True)
         time.sleep(0.1)
     print('\n')
 
 
 def main():
-    show("Default", spin.Default)
-    show("Box1", spin.Box1)
-    show("Box2", spin.Box2)
-    show("Box3", spin.Box3)
-    show("Box4", spin.Box4)
-    show("Box5", spin.Box5)
-    show("Box6", spin.Box6)
-    show("Box7", spin.Box7)
-    show("Spin1", spin.Spin1)
-    show("Spin2", spin.Spin2)
-    show("Spin3", spin.Spin3)
-    show("Spin4", spin.Spin4)
-    show("Spin5", spin.Spin5)
-    show("Spin6", spin.Spin6)
-    show("Spin7", spin.Spin7)
-    show("Spin8", spin.Spin8)
-    show("Spin9", spin.Spin9)
+    for name, frames in STYLES:
+        show(name, frames)
 
 
 if __name__ == '__main__':

example/usage_example.py

@@ -1,20 +1,25 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-from __future__ import absolute_import, print_function
+#!/usr/bin/env python3
 
 import time
 
-from pyspin.spin import make_spin, Spin1
+from pyspin.spin import Default, Spinner, make_spin, Spin1
 
 
-@make_spin(Spin1, "Downloading...")
-def demo():
+# Context manager — recommended usage.
+def download_video():
     time.sleep(5)
 
 
 if __name__ == '__main__':
-    print("Assume we're downloading a video")
-    print("It would cost much time.")
-    demo()
-    print("Download success!")
+    print("Downloading a video with context manager:")
+    with Spinner(Default, "Downloading...", "Done!\n"):
+        download_video()
+
+    # Decorator — alternative usage.
+    @make_spin(Spin1, "Downloading...")
+    def download_video_with_decorator():
+        time.sleep(5)
+
+    print("Downloading a video with decorator:")
+    download_video_with_decorator()
+    print("Done!")

pyproject.toml

@@ -0,0 +1,34 @@
+[project]
+name = "pyspin"
+version = "1.2.0"
+description = "Little terminal spinner lib."
+readme = "README.rst"
+license = { text = "MIT" }
+authors = [{ name = "lord63", email = "lord63.j@gmail.com" }]
+requires-python = ">=3.10"
+keywords = ["terminal", "spin", "spinner"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: POSIX",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+
+[project.urls]
+Homepage = "https://github.com/lord63/py-spin"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = ["pytest>=8.0", "ruff"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["pyspin"]

pyspin/__init__.py

@@ -12,7 +12,7 @@
 """
 
 __title__ = "pyspin"
-__version__ = '1.1.1'
+__version__ = '1.2.0'
 __author__ = "lord63"
 __license__ = "MIT"
 __copyright__ = "Copyright 2015 lord63"