Example package for a scheduler plugin

This is the tracking issue for a example package for a scheduler plugin.

changed milestone to %PyBatsim 4

mentioned in issue #13

I am not easily able to use the example package with nix.

In a clone of this repository, inside a new folder containing a copy of pyproject.toml and my own scheduler, and the correct modification of the toml file to register my scheduler. What I've tried so far:

• nix-shell ../default.nix -A pybatsim-core and then nix-shell -p python3Packages.poetry worked, i.e., I managed to run poetry install and poetry run pybatsim myscheduler.
• Writing a custom file to simply add python3Packages.poetry in the propagatedBuildInputs of nur-kapack.pybatsim-core did not work (poetry was not found inside the nix-shell when running poetry install)

Note also that when I entered the nix-shell via the provided default.nix I got some error:

ERROR: File "setup.py" not found. Directory cannot be installed in editable mode: /home/mommess/Documents/BatSimGrid/pybatsim/my_test
(A "pyproject.toml" file was found, but editable mode currently requires a setup.py based build.)
WARNING: You are using pip version 21.0.1; however, version 21.3.1 is available.
You should consider upgrading via the '/nix/store/4s0h5aawbap3xhldxhcijvl26751qrjr-python3-3.8.9/bin/python3.8 -m pip install --upgrade pip' command.

mentioned in merge request !16 (merged)

I packaged pybatsim-example locally (in pybatsim's git repository) in commit 24f4f53f.

I also added an example-shell that enables the use of the example external scheduler. This enables to run the example scheduler with a command like the following: nix-shell -A example-shell --command 'pybatsim rejector'.

The following minimal configuration files may be used to illustrate how to package a scheduler with setuptools:

pyproject.toml

[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"

setup.cfg

[metadata]
name = pybatsim-example
version = 0.0.0
description = Example scheduler plugin for PyBatsim

[options]
zip_safe = False
py_modules = universal_rejection
python_requires = >=3.7.1,<4.0.0
install_requires =
    pybatsim >=4.0.0a0,<5.0.0

[options.entry_points]
pybatsim.schedulers =
    rejector=universal_rejection:UniversalRejectionScheduler

structure

These two files replace the pyproject.toml and poetry.lock files used when packaging with poetry. In that case, the structure of the project is the following:

.
├── pyproject.toml
├── setup.cfg
└── universal_rejection.py

mentioned in merge request !19

mentioned in merge request !21 (merged)

Done in !21 (merged)

closed