Skip to content
This repository was archived by the owner on May 27, 2025. It is now read-only.

Commit f2eabcb

Browse files
authored
Update README.rst
1 parent e33140f commit f2eabcb

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,17 @@
22
scandir, a better directory iterator and faster os.walk()
33
=========================================================
44

5-
.. image:: https://img.shields.io/pypi/v/scandir.svg
6-
:target: https://pypi.org/project/scandir/
7-
:alt: scandir on PyPI (Python Package Index)
5+
**Note: This repository is archived, because the "scandir" feature
6+
has been included in the Python standard library since Python 3.5.**
7+
You can still download scandir from PyPI if you want, but I won't
8+
be making any more updates, and this repo has been archived. You're
9+
better off using `os.scandir() <https://docs.python.org/3/library/os.html#os.scandir>`_
10+
and `os.walk() <https://docs.python.org/3/library/os.html#os.walk>`_ directly from the Python
11+
standard library.
812

9-
.. image:: https://github.com/benhoyt/scandir/actions/workflows/tests.yml/badge.svg
10-
:target: https://github.com/benhoyt/scandir/actions/workflows/tests.yml
11-
:alt: GitHub Actions Tests
13+
You can read the story of `how I contributed scandir to Python <https://benhoyt.com/writings/scandir/>`_, and I've kept the old README below.
1214

15+
----------
1316

1417
``scandir()`` is a directory iteration function like ``os.listdir()``,
1518
except that instead of returning a list of bare filenames, it yields

0 commit comments

Comments
 (0)