Neko for FlaschenTaschen

Neko for FlaschenTaschen, based on xneko.

Usage

$ pipx install ft-neko
[...]

$ ft-neko --help
Usage: ft-neko [OPTIONS]

  Neko for FlaschenTaschen

  The --color option supports an RGB hex value (i.e. ff00ff) or the filename
  of a 32x32 8-bit PPM image.

Options:
  --host TEXT             Hostname of the FT server. (Default: localhost)
  --port INTEGER          Port number of the FT server. (Default: 1337)
  --width INTEGER         Width of the FT display. (Default: 45)
  --height INTEGER        Height of the FT display. (Default: 35)
  --layer INTEGER RANGE   Layer of the FT display. (Default: 0)  [x>=0]
  --color TEXT            Neko color from RGB hex value or PPM file.
  --pride                 Neko in pride flag colors.
  --trans                 Neko in trans flag colors.
  --speed INTEGER RANGE   Neko speed. (Default: 4)  [x>=1]
  --sleepy FLOAT RANGE    Neko sleepiness. (Default: 0.5)  [0.0<=x<=1.0]
  --interval FLOAT RANGE  Seconds between Neko updates. (Default: 0.125)
                          [x>=0.1]
  --help                  Show this message and exit.

Development

# Install requirements
pipenv sync -d
# Activate environment
pipenv shell

# Run checks
make checks
# Run Neko with default options
make neko
# Run Neko with custom options
python -m neko.neko --help

# Create release
rm -r dist
python -m build
twine upload dist/*

Trans Rights are Human Rights! 🏳️‍⚧️ 🏳️‍🌈