schedule-planner (empty) → 0.1.0.0

raw patch · 5 files changed

+316/−0 lines, 5 filesdep +basedep +containersdep +happstack-litesetup-changed

Dependencies added: base, containers, happstack-lite, json, mtl, options, transformers

Files

• LICENSE +165/−0
• README.md +26/−0
• Setup.hs +2/−0
• schedule-planner.cabal +37/−0
• src/Main.hs +86/−0

@@ -0,0 +1,165 @@+                  GNU LESSER GENERAL PUBLIC LICENSE+                       Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.+++  This version of the GNU Lesser General Public License incorporates+the terms and conditions of version 3 of the GNU General Public+License, supplemented by the additional permissions listed below.++  0. Additional Definitions.++  As used herein, "this License" refers to version 3 of the GNU Lesser+General Public License, and the "GNU GPL" refers to version 3 of the GNU+General Public License.++  "The Library" refers to a covered work governed by this License,+other than an Application or a Combined Work as defined below.++  An "Application" is any work that makes use of an interface provided+by the Library, but which is not otherwise based on the Library.+Defining a subclass of a class defined by the Library is deemed a mode+of using an interface provided by the Library.++  A "Combined Work" is a work produced by combining or linking an+Application with the Library.  The particular version of the Library+with which the Combined Work was made is also called the "Linked+Version".++  The "Minimal Corresponding Source" for a Combined Work means the+Corresponding Source for the Combined Work, excluding any source code+for portions of the Combined Work that, considered in isolation, are+based on the Application, and not on the Linked Version.++  The "Corresponding Application Code" for a Combined Work means the+object code and/or source code for the Application, including any data+and utility programs needed for reproducing the Combined Work from the+Application, but excluding the System Libraries of the Combined Work.++  1. Exception to Section 3 of the GNU GPL.++  You may convey a covered work under sections 3 and 4 of this License+without being bound by section 3 of the GNU GPL.++  2. Conveying Modified Versions.++  If you modify a copy of the Library, and, in your modifications, a+facility refers to a function or data to be supplied by an Application+that uses the facility (other than as an argument passed when the+facility is invoked), then you may convey a copy of the modified+version:++   a) under this License, provided that you make a good faith effort to+   ensure that, in the event an Application does not supply the+   function or data, the facility still operates, and performs+   whatever part of its purpose remains meaningful, or++   b) under the GNU GPL, with none of the additional permissions of+   this License applicable to that copy.++  3. Object Code Incorporating Material from Library Header Files.++  The object code form of an Application may incorporate material from+a header file that is part of the Library.  You may convey such object+code under terms of your choice, provided that, if the incorporated+material is not limited to numerical parameters, data structure+layouts and accessors, or small macros, inline functions and templates+(ten or fewer lines in length), you do both of the following:++   a) Give prominent notice with each copy of the object code that the+   Library is used in it and that the Library and its use are+   covered by this License.++   b) Accompany the object code with a copy of the GNU GPL and this license+   document.++  4. Combined Works.++  You may convey a Combined Work under terms of your choice that,+taken together, effectively do not restrict modification of the+portions of the Library contained in the Combined Work and reverse+engineering for debugging such modifications, if you also do each of+the following:++   a) Give prominent notice with each copy of the Combined Work that+   the Library is used in it and that the Library and its use are+   covered by this License.++   b) Accompany the Combined Work with a copy of the GNU GPL and this license+   document.++   c) For a Combined Work that displays copyright notices during+   execution, include the copyright notice for the Library among+   these notices, as well as a reference directing the user to the+   copies of the GNU GPL and this license document.++   d) Do one of the following:++       0) Convey the Minimal Corresponding Source under the terms of this+       License, and the Corresponding Application Code in a form+       suitable for, and under terms that permit, the user to+       recombine or relink the Application with a modified version of+       the Linked Version to produce a modified Combined Work, in the+       manner specified by section 6 of the GNU GPL for conveying+       Corresponding Source.++       1) Use a suitable shared library mechanism for linking with the+       Library.  A suitable mechanism is one that (a) uses at run time+       a copy of the Library already present on the user's computer+       system, and (b) will operate properly with a modified version+       of the Library that is interface-compatible with the Linked+       Version.++   e) Provide Installation Information, but only if you would otherwise+   be required to provide such information under section 6 of the+   GNU GPL, and only to the extent that such information is+   necessary to install and execute a modified version of the+   Combined Work produced by recombining or relinking the+   Application with a modified version of the Linked Version. (If+   you use option 4d0, the Installation Information must accompany+   the Minimal Corresponding Source and Corresponding Application+   Code. If you use option 4d1, you must provide the Installation+   Information in the manner specified by section 6 of the GNU GPL+   for conveying Corresponding Source.)++  5. Combined Libraries.++  You may place library facilities that are a work based on the+Library side by side in a single library together with other library+facilities that are not Applications and are not covered by this+License, and convey such a combined library under terms of your+choice, if you do both of the following:++   a) Accompany the combined library with a copy of the same work based+   on the Library, uncombined with any other library facilities,+   conveyed under the terms of this License.++   b) Give prominent notice with the combined library that part of it+   is a work based on the Library, and explaining where to find the+   accompanying uncombined form of the same work.++  6. Revised Versions of the GNU Lesser General Public License.++  The Free Software Foundation may publish revised and/or new versions+of the GNU Lesser General Public License from time to time. Such new+versions will be similar in spirit to the present version, but may+differ in detail to address new problems or concerns.++  Each version is given a distinguishing version number. If the+Library as you received it specifies that a certain numbered version+of the GNU Lesser General Public License "or any later version"+applies to it, you have the option of following the terms and+conditions either of that published version or of any later version+published by the Free Software Foundation. If the Library as you+received it does not specify a version number of the GNU Lesser+General Public License, you may choose any version of the GNU Lesser+General Public License ever published by the Free Software Foundation.++  If the Library as you received it specifies that a proxy can decide+whether future versions of the GNU Lesser General Public License shall+apply, that proxy's public statement of acceptance of any version is+permanent authorization for you to choose that version for the+Library.

