projectcaluma/caluma

Project: caluma (GitHub Link)

caluma-master
- .github
  - workflows
    - pypi.yml
- .pre-commit-config.yaml
- docker-compose.override.yml
- LICENSE
- .reuse
  - dep5
- manage.py
- uwsgi.ini
- CONTRIBUTING.md
- .editorconfig
- CHANGELOG.md
- setup.py
- .gitlint
- requirements-dev.txt
- setup.cfg
- renovate.json
- .travis.yml
- README.md
- requirements.txt
- LICENSES
  - GFDL-1.3-or-later.txt
  - GPL-3.0-or-later.txt
  - CC0-1.0.txt
- caluma
  - extensions
    - visibilities.py
    - permissions.py
    - data_sources.py
    - validations.py
    - format_validators.py
    - events.py
    - __init__.py
    - dynamic_groups.py
  - wsgi.py
  - caluma_form
    - apps.py
    - fixtures
      - form-fixture.json
    - structure.py
    - factories.py
    - storage_clients.py
    - schema.py
    - format_validators.py
    - historical_schema.py
    - serializers.py
    - models.py
    - jexl.py
    - filters.py
    - ordering.py
    - __init__.py
    - migrations
      - 0023_auto_20190729_1448.py
      - 0003_auto_20190130_0920.py
      - 0031_auto_20200220_0910.py
      - 0033_slugfield_length.py
      - 0020_historicalanswer_historicalanswerdocument_historicaldocument_historicalfile_historicalform_historica.py
      - 0028_auto_20200210_0929.py
      - 0014_auto_20190429_0910.py
      - 0019_remove_answer_value_document.py
      - 0002_auto_20181221_1517.py
      - 0024_auto_20190919_1244.py
      - 0026_auto_20191031_0834.py
      - 0006_choice_type_conversion.py
      - 0032_auto_20200220_1311.py
      - 0001_initial.py
      - 0012_auto_20190416_1835.py
      - 0009_auto_20190321_1722.py
      - 0011_auto_20190411_0607.py
      - 0004_auto_20190207_1405.py
      - 0021_auto_20190708_0905.py
      - 0017_auto_20190619_1320.py
      - 0005_auto_20190208_1016.py
      - 0035_historicalanswer_history_question_type.py
      - 0030_auto_20200219_1359.py
      - 0016_auto_20190510_0843.py
      - 0015_question_format_validators.py
      - __init__.py
      - 0018_remove_answer_value_document_data_migration.py
      - 0008_auto_20190319_1720.py
      - 0025_dynamicoption_historicaldynamicoption.py
      - 0010_auto_20190404_0652.py
      - 0027_auto_20200113_0727.py
      - 0034_fix_fk_lengths.py
      - 0007_auto_20190208_1232.py
      - 0013_auto_20190418_0733.py
      - 0022_add_gin_index_to_jsonfields.py
      - 0029_dynamic_option_unique_together.py
    - tests
      - test_filter_by_answer.py
      - test_order_by_meta.py
      - test_answer.py
      - test_type.py
      - test_question.py
      - test_format_validators.py
      - test_search_answers.py
      - test_root_document_filter.py
      - test_validators.py
      - snapshots
        snap_test_question.py
        snap_test_filter_by_answer.py
        snap_test_option.py
        snap_test_history.py
        snap_test_document.py
        __init__.py
        snap_test_answer.py
        snap_test_format_validators.py
        snap_test_form.py
      - test_history.py
      - test_document.py
      - test_model.py
      - test_option.py
      - test_form.py
      - __init__.py
      - test_migration.py
      - test_command.py
      - test_jexl.py
    - validators.py
    - signals.py
    - management
      - commands
        create_bucket.py
        __init__.py
      - __init__.py
  - caluma_data_source
    - apps.py
    - data_sources.py
    - schema.py
    - data_source_handlers.py
    - __init__.py
    - utils.py
    - tests
      - data_sources.py
      - snapshots
        snap_test_data_source.py
        __init__.py
      - test_cache_decorator.py
      - __init__.py
      - test_data_source.py
  - schema.py
  - caluma_metadata.py
  - caluma_core
    - visibilities.py
    - apps.py
    - permissions.py
    - relay.py
    - faker.py
    - factories.py
    - validations.py
    - collections.py
    - events.py
    - serializers.py
    - models.py
    - jexl.py
    - urls.py
    - filters.py
    - forms.py
    - mutation.py
    - ordering.py
    - __init__.py
    - tests
      - test_mutation.py
      - fake_model.py
      - test_meta_filters.py
      - test_urls.py
      - test_permissions.py
      - test_collections.py
      - test_relay.py
      - test_migrate_to_prefixed_apps.py
      - test_visibility.py
      - test_inversible_filters.py
      - test_mutation_params.py
      - __init__.py
      - test_validations.py
      - test_ordersets.py
      - test_pagination.py
      - test_jexl.py
    - types.py
    - management
      - commands
        cleanup_history.py
        migrate.py
        __init__.py
        migrate_to_prefixed_apps.py
      - __init__.py
    - pagination.py
  - urls.py
  - caluma_workflow
    - visibilities.py
    - apps.py
    - domain_logic.py
    - factories.py
    - schema.py
    - events.py
    - serializers.py
    - models.py
    - jexl.py
    - api.py
    - filters.py
    - __init__.py
    - utils.py
    - migrations
      - 0021_work_item_controlling_groups.py
      - 0013_auto_20190718_1235.py
      - 0005_auto_20181228_1243.py
      - 0008_auto_20190208_1302.py
      - 0009_auto_20190213_0939.py
      - 0006_auto_20190121_1440.py
      - 0003_auto_20181217_1051.py
      - 0019_slugfield_length.py
      - 0010_auto_20190213_1050.py
      - 0011_auto_20190220_1303.py
      - 0002_auto_20181213_1334.py
      - 0001_initial.py
      - 0014_add_gin_index_to_jsonfields.py
      - 0016_auto_20200113_0727.py
      - __init__.py
      - 0022_workitem_name_description.py
      - 0012_historicalcase_historicalflow_historicaltask_historicaltaskflow_historicalworkflow_historicalworkite.py
      - 0015_add_work_item_skipped.py
      - 0018_auto_20200219_1359.py
      - 0007_auto_20190206_0854.py
      - 0004_auto_20181218_1352.py
      - 0020_case_families.py
      - 0017_auto_20200210_0929.py
    - tests
      - test_task.py
      - test_work_item.py
      - test_events.py
      - snapshots
        snap_test_work_item.py
        snap_test_workflow.py
        snap_test_task.py
        __init__.py
        snap_test_case.py
      - test_migrations.py
      - test_base_filters.py
      - test_case.py
      - __init__.py
      - test_workflow.py
      - test_visibilities.py
      - test_date_filters.py
      - test_dynamic_groups.py
      - test_jexl.py
    - validators.py
    - dynamic_groups.py
  - caluma_user
    - visibilities.py
    - apps.py
    - permissions.py
    - models.py
    - views.py
    - __init__.py
    - tests
      - test_permissions.py
      - test_visibility.py
      - __init__.py
      - test_views.py
  - __init__.py
  - utils.py
  - tests
    - snapshots
      - snap_test_schema.py
      - __init__.py
    - test_schema.py
    - __init__.py
  - settings
    - caluma.py
    - django.py
    - __init__.py
  - conftest.py
