Skip to content

Commit

Permalink
Add syntax highlighting for code/command blocks in README.
Browse files Browse the repository at this point in the history
  • Loading branch information
lapets committed May 5, 2023
1 parent a481225 commit 172eb72
Showing 1 changed file with 54 additions and 18 deletions.
72 changes: 54 additions & 18 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,15 @@ Wrapper for Python iterators and iterables that implements a list-like random-ac

Installation and Usage
----------------------
This library is available as a `package on PyPI <https://pypi.org/project/reiter>`__::
This library is available as a `package on PyPI <https://pypi.org/project/reiter>`__:

.. code-block:: bash
python -m pip install reiter
The library can be imported in the usual way::
The library can be imported in the usual way:

.. code-block:: python
import reiter
from reiter import reiter
Expand All @@ -39,7 +43,9 @@ Examples
.. |reiter| replace:: ``reiter``
.. _reiter: https://reiter.readthedocs.io/en/0.8.0/_source/reiter.html#reiter.reiter.reiter

This library makes it possible to wrap any `iterator <https://docs.python.org/3/glossary.html#term-iterator>`__ or `iterable <https://docs.python.org/3/glossary.html#term-iterable>`__ object within an interface that enables repeated iteration over -- and random access by index of -- the items contained within that object. A |reiter|_ instance yields the same sequence of items as the wrapped iterator or iterable::
This library makes it possible to wrap any `iterator <https://docs.python.org/3/glossary.html#term-iterator>`__ or `iterable <https://docs.python.org/3/glossary.html#term-iterable>`__ object within an interface that enables repeated iteration over -- and random access by index of -- the items contained within that object. A |reiter|_ instance yields the same sequence of items as the wrapped iterator or iterable:

.. code-block:: python
>>> from reiter import reiter
>>> xs = iter([1, 2, 3])
Expand All @@ -50,14 +56,18 @@ This library makes it possible to wrap any `iterator <https://docs.python.org/3/
.. |iter| replace:: ``iter``
.. _iter: https://docs.python.org/3/library/functions.html#iter

Unlike iterators and some iterable objects (including those that are built-in and those that are user-defined), an instance of the |reiter|_ class *always* allows iteration over its items any number of times. More specifically, every invocation of |iter|_ (explicit or implicit) returns an iterator that begins iteration from the first item found in the originally wrapped iterator or iterable::
Unlike iterators and some iterable objects (including those that are built-in and those that are user-defined), an instance of the |reiter|_ class *always* allows iteration over its items any number of times. More specifically, every invocation of |iter|_ (explicit or implicit) returns an iterator that begins iteration from the first item found in the originally wrapped iterator or iterable:

.. code-block:: python
>>> list(iter(ys)), list(iter(ys))
([1, 2, 3], [1, 2, 3])
>>> list(ys), list(ys)
([1, 2, 3], [1, 2, 3])
Furthermore, it is also possible to access elements by their index::
Furthermore, it is also possible to access elements by their index:

.. code-block:: python
>>> xs = iter([1, 2, 3])
>>> ys = reiter(xs)
Expand All @@ -70,7 +80,9 @@ Furthermore, it is also possible to access elements by their index::
.. |StopIteration| replace:: ``StopIteration``
.. _StopIteration: https://docs.python.org/3/library/exceptions.html#StopIteration

The built-in Python |next|_ function is also supported, and any attempt to retrieve an item once the sequence of items is exhausted raises the |StopIteration|_ exception in the usual manner::
The built-in Python |next|_ function is also supported, and any attempt to retrieve an item once the sequence of items is exhausted raises the |StopIteration|_ exception in the usual manner:

.. code-block:: python
>>> xs = reiter(iter([1, 2, 3]))
>>> next(xs), next(xs), next(xs)
Expand All @@ -80,7 +92,9 @@ The built-in Python |next|_ function is also supported, and any attempt to retri
...
StopIteration
However, all items yielded during iteration can be accessed by their index, and it is also possible to iterate over those items again::
However, all items yielded during iteration can be accessed by their index, and it is also possible to iterate over those items again:

.. code-block:: python
>>> xs[0], xs[1], xs[2]
(1, 2, 3)
Expand All @@ -90,7 +104,9 @@ However, all items yielded during iteration can be accessed by their index, and
.. |reiter___getitem__| replace:: ``__getitem__``
.. _reiter___getitem__: https://reiter.readthedocs.io/en/0.8.0/_source/reiter.html#reiter.reiter.reiter.__getitem__

Retrieval of yielded items using slice notation is also supported via the |reiter___getitem__|_ method::
Retrieval of yielded items using slice notation is also supported via the |reiter___getitem__|_ method:

.. code-block:: python
>>> xs = reiter(iter([1, 2, 3]))
>>> xs[0:2]
Expand All @@ -102,7 +118,9 @@ Retrieval of yielded items using slice notation is also supported via the |reite
.. |reiter_length| replace:: ``length``
.. _reiter_length: https://reiter.readthedocs.io/en/0.8.0/_source/reiter.html#reiter.reiter.reiter.length

Instances of |reiter|_ support additional inspection methods, as well. For example, the |reiter_has|_ method returns a boolean value indicating whether a next item is available and the |reiter_length|_ method returns the length of the sequence of items emitted by the instance (once no more items can be emitted)::
Instances of |reiter|_ support additional inspection methods, as well. For example, the |reiter_has|_ method returns a boolean value indicating whether a next item is available and the |reiter_length|_ method returns the length of the sequence of items emitted by the instance (once no more items can be emitted):

.. code-block:: python
>>> xs = reiter(iter([1, 2, 3]))
>>> xs.has(), xs.has(), xs.has(), xs.has()
Expand All @@ -112,30 +130,40 @@ Instances of |reiter|_ support additional inspection methods, as well. For examp
Development
-----------
All installation and development dependencies are fully specified in ``pyproject.toml``. The ``project.optional-dependencies`` object is used to `specify optional requirements <https://peps.python.org/pep-0621>`__ for various development tasks. This makes it possible to specify additional options (such as ``docs``, ``lint``, and so on) when performing installation using `pip <https://pypi.org/project/pip>`__::
All installation and development dependencies are fully specified in ``pyproject.toml``. The ``project.optional-dependencies`` object is used to `specify optional requirements <https://peps.python.org/pep-0621>`__ for various development tasks. This makes it possible to specify additional options (such as ``docs``, ``lint``, and so on) when performing installation using `pip <https://pypi.org/project/pip>`__:

