GitLab

Document contemporary release process using GitLab CI pipeline where the
pipeline uploads to PyPI after successful build of a tag.

Also many minor corrections and url updates.

Include the top-level CHANGES.rst in history.rst instead of duplicating the
changelog entries in both places.

The section headings in the remainder of history.rst are fixed-up so that
the pre-3.0 historical change information fits with the included
CHANGES.rst.

Also reflow the long lines and generally touch-up the formatting of
history.rst.

The documentation for Environment's BoundClass methods (process(),
timeout(), event(), etc.) is moved from simpy.core.rst to core.py. The
docstrings are now associated with the TYPE_CHECKING-only stubs and Sphinx
now documents using those stubs.

Other classes with BoundClass methods are now also documented using the
type checking stubs. The generated API docs thus now show a proper method
signature instead of treating the BoundClass methods as data attributes of
the class.

This porting guide covers the minor breaking changes between SimPy 3 and 4.

The Environment class is a sufficient base for user-defined Environment
subclasses. Removing BaseEnvironment reduces the amount of user-facing
documentation along with being one less thing in the code to maintain.

N.B. RealtimeEnvironment already inherited from Environment, not
BaseEnvironment.

Python 3.6+ supports f-strings. These are generally faster and more
ergonomic than the alternatives of either old-style interpolation,
str.format(), or concatenation with `+`.

This method was needed for Python2 code where it was otherwise illegal to
`return` from a generator. Since Python3 supports `return` in generators,
the `exit()` method is unneeded. And since calling `env.exit()` is less
ergonomic than simply using `return`, there is no reason to keep it.

As an illustration, this generator written in Python2 style:

    def proc(env):
        yield env.timeout(1)
        env.exit(42)

can be expressed in Python3 as:

    def proc(env):
        yield env.timeout(1)
        return 42

Python2 compatibility code is removed.

- Do not explicitly inherit from `object`.
- Use `super().__init__(...)` instead of `super(Self, self).__init__`.
- Entirely remove compat.py.
- Remove Python2 versions of example simulation output (.out2 files).
- Use Python3 imports exclusively.

Documentation and build are also updated to reflect these changes.

Addresses #92.

The license.rst file was referring to LICENSE.txt which was renamed to
LICENSE.rst.

Also use `include` directive instead of `literalinclude` since the license
is now in a restructured text file.

As of pytest 5.4, instantiating various Node subclasses is supposed to be
done using the `from_parent()` classmethod instead of using the regular
constructor (i.e. Node()).

This only affects the doc tests.

Newer versions of python flag '\o' as an invalid escape sequence. Repair
by using a raw string.

There is no longer a simpy.test() function nor are the tests installed
with either the wheel (bdist_whl) or tarball (sdist) packages, so we
remove the instructions for running tests after installation.

The version string needs to be updated in setup.py in addition to
simpy/__init__.py.

All occurrences of "Simpy" are changed to "SimPy".

Rework overview page in restructured text to fix the PDF output and add some more links to various parts of the documentation.

The new `PriorityStore` class is a subclass of `Store` that maintains
its `items` list in priority order such that `get()` yields items in
priority order.

The `PriorityItem` helper class allows unorderable items to be put into
a `PriorityStore` by associating an explicit priority value with the
item.

Update documentation in README.txt and installation.rst to recommend
running the test suite with `py.test` instead of the `python -c ...`
method. The `py.test` method is shorter and more powerful.

Plus if tests are invoked with the `py.test` method, then we no longer
need simpy.util.test(). So we also remove that function in the name of
PEP-20 (one obvious way to do it).

Also apply flake8 to entire project in tox.ini.