Seating Chart

What do you mean we're not sitting together?

SeatingChart helps solve the complicated problem of grouping people together (and keeping them separated 🙃).

So many uses! Classrooms, wedding receptions, family reunions, field trips, ferris wheel rides, ski lifts! The list goes on...

---

Contents:
Installation and Usage | Contributing

---

Installation and Usage

Installation

pip install seatingchart

Usage

>>> from seatingchart import SeatingChart

>>> roster = ["Amy", "Bob", "Cara", "Dan", "Emma", "Felix", "Gail", "Hank"]
>>> together = [["Amy", "Bob"], ["Gail", "Hank"]]
>>> apart = [["Amy", "Dan"]]

>>> sc = SeatingChart(roster=roster, together=together, apart=apart, max_size=3)
>>> sc.chart
[["Amy", "Bob", "Cara"], ["Gail", "Hank", "Dan"], ["Emma", "Felix"]]

>>> sc.new()
[["Amy", "Bob", "Felix"], ["Gail", "Hank", "Dan"], ["Emma", "Cara"]]

>>> print(sc.pretty())
"""
Seating Chart:
    Group 1: Amy, Bob, and Felix
    Group 2: Gail, Hank, and Dan
    Group 3: Emma and Cara
"""

Contributing

Requirements

This package uses Poetry for dependency management. You must have this tool installed to contribute.

Getting Started

After cloning the repository, run poetry install to set up your machine. This command creates a virtual environment and install both product and development dependencies.

After you make your change, run make and make sure the tests pass. In addition to running tests, this command formats files using black and lints the repository using flake8.

Finally, push your changes and submit a pull request!

General Development Practices

Use poetry run <command> to invoke commands using the managed virtual environment, or use poetry shell to open a shell directly in the virtual environment. See this repository's Makefile for examples. For further information, please reference the Poetry documentation.