westerveltco/django-twc-toolbox

Various tools for Django projects at The Westervelt Company

django-twc-toolbox

Requirements

• Python 3.8, 3.9, 3.10, 3.11, 3.12
• Django 4.2, 5.0

Getting Started

1. Install the package from PyPI:

python -m pip install django-twc-toolbox

2. Add the app to your Django project's INSTALLED_APPS:

INSTALLED_APPS = [
    ...,
    "django_twc_toolbox",
    ...,
]

Usage

Documentation

Please refer to the documentation for more information.

License

django-twc-toolbox is licensed under the MIT license. See the LICENSE file for more information.

django-twc-toolbox's Issues

Add documentation

• Create initial scaffolding
• Create docs site on Read the Docs
• Document TimeStamped
• Document DatePaginator and DatePage

Add custom DRF renderers

https://github.com/westerveltco/forsythia/blob/20651336909bff091bcbaa44ef91f292f81c1cdd/forsythia/api/renderers.py

Add `min_date` and `max_date` to `DatePaginator`

Similar to #7, it'd be nice if regardless of the order of the object_list, that there was two properties for the min and max date of a paginator.

There's already a bunch of duplicated logic in the paginator methods dealing with this anyway, should be consolidated.

django-twc-toolbox/src/django_twc_toolbox/paginator.py

Lines 45 to 53 in 7fb68cb

	if isinstance(self.object_list, QuerySet): # type: ignore[misc]
	first_obj = self.object_list.first()
	last_obj = self.object_list.last()
	else:
	first_obj = self.object_list[0]
	last_obj = self.object_list[-1]
	first_date = getattr(first_obj, self.date_field)
	last_date = getattr(last_obj, self.date_field)

django-twc-toolbox/src/django_twc_toolbox/paginator.py

Lines 170 to 178 in 7fb68cb

	if isinstance(self.object_list, QuerySet): # type: ignore[misc]
	first_obj = self.object_list.first()
	last_obj = self.object_list.last()
	else:
	first_obj = self.object_list[0]
	last_obj = self.object_list[-1]
	first_date = getattr(first_obj, self.date_field)
	last_date = getattr(last_obj, self.date_field)

Bump `django-twc-package` to v2024.19

django-twc-package v2024.19

What's Changed

• add CODEOWNERS file by @joshuadavidthomas in westerveltco/django-twc-package#73
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in westerveltco/django-twc-package#74
• 🔖 bump version 2024.18 -> 2024.19 by @joshuadavidthomas in westerveltco/django-twc-package#75

Full Changelog: westerveltco/django-twc-package@v2024.18...v2024.19

Use `westerveltco/setup-ci-action`

coverage
Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: actions/setup-python@v4. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.

types
Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: actions/setup-python@v4. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.

Add `py.typed` file to package

Adjust `DatePage.min_date` and `DatePage.max_date`

This snuck in with all the furious coding to get it shipped. In addition to the start_date and end_date of the DatePage, which correspond to the first and last object's date, respectively, I wanted to also include the oldest and newest date regardless of the sorting.

Add `messages` app

In one of our private projects, we have a messages app that handles common messages that need to be sent externally, e.g. email, webhooks, or Teams. That should be ported over to this public package so that our other projects can use it.

Add `tablize` utility function

https://github.com/westerveltco/forsythia/blob/20651336909bff091bcbaa44ef91f292f81c1cdd/forsythia/core/tables.py