Add PR template (#53)

.github/pull_request_template.md

@@ -0,0 +1,32 @@
+Applicable spec: <link>
+
+### Overview
+
+<!-- A high level overview of the change -->
+
+### Rationale
+
+<!-- The reason the change is needed -->
+
+### Juju Events Changes
+
+<!-- Any changes to the juju events being observed (newly added, significantly modified or deleted) -->
+
+### Module Changes
+
+<!-- Any high level changes to modules and why (Service, Observer, helper) -->
+
+### Library Changes
+
+<!-- Any changes to charm libraries -->
+
+### Checklist
+
+- [ ] The [charm style guide](https://juju.is/docs/sdk/styleguide) was applied
+- [ ] The [contributing guide](https://github.com/canonical/is-charms-contributing-guide) was applied
+- [ ] The changes are compliant with [ISD054 - Managing Charm Complexity](https://discourse.charmhub.io/t/specification-isd014-managing-charm-complexity/11619)
+- [ ] The documentation is generated using `src-docs`
+- [ ] The documentation for charmhub is updated
+- [ ] The PR is tagged with appropriate label (`urgent`, `trivial`, `complex`)
+
+<!-- Explanation for any unchecked items above -->

generate-src-docs.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.
+
+lazydocs --no-watermark --output-path src-docs src/*

requirements.txt

@@ -1,3 +1,4 @@
+cosl
 jsonschema >=4.19,<4.20
 ops >= 2.2
 pydantic >= 1.10,<2

src-docs/charm.py.md

@@ -0,0 +1,93 @@
+<!-- markdownlint-disable -->
+
+<a href="../src/charm.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+# <kbd>module</kbd> `charm.py`
+Flask Charm service. 
+
+**Global Variables**
+---------------
+- **FLASK_CONTAINER_NAME**
+
+
+---
+
+## <kbd>class</kbd> `FlaskCharm`
+Flask Charm service. 
+
+<a href="../src/charm.py#L29"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+### <kbd>function</kbd> `__init__`
+
+```python
+__init__(*args: Any) → None
+```
+
+Initialize the instance. 
+
+
+
+**Args:**
+
+ - <b>`args`</b>:  passthrough to CharmBase. 
+
+
+---
+
+#### <kbd>property</kbd> app
+
+Application that this unit is part of. 
+
+---
+
+#### <kbd>property</kbd> charm_dir
+
+Root directory of the charm as it is running. 
+
+---
+
+#### <kbd>property</kbd> config
+
+A mapping containing the charm's config and current values. 
+
+---
+
+#### <kbd>property</kbd> meta
+
+Metadata of this charm. 
+
+---
+
+#### <kbd>property</kbd> model
+
+Shortcut for more simple access the model. 
+
+---
+
+#### <kbd>property</kbd> unit
+
+Unit that this execution is responsible for. 
+
+
+
+---
+
+<a href="../src/charm.py#L80"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+### <kbd>function</kbd> `container`
+
+```python
+container() → Container
+```
+
+Get the flask application workload container controller. 
+
+Return:  The controller of the flask application workload container. 
+
+
+
+**Raises:**
+
+ - <b>`PebbleNotReadyError`</b>:  if the pebble service inside the container is not ready while the  ``require_connected`` is set to True. 
+
+