Split Schedule
This package takes a class list and reduces the number of students in each class by a specified amount. This is done by splitting the classes across days. Each individual student's day is kept the same for each of his/her classes.
The class list should be supplied as an Excel(xlsx) file with all students on a single sheet, a csv file, or a Pandas DataFrame containing the columns:
- block = The class period as a number (i.e. 1, 2, 3, etc.)
- class = The name of the class
- student = The name of the student
The generated schedule will contain the fillowing columns:
- block = The class period as a number (i.e. 1, 2, 3, etc.)
- class = The name of the class
- total_students = The total number of students for a block across all days
- max_students = The maximum number of students allowed in a block each day
- num_classes = The total number of days needed in order to allow for the maximum class size
- day_number = The day for the class. This can be used as desired. For example 1 = Monday, 2 = Tuesday, etc.
- student = The name of the student
Installation
Note: Python 3.8 or greater is required
Using a virtual environmnet is recommended for installing this package. Once the virtual environment is created and activated install the package with:
pip install split-schedule
Usage
ScheduleBuilder Methods
- build_schedule_from_df: Builds the schedule from a Pandas DataFrame
- df: The DataFrame that contains the schedule to split
- reduce_by (optinal): The amount by which the class size should be reduced. Default = 0.2
- smallest_allowed (optinal): The smallest a class should be. This can be used to override the reduce_by amount in cases where the class would be smaller than the desired amount. For example if classes are being reduced 50% (0.5) if the smallest allowd class is 10 and a class has 10 students at the start, then all 10 of these students would be kept in one class rather than reducing the size below 10. Default = 1
- max_tries (optinal): The maximum number of times the program will restart itself tying to find a viable schedule. If the maximum number of tries is exceded with no viable schedule found a SchedulingError error will occur meaning no possible way was found to split the schedule with parameters supplied. Default = 10
- verbose (optinal): Setting verbose to True will result in log output being written to the terminal as the schedule is being build. Default = False
- build_schedule_from_file: Builds the schedule from either an Excel(xlsx) file or a csv file.
- schedule_file_path: The path to the schedule file, including the name of the file. The file path can be either a string or a Path object. Excel files in xlsx format or csv files are accepted.
- reduce_by (optinal): The amount by which the class size should be reduced. Default = 0.2
- smallest_allowed (optinal): The smallest a class should be. This can be used to override the reduce_by amount in cases where the class would be smaller than the desired amount. For example if classes are being reduced 50% (0.5) if the smallest allowd class is 10 and a class has 10 students at the start, then all 10 of these students would be kept in one class rather than reducing the size below 10. Default = 1
- max_tries (optinal): The maximum number of times the program will restart itself tying to find a viable schedule. If the maximum number of tries is exceded with no viable schedule found a SchedulingError error will occur meaning no possible way was found to split the schedule with parameters supplied. Default = 10
- verbose (optinal): Setting verbose to True will result in log output being written to the terminal as the schedule is being build. Default = False
- save_schedule: Saves the generated schedule to a file.
- save_path: The path to which the generated schedule file should be saved, including the desired name of the file. The file path can be either a string or a Path object. Excel files in xlsx format or csv files are accepted.
ScheduleBuilder Properties
- final_schedule_df: This is a Pandas DataFrame that contains the generated schedule. Before the schedule is created the property will be
None
Examples
Note: Examples uses Mac/Linux type file paths. For Windows use paths like c:\path\to\original_file.xlsx and c:\path\to\generated_schedule.xlsx.
Create a schedule from an Excel file, then save the generated schedule to another Excel file.
from split_schedule import ScheduleBuilder
schedule_builder = ScheduleBuilder()
schedule_builder.build_schedule_from_file("/path/to/file.xlsx")
schedule_builder.save_schedule("/path/to/generated_schedule.xlsx")
Create a schedule from an Excel file, then print the resulting schedule DataFrame.
from split_schedule import ScheduleBuilder
schedule_builder = ScheduleBuilder()
schedule_builder.build_schedule_from_file("/path/to/file.xlsx")
print(schedule_builder.final_schedule_df)
Metadata
Release files for split-schedule 0.3.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| split-schedule-0.3.5.tar.gz | 9.8 kB | Without provenance | Details for split-schedule-0.3.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| split_schedule-0.3.5-py3-none-any.whl | Python 3 | none | any | Details for split_schedule-0.3.5-py3-none-any.whl |
Total release size: 18.3 kB
Release files / split-schedule-0.3.5.tar.gz
| Download URL | split-schedule-0.3.5.tar.gz |
|---|---|
| Size | 9.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9579028e2c292206c72f64aaad5d976f0bf489dc75d67489d6b34de5ac92b08f
|
|
BLAKE2b-256 checksum How to use checksums |
047cfd49b31dcc8b389128f86bd94f364f97ba6aa7033938a7b3710e0e3bace3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.14 CPython/3.9.13 Linux/5.15.0-1014-azure
|
Release files / split_schedule-0.3.5-py3-none-any.whl
| Download URL | split_schedule-0.3.5-py3-none-any.whl |
|---|---|
| Size | 8.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8c08389729eeb87111d7cf39d2006dd853310469a841b5b1a3d794294c96738b
|
|
BLAKE2b-256 checksum How to use checksums |
fcc668453136360782cf7ca97c35cbe38acf35f65668c331f72bc1ddf45384f3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.14 CPython/3.9.13 Linux/5.15.0-1014-azure
|
Security for split-schedule 0.3.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.