Metadata-Version: 2.4
Name: skinnycal
Version: 0.1.5
Summary: A Plotly Dash wrapper for FullCalendar with premium (Scheduler) plugins bundled
Author-email: Pepijn Wissing <pepijn.wissing@cqm.nl>
License: MIT License
        
        Copyright (c) 2025 Scott Kilgore
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/PepijnWissing/skinnyCal
Project-URL: Repository, https://github.com/PepijnWissing/skinnyCal
Project-URL: Issues, https://github.com/PepijnWissing/skinnyCal/issues
Keywords: dash,plotly,fullcalendar,scheduler,calendar
Classifier: Framework :: Dash
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: dash>=2.0.0
Dynamic: license-file

# Dash FullCalendar

A lightweight Dash component library that wraps **[@fullcalendar/react](https://fullcalendar.io/docs/react)** and exposes *all* free FullCalendar features to Plotly Dash.

---

## Installation

```bash
pip install dash-fullcalendar
```

---

## Quick start

```python
from dash import Dash, html
import dash_fullcalendar as dcal

app = Dash(__name__)

app.layout = html.Div([
    dcal.FullCalendar(
        id="cal",
        initialView="dayGridMonth",
        editable=True,
        selectable=True,
        events=[
            {"title": "Audit", "date": "2025-08-01"},
            {"title": "Go‑Live", "date": "2025-08-10"},
        ],
    )
])

if __name__ == "__main__":
    app.run_server(debug=True)
```

Open <http://127.0.0.1:8050> in your browser and enjoy a fully interactive calendar.

---

## Repository layout

| Path | Purpose |
|------|---------|
| `dash_fullcalendar/` | Python package published to PyPI. Contains generated Dash component classes and **pre‑compiled** JS/CSS assets (`_js_dist`, `_css_dist`). |
| `src/` | Raw React source for the wrapper. |
| `package.json`, `rollup.config.js` | JS build pipeline (`npm run build:all`). |
| `usage.py` | Minimal Dash demo used by tests. |
| `tests/` | Integration tests with `dash[testing]` & `pytest`. |
| `docs/` | Optional screenshots / GIFs shown in this README. |
| `.github/` | CI workflows that run tests and publish to PyPI + npm. |

Ignored via `.gitignore`:

* `node_modules/`
* `dist/`, `build/`, `coverage/`

---

## Development

1. **Clone** and install dependencies

   ```bash
   git clone https://github.com/YOUR_GH_USERNAME/dash-fullcalendar.git
   cd dash-fullcalendar
   npm install
   python -m venv venv && . venv/bin/activate   # Windows: venv\Scripts\activate
   pip install -r requirements.txt -r tests/requirements.txt
   ```

2. **Build** and run the example

   ```bash
   npm run build:all     # creates dash_fullcalendar/_dash_fullcalendar*.js
   pip install -e .
   python usage.py       # open http://localhost:8050
   ```

3. **Watch & develop**

   In one shell:

   ```bash
   npm start            # rebuild JS on change
   ```

   In another:

   ```bash
   python usage.py      # auto‑reload Dash
   ```

4. **Run tests**

   ```bash
   pytest -q
   ```

---


## Contributing

Pull requests welcome!  To get a change accepted:

1. **Open an issue** first for large changes.
2. Fork, create a descriptive branch name.
3. Follow [Conventional Commits](https://www.conventionalcommits.org/) in your commit messages.
4. `npm test` and `pytest` must pass locally—CI will enforce this.
5. Submit your PR; a maintainer will review and merge.

---

## License

MIT © 2025 Scott Kilgore