.. code-block:: bash
python -m pip install .[docs,lint]
Documentation
^^^^^^^^^^^^^
The documentation can be generated automatically from the source files using `Sphinx <https://www.sphinx-doc.org>`__::
The documentation can be generated automatically from the source files using `Sphinx <https://www.sphinx-doc.org>`__:

.. code-block:: bash
python -m pip install .[docs]
cd docs
sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make html
Testing and Conventions
^^^^^^^^^^^^^^^^^^^^^^^
All unit tests are executed and their coverage is measured when using `pytest <https://docs.pytest.org>`__ (see the ``pyproject.toml`` file for configuration details)::
All unit tests are executed and their coverage is measured when using `pytest <https://docs.pytest.org>`__ (see the ``pyproject.toml`` file for configuration details):

.. code-block:: bash
python -m pip install .[test]
python -m pytest
Alternatively, all unit tests are included in the module itself and can be executed using `doctest <https://docs.python.org/3/library/doctest.html>`__::
Alternatively, all unit tests are included in the module itself and can be executed using `doctest <https://docs.python.org/3/library/doctest.html>`__:

.. code-block:: bash
python src/reiter/reiter.py -v
Style conventions are enforced using `Pylint <https://pylint.readthedocs.io>`__::
Style conventions are enforced using `Pylint <https://pylint.readthedocs.io>`__:

.. code-block:: bash
python -m pip install .[lint]
python -m pylint src/reiter
Expand All @@ -150,20 +178,28 @@ The version number format for this library and the changes to the library associ

Publishing
^^^^^^^^^^
This library can be published as a `package on PyPI <https://pypi.org/project/reiter>`__ by a package maintainer. First, install the dependencies required for packaging and publishing::
This library can be published as a `package on PyPI <https://pypi.org/project/reiter>`__ by a package maintainer. First, install the dependencies required for packaging and publishing:

.. code-block:: bash
python -m pip install .[publish]
Ensure that the correct version number appears in ``pyproject.toml``, and that any links in this README document to the Read the Docs documentation of this package (or its dependencies) have appropriate version numbers. Also ensure that the Read the Docs project for this library has an `automation rule <https://docs.readthedocs.io/en/stable/automation-rules.html>`__ that activates and sets as the default all tagged versions. Create and push a tag for this version (replacing ``?.?.?`` with the version number)::
Ensure that the correct version number appears in ``pyproject.toml``, and that any links in this README document to the Read the Docs documentation of this package (or its dependencies) have appropriate version numbers. Also ensure that the Read the Docs project for this library has an `automation rule <https://docs.readthedocs.io/en/stable/automation-rules.html>`__ that activates and sets as the default all tagged versions. Create and push a tag for this version (replacing ``?.?.?`` with the version number):

.. code-block:: bash
git tag ?.?.?
git push origin ?.?.?
Remove any old build/distribution files. Then, package the source into a distribution archive::
Remove any old build/distribution files. Then, package the source into a distribution archive:

.. code-block:: bash
rm -rf build dist src/*.egg-info
python -m build --sdist --wheel .
Finally, upload the package distribution archive to `PyPI <https://pypi.org>`__::
Finally, upload the package distribution archive to `PyPI <https://pypi.org>`__:

.. code-block:: bash
python -m twine upload dist/*

0 comments on commit 172eb72

Please sign in to comment.