Metadata-Version: 2.1
Name: django-cloudtask
Version: 0.1.1
Summary: A django package for managing long running tasks using GCP Cloud Task
Home-page: http://github.com/kogan/
License: BSD-3-Clause
Keywords: django-cloudtask,django,gcp,cloud task
Author: Alec McGavin
Author-email: alec.mcgavin@kogan.com.au
Requires-Python: >=3.6,<4.0
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Framework :: Django :: 2.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: django (>=2.2.12,<3.0.0)
Requires-Dist: django-structlog (>=1.5.2,<2.0.0)
Requires-Dist: google-api-core (>=1.14.2,<2.0.0)
Requires-Dist: google-cloud-scheduler (>=1.3.0,<2.0.0)
Requires-Dist: google-cloud-tasks (>=1.5.0,<2.0.0)
Requires-Dist: structlog (>=20.1.0,<21.0.0)
Project-URL: Documentation, http://github.com/kogan/django-cloudtask/
Project-URL: Repository, http://github.com/kogan/django-cloudtask/
Description-Content-Type: text/markdown

# django-cloudtask
A django package for managing long running tasks via Cloud Run and Cloud Scheduler

[![CircleCI](https://circleci.com/gh/kogan/django-cloudtask.svg?style=svg)](https://circleci.com/gh/kogan/django-cloudtask)

## Should I be using this package?

Probably not.

## Configuration

Make sure these are in your django settings:

 - `PROJECT_ID`
   - the GCP project
 - `PROJECT_REGION`
   - GCP region
 - `TASK_SERVICE_ACCOUNT`
   - Service account which will be authenticated against
 - `TASK_DOMAIN`
   - domain which receives tasks (cloud run)
 - `TASK_DEFAULT_QUEUE`
   - default queue tasks will be added to

## Contributing

We use `pre-commit <https://pre-commit.com/>` to enforce our code style rules
locally before you commit them into git. Once you install the pre-commit library
(locally via pip is fine), just install the hooks::

    pre-commit install -f --install-hooks

The same checks are executed on the build server, so skipping the local linting
(with `git commit --no-verify`) will only result in a failed test build.

Current style checking tools:

- flake8: python linting
- isort: python import sorting
- black: python code formatting

Note:

    You must have python3.6 available on your path, as it is required for some
    of the hooks.