@@ -0,0 +1,26 @@+# The schedule planner [![Build Status](https://travis-ci.org/JustusAdam/schedule-planner.svg?branch=master)](https://travis-ci.org/JustusAdam/schedule-planner) [Hackage version](https://img.shields.io/hackage/v/schedule-planner.svg)++Take an arbitrary list of weighted "lessons" and calculate the most ideal and valid layout for them based on weighing rules.++Base algorithm seems to work, will add UI soon.++## Install++- get the software+    - clone the repository `git clone https://github.com/JustusAdam/schedule-planner`  +    - or find the package on [Hackage](http://hackage.haskell.org/package/schedule-planner-0.1.0.0/candidate)+- install using cabal `cabal install`++## Usage++You may test it right now just executing the program `./dist/build/schedule-planner/schedule-planner`++By default it tries to obtain it's input data from `testsuite/test.json`, but you can specify any file as input using command line options.++Obtain information about the command line arguments using the `-h` or `--help` argument.++Since this is mostly intended to be used by myself to calculate a schedule and I attend the 'TU Dresden' there's a scraper script in `util/grab.py` that gets all the current lessons as json from the website.++## Code documentation++The Haddock documentation can be found on the [GitHub pages](http://justusadam.github.io/schedule-planner/)

@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain

@@ -0,0 +1,37 @@+name: schedule-planner+version: 0.1.0.0+cabal-version: >=1.10+build-type: Simple+license: LGPL-3+license-file: LICENSE+copyright: 2015+maintainer: Justus Adam <development@justusadam.com>+stability: experimental+synopsis: Find the ideal lesson layout+description:+    Executable program for calculating layouts for fixed grid schedules as+    are used in many universities and schools.+    The primary data format for in- and output is json, a deployable server+    instance of this software is planned.+category: Data, Convenience, Planning+author: Justus Adam <development@justusadam.com>+data-dir: ""+extra-source-files: README.md++executable schedule-planner+    build-depends:+      base >= 4.7 && <5,+      containers -any,+      json -any,+      options -any,+      transformers > 0.4,+      happstack-lite > 7,+      mtl > 1+    main-is: Main.hs+    buildable: True+    default-language: Haskell2010+    hs-source-dirs: src++source-repository head+    type: git+    location: git://github.com/JustusAdam/schedule-planner.git

@@ -0,0 +1,86 @@+{-|+Module      : $Header$+Description : Interface for schedule-planner+Copyright   : (c) Justus Adam, 2015+License     : LGPL-3+Maintainer  : development@justusadam.com+Stability   : experimental+Portability : POSIX++main function and outside communication for this software.+This module takes care of reading all input and checking for correctness+as well as providing useful feedback upon encountering errors.+-}+module Main (main, CallOptions) where++import           Control.Applicative        (pure, (<*>))+import           Control.Monad              (liftM, when)+import           Options                    (Options, defineOption,+                                             defineOptions, optionDefault,+                                             optionDescription, optionLongFlags,+                                             optionShortFlags, optionType_bool,+                                             optionType_maybe,+                                             optionType_string, runCommand)+import           SchedulePlanner.App+import           SchedulePlanner.Calculator+import           SchedulePlanner.Serialize+++-- |Temporary constant, should be in call args eventually+outputFormatDefault = "print"+++-- |Legacy hard coded name of inputfile+stdFileName   = "testsuite/test.json"+++data CallOptions = CallOptions {+    outputFile   :: Maybe String,+    inputFile    :: String,+    outputFormat :: String,+    server       :: Bool,+    verbocity    :: Bool+  } deriving (Show)++instance Options CallOptions where+  defineOptions = pure CallOptions+    <*> defineOption (optionType_maybe optionType_string) (\o -> o {+        optionLongFlags   = ["output-file"],+        optionShortFlags  = "o",+        optionDescription = "print output to this file instead of stdout",+        optionDefault     = Nothing+      })+    <*> defineOption optionType_string (\o -> o {+        optionDefault     = stdFileName,+        optionLongFlags   = ["input-file"],+        optionShortFlags  = "i",+        optionDescription = "read input from this file"+      })+    <*> defineOption optionType_string (\o -> o {+        optionDefault     = outputFormatDefault,+        optionLongFlags   = ["output-format"],+        optionShortFlags  = "f",+        optionDescription = "set the output format"+      })+    <*> defineOption optionType_bool (\o -> o {+        optionDefault     = False,+        optionLongFlags   = ["serve"],+        optionDescription = "Placeholder with no effect yet"+    })+    <*> defineOption optionType_bool (\o -> o {+        optionDefault     = False,+        optionLongFlags   = ["verbose"],+        optionShortFlags  = "v",+        optionDescription = "Print extra information"+    })+++{-|+  main function. Handles reading command line arguments, the json input+  and starts execution.+-}+main :: IO()+main = runCommand $ \opts args -> do+  rawInput <- readFile (inputFile opts)++  reportAndPrint (outputFormat opts) (verbocity opts) rawInput