Metadata-Version: 2.1
Name: caluma
Version: 8.0.0b19
Summary: Caluma Service providing GraphQL API
Home-page: https://caluma.io
License: GPL-3.0-or-later
Author: Caluma
Author-email: info@caluma.io
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: Django (>=3.2.12,<4.0.0)
Requires-Dist: dateparser (>=1.1.0,<2.0.0)
Requires-Dist: django-cors-headers (>=3.11.0,<4.0.0)
Requires-Dist: django-environ (>=0.9.0,<0.10.0)
Requires-Dist: django-extensions (>=3.1.5,<4.0.0)
Requires-Dist: django-filter (>=22.1,<23.0)
Requires-Dist: django-localized-fields (>=6.6,<7.0)
Requires-Dist: django-postgres-extra (>=2.0.4,<3.0.0)
Requires-Dist: django-simple-history (>=3.0.0,<4.0.0)
Requires-Dist: django-watchman (>=1.2.0,<2.0.0)
Requires-Dist: djangorestframework (>=3.13.1,<4.0.0)
Requires-Dist: graphene-django (==3.0.0b7)
Requires-Dist: graphql-core (>=3.1.7,<3.2.0)
Requires-Dist: graphql-relay (>=3.1.5,<4.0.0)
Requires-Dist: idna (>=3.3,<4.0)
Requires-Dist: minio (>=7.1.4,<8.0.0)
Requires-Dist: psycopg2-binary (>=2.9.3,<3.0.0)
Requires-Dist: pyjexl (>=0.3.0,<0.4.0)
Requires-Dist: python-memcached (>=1.59,<2.0)
Requires-Dist: requests (>=2.27.1,<3.0.0)
Requires-Dist: uWSGI (>=2.0.20,<3.0.0)
Requires-Dist: urllib3 (>=1.26.8,<2.0.0)
Project-URL: Documentation, https://caluma.gitbook.io/
Project-URL: Repository, https://github.com/projectcaluma/caluma
Description-Content-Type: text/markdown

# ![Caluma Service](https://user-images.githubusercontent.com/6150577/60805422-51b1bf80-a180-11e9-9ae5-c794249c7a98.png)

[![Build Status](https://github.com/projectcaluma/caluma/workflows/Tests/badge.svg)](https://github.com/projectcaluma/caluma/actions?query=workflow%3ATests)
[![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen.svg)](https://github.com/projectcaluma/caluma/blob/main/setup.cfg#L57)
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
[![PyPI](https://img.shields.io/pypi/v/caluma)](https://pypi.org/project/caluma/)
[![License: GPL-3.0-or-later](https://img.shields.io/github/license/projectcaluma/caluma)](https://spdx.org/licenses/GPL-3.0-or-later.html)

Caluma is a collaborative form editing and workflow service.

- Website: [caluma.io](https://caluma.io)
- Documentation: [caluma.gitbook.io](https://caluma.gitbook.io)

## Getting started

**Requirements**

- docker
- docker-compose

After installing and configuring those, download [docker-compose.yml](https://github.com/projectcaluma/caluma/blob/main/docker-compose.yml) and run the following command:

```bash
docker-compose up -d
```
Schema introspection and documentation is available at [http://localhost:8000/graphql](localhost:8000/graphql) and can be accessed using a GraphQL client such as [Altair](https://altair.sirmuel.design/). The API allows to query and mutate form and workflow entities which are described below.

You can read more about running and configuring Caluma in the [documentation](https://caluma.gitbook.io).

## License

Code released under the [GPL-3.0-or-later license](LICENSE).

For further information on our license choice, you can read up on the [corresponding GitHub issue](https://github.com/projectcaluma/caluma/issues/751#issuecomment-547974930).

---

- Contributing guide: [CONTRIBUTING.md](CONTRIBUTING.md)
- Maintainer's Handbook: [MAINTAINING.md](MAINTAINING.md)