- Dockerfile
- .gitignore
- docs
  - graphql.md
  - validation.md
  - jexl.md
  - exam-execution-2.svg
  - interfaces.md
  - configuration.md
  - workflow-workitem-assignments.md
  - exam-design.svg
  - entities.md
  - exam-execution-1.svg
  - historical-records.md
  - workflow-implementation.md
  - events.md
  - extending.md
  - exam-execution-4.svg
  - maintainers.md
  - exam-execution-3.svg
  - django-apps.md
  - workflow-concepts.md
  - guide.md
  - workflow-entities.svg
- .dockerignore
- MANIFEST.in
- docker-compose.yml

A collaborative form editing service.

What is Caluma Service?

Caluma Service is the core part of the Caluma project providing a GraphQL API. For a big picture and to learn what Caluma does for you, have a look at caluma.io

Getting started

Installation

NOTE: We recommend using Caluma as a dedicated service. However, it is possible to integrate Caluma into a django project. You can read about this here.

Requirements

docker
docker-compose

After installing and configuring those, download docker-compose.yml and run the following command:

docker-compose up -d

You can now access GraphiQL at http://localhost:8000/graphql which includes a schema documentation. The API allows to query and mutate form and workflow entities which are described below.

Caluma is a 12factor app which means that configuration is stored in environment variables. Different environment variable types are explained at django-environ.

You can read more about running and configuring Caluma under docs/configuration.md

Debugging

Set environment variable ENV to dev to enable debugging capabilities. Don't use this in production as it exposes confidential information!

This enables Django Debug Middleware.

For profiling you can use ./manage.py runprofileserver. See docker-compose.override.yml for an example.

License

Code released under the GPL-3.0-or-later license.

For further information on our license choice, you can read up on the corresponding GitHub issue.

Further reading

Installation & Configuration - Get started installing Caluma in a production context
Contributing - If you want to help us, here's how to start with your first contribution.
Caluma Guide - How to get up and running with Caluma
Workflow Concepts - How to use caluma workflows
Historical Records - Undo and audit trail functionality
GraphQL - Further information on how to use the GraphQL interface
Validation - Validation of user input
Extending Caluma - Extensions: Data visibility and permissions
Caluma Events - Reacting upon Caluma Events
Using Caluma as django apps
Interfaces
Maintainer's Handbook - HOWTO for various maintainer's tasks