"color" field

Author: jwodder

CHANGELOG.md

@@ -3,6 +3,7 @@ v0.3.0 (in development)
 - `--font` now accepts names of builtin fonts
 - When an input filename is given but no output filename, write to the input
   filename with the extension set to `.pdf` instead of to stdout
+- Events can now have a "color" field to set the background color
 
 v0.2.0 (2019-04-16)
 -------------------

README.rst

@@ -110,6 +110,12 @@ represents a single weekly event and must contain the following keys:
    are specified in 24-hour format, the minutes being optional (and optionally
    separated from the hour by a colon or period).
 
+``color``
+   *(optional)* The background color of the event's box, given as six
+   hexadecimal digits.  The default background color is either grey or, if
+   ``--color`` is in effect, taken from a small palette of basic colors based
+   on the event's index.
+
 
 Example
 =======
@@ -119,6 +125,7 @@ The following input file::
     - name: Garfield impersonation
       days: M
       time: 7-9
+      color: "FFB04E"
 
     - name: Work to live
       days: MTWRF
@@ -129,18 +136,22 @@ The following input file::
         (The one on Main Street)
       days: M, W, F
       time: 17:00 - 18:00
+      color: "29FF65"
 
     - name: Have they brought back my favorite show yet?
       days: R
       time: 19-19.30
+      color: "FF84DF"
 
     - name: Poor decisions
       days: F
       time: 22-23.59
+      color: "000000"
 
     - name: Sleep in
       days: SatSun
       time: 7-12
+      color: "4226C4"
 
 produces (using the default options) an output file that looks like this:
 

TODO.md

@@ -2,7 +2,6 @@
 - Handle events that go past midnight
 
 - Input format:
-    - Support an optional "color" field in event input dicts
     - Change the input format to a YAML dict of which the list of event dicts
       is one field, the others being font, font size, min & max times, etc.?
     - Add support for 12-hour times

examples/example01.pdf

@@ -1,6 +1,7 @@
 - name: Garfield impersonation
   days: M
   time: 7-9
+  color: "FFB04E"
 
 - name: Work to live
   days: MTWRF
@@ -11,15 +12,19 @@
     (The one on Main Street)
   days: M, W, F
   time: 17:00 - 18:00
+  color: "29FF65"
 
 - name: Have they brought back my favorite show yet?
   days: R
   time: 19-19.30
+  color: "FF84DF"
 
 - name: Poor decisions
   days: F
   time: 22-23.59
+  color: "000000"
 
 - name: Sleep in
   days: SatSun
   time: 7-12
+  color: "4226C4"

examples/example01.png

@@ -185,6 +185,10 @@ def render(self, canvas, width, height, x, y, font_size, show_times=True,
                 canvas.rect(*ebox.rect(), stroke=1, fill=1)
                 canvas.setFillColorRGB(0,0,0)
 
+                if ev.color[1] <= 0.33333:
+                    # Background color is too dark; print text in white
+                    canvas.setFillColorRGB(1,1,1)
+
                 # Event text:
                 ### TODO: Use PLATYPUS or whatever for this part:
                 text = sum((wrap(t, line_width) for t in ev.text), [])
@@ -332,14 +336,28 @@ def read_events(infile, colors):
         m = re.match(r'^\s*(\d{1,2})(?:[:.]?(\d{2}))?\s*'
                      r'-\s*(\d{1,2})(?:[:.]?(\d{2}))?\s*$', timestr)
         if not m:
-            raise click.UsageError('Invalid time: ' + repr(timestr), err=True)
+            raise click.UsageError('Invalid time: ' + repr(timestr))
         start = time(int(m.group(1)), int(m.group(2) or 0))
         end   = time(int(m.group(3)), int(m.group(4) or 0))
+        if "color" in entry:
+            m = re.fullmatch(
+                r'\s*#?\s*([a-fA-F0-9]{2})([a-fA-F0-9]{2})([a-fA-F0-9]{2})\s*',
+                entry["color"],
+            )
+            if not m:
+                raise click.UsageError('Invalid color: ' + repr(entry["color"]))
+            color = (
+                int(m.group(1), 16) / 255,
+                int(m.group(2), 16) / 255,
+                int(m.group(3), 16) / 255,
+            )
+        else:
+            color = colors[i % len(colors)]
         yield Event(
             start_time = start,
             end_time   = end,
             text       = text,
-            color      = colors[i % len(colors)],
+            color      = color,
             days       = [d for d,rgx in DAY_REGEXES if re.search(rgx, days)],
         )
 

examples/example01.yml

@@ -43,7 +43,7 @@ project_urls =
 py_modules = pdfschedule
 python_requires = ~=3.4
 install_requires =
-    attrs     ~= 18.2
+    attrs     >= 18.2
     click     ~= 7.0
     PyYAML    == 5.*
     reportlab ~= 3.4