README.rst

XOInvader

Attempt to create small but serious game using python and ncurses.

Requirements

General

• python >=3.10; <3.13
• >= eaf-0.2
• >= xo1-0.1
• >= toml-0.10
• ncurses >=5.9

Installation

From PyPI

$ pip install --user xoinvader

Development

$ uv sync --extra dev
$ uv run xoigame

Testing

$ make test  # for all tests
$ make view_cov  # run all tests and view coverage
$ # pass additional arguments to pytest via PYTEST_ARGS env variable
$ # you can pass args such way to test and view_cov make targets
$ make test PYTEST_ARGS='-m "not slow"'  # don't run slow tests
$ pytest --markers  # show all markers
$ pytest xoinvader/path/to/test_file.py  # run separate file

Documentation

• Autogenerated from sources here.

• Development wiki.

• Build documentation from sources:

  $ make docs
  $ make view_docs  # build and open in firefox