Metadata-Version: 2.5
Name: KegElements
Version: 0.20261119.1
Summary: A collection of helpers and base classes for building apps with Keg.
Project-URL: Homepage, https://github.com/level12/keg-elements
Project-URL: Repository, https://github.com/level12/keg-elements
Project-URL: Documentation, https://keg-elements.readthedocs.io/en/stable/
Author-email: Randy Syring <randy.syring@level12.io>
License-Expression: BSD-3-Clause
License-File: license.txt
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Requires-Python: >=3.12
Requires-Dist: arrow
Requires-Dist: cryptography
Requires-Dist: flask-wtf
Requires-Dist: keg>=0.11.0
Requires-Dist: pytz
Requires-Dist: sentry-sdk>=2
Requires-Dist: wtforms-alchemy>=0.18.0
Requires-Dist: wtforms-components>=0.12.0
Requires-Dist: wtforms>=3.3.2
Provides-Extra: i18n
Requires-Dist: morphi; extra == 'i18n'
Requires-Dist: setuptools; extra == 'i18n'
Provides-Extra: tests
Requires-Dist: alembic; extra == 'tests'
Requires-Dist: flask-webtest; extra == 'tests'
Requires-Dist: freezegun; extra == 'tests'
Requires-Dist: nox; extra == 'tests'
Requires-Dist: prek; extra == 'tests'
Requires-Dist: psycopg[binary]>=3; extra == 'tests'
Requires-Dist: pyodbc; extra == 'tests'
Requires-Dist: pyquery; extra == 'tests'
Requires-Dist: pytest; extra == 'tests'
Requires-Dist: pytest-cov; extra == 'tests'
Requires-Dist: responses; extra == 'tests'
Requires-Dist: sqlalchemy-pyodbc-mssql; extra == 'tests'
Requires-Dist: sqlalchemy>=2.1; extra == 'tests'
Requires-Dist: webgrid>=0.20261113.1; extra == 'tests'
Requires-Dist: xlsxwriter; extra == 'tests'
Description-Content-Type: text/markdown

# KegElements

[![nox](https://github.com/level12/keg-elements/actions/workflows/nox.yaml/badge.svg)](https://github.com/level12/keg-elements/actions/workflows/nox.yaml)
[![codecov](https://codecov.io/github/level12/keg-elements/coverage.svg?branch=master)](https://codecov.io/github/level12/keg-elements?branch=master)

Keg Elements is a collection of helpers and base classes for building apps with
[Keg](https://github.com/level12/keg) or Keg extensions.

For a simple example and an application setup checklist, see the
[Getting Started guide](https://keg-elements.readthedocs.io/en/stable/getting-started.html).


## Links

- [Documentation](https://keg-elements.readthedocs.io/en/stable/index.html)
- [Releases](https://pypi.org/project/KegElements/)
- [Source and issue tracker](https://github.com/level12/keg-elements)
- [Changelog](changelog.rst)


## Dev


### Copier Template

Project structure and tooling mostly derives from
[Coppy](https://github.com/level12/coppy). See its documentation for context and
additional instructions.

This project can be updated from the upstream repo, see
[Updating a Project](https://github.com/level12/coppy?tab=readme-ov-file#template-updates).


### Project Setup

From zero to hero (passing tests that is):

1. Ensure [host dependencies](https://github.com/level12/coppy/wiki/Mise) are installed

2. Start docker service dependencies (if applicable):

   `docker compose up -d`

3. Sync [project](https://docs.astral.sh/uv/concepts/projects/) virtualenv w/ lock file:

   `uv sync`

4. Configure prek:

   `prek install`

5. Run tests:

   `nox`


### Versions

Versions are date based. A `version` task shows and bumps versions:

```shell

  # Show current version
  mise run version show

  # Bump version based on date, tag, and push:
  mise run version bump

  # See other options
  mise run version -- --help
```
