Metadata-Version: 2.1
Name: drawcal
Version: 0.6.1
Summary: Python library for drawing simple monthly calendar images with events.
Author-email: Ryan Galloway <ryan@rsgalloway.com>
License: drawcal
        
        Copyright (c) 2022-2026, Bnbnotify
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
        
            * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
            * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
            * Neither the name of Bnbnotify nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, https://github.com/bnbnotify/drawcal
Project-URL: Repository, https://github.com/bnbnotify/drawcal
Keywords: calendar,image,pillow,png
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Pillow>=10.0.0
Requires-Dist: envstack>=0.8.3
Provides-Extra: dev
Requires-Dist: black>=24.0.0; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: pytest>=8.0.0; extra == "dev"
Requires-Dist: twine; extra == "dev"

drawcal
=======

Python library for drawing simple monthly calendar images with events.

<img src="drawcal.png" alt="drwacal clendar image" />

## Installation

Install from PyPI:

```bash
$ pip install -U drawcal
```

## Quickstart

Generate a calendar image for a given events file:

```bash
$ drawcal --events events.json --month 3 --year 2025
```

Python:

```python
>>> from drawcal import draw_calendar
>>> draw_calendar(month, year, events=events, outfile=outfile)
```

## Events format

`drawcal` uses a structured event object format:

```json
[
  {
    "start_date": "3/1/2025",
    "end_date": "3/3/2025",
    "color": "#ee2233",
    "style": "rounded",
    "markers": ["3/3/2025"]
  },
  {
    "start_date": "3/14/2025",
    "end_date": "3/15/2025",
    "style": "filled",
    "markers": ["3/14/2025", "3/15/2025"]
  }
]
```

Supported `style` values are `filled`, `rounded`, and `diagonal`. Use
`markers` to draw green marker indicators on specific dates within the event
range, or use marker-only events when you only want calendar annotations.

Legacy list-based events are still supported for backward compatibility and are
documented in [docs/events.md](docs/events.md).

## Documentation

Additional docs:

- [docs/README.md](docs/README.md)
- [docs/events.md](docs/events.md)
- [docs/rendering.md](docs/rendering.md)
- [docs/customization.md](docs/customization.md)
- [docs/python-api.md](docs/python-api.md)
