Metadata-Version: 1.2
Name: conference-scheduler-cli
Version: 0.8.3
Summary: A command line tool to manage the schedule for a conference
Home-page: https://github.com/pyconuk/conferencescheduler-cli
Author: The UK Python Association
Author-email: owen.campbell@uk.python.org
License: MIT license
Description: Conference Scehduler Command Line Interface
        ===========================================
        A command line tool to manage the schedule for a conference.
        
        Installation
        ============
        
        The library requires Python 3.6 or later. The simplest way to install is::
        
            pip install conference-scheduler-cli
        
        To install from source code::
        
            git clone https://github.com/PyConUK/ConferenceScheduler-cli
            cd ConferenceScheduler-cli
            python setup.py install
        
        Quick Start
        ===========
        
        The tool expects to find a directory with the necessary data files to define
        the conference. By default it will look for a directory named `input` under
        the current working directory.
        
        It will generate YAML files in the format required by the conference
        website. By default, these will be placed a in a `build` directory under the
        current working directory.
        
        It will also generate `.csv` and `.pickle` files to store the calculated
        schedule and its associated definition and a log file with the full details of
        the most recent calculation. By default, these will be placed in a
        `solution` directory under the current working directory.
        
        The `input`, `solution` and `build` directories can be passed to the tool as
        command line options in place of the default locations.
        
        To build the schedule with the default options::
        
            scheduler build
        
        There are also further options, e.g. to set the logging verbosity or the
        solver algorithm to use. To view those options::
        
            scheduler --help
        
        or, for the options for a specifc command::
        
            scheduler build --help
        
        Changelog
        #########
        
        v0.8.3 (2017-09-02)
        -------------------
        * Bug Fix: Original schedule and new schedule were being passed to the diff
          function in the wrong order
        
        v0.8.2 (2017-09-01)
        -------------------
        * Bug Fix: Pre-allocated events were being scheduled in addition to their
          pre-allocated slot when optimising for consistency
        
        v0.8.1 (2017-08-24)
        -------------------
        * Minor: Order of fields altered in schedule.csv
        
        v0.8.0 (2017-08-21)
        -------------------
        * New Feature: --diff option to control logging of schedule diff
        
        
        v0.7.2 (2017-08-21)
        -------------------
        * Bug Fix: Consistency optimisation fixed
        
        v0.7.1 (2017-08-21)
        -------------------
        * Minor: Updated log message for Unavailability
        
        v0.7.0 (2017-08-21)
        -------------------
        * Bug Fix: Remove use of strings for Slot.starts_at
        
        * New Feature: Unavailability and clashes can now be defined for events as well
          as people
        
        * New feature: Capacity objective now split into efficiency or equity
        
        v0.6.0 (2017-08-18)
        -------------------
        * New Feature: Pre-allocated events can be defined in allocations.yaml
        
        * Breaking Change: venues.yml renamed to timetable.yml
        
        v0.5.0 (2017-08-17)
        -------------------
        * Breaking Change: content previously in separate yaml files now in venues.yaml
        
        * New Feature: objective function argument added to build command
        
        v0.4.1 (2017-08-16)
        -------------------
        * Improved logging with counts of events and slots by event type
        
        v0.4.0 (2017-08-14)
        -------------------
        * New Feature: Venue availability can be defined
        
        * Minor Improvement: Order of columns in schedule.csv swapped to show index
          numbers at lhs of file
        
        v0.3.1 (2017-08-10)
        -------------------
        * Bug Fix: Redundant export of schedule on rebuild removed
        
        v0.3.0 (2017-08-10)
        -------------------
        * New feature: Rebuild command
          Rebuild the output files from a previously computed schedule
        
        v0.2.0 (2017-08-10)
        -------------------
        * New Featue: Validate command
          Validate a previously computed schedule
        
        v0.1.0 (2017-08-10)
        -------------------
        * Initial release
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Utilities
Requires-Python: >=3.6
