Custom project descriptions

Projects can contain additional description data that can be viewed in a project’s detail view. You can add or edit these information programmatically, for example when creating a project or during a state transition.

Here is an example of how you can use this when creating a new project, for example in the InitialState:

class InitialState(BaseState):
    @classmethod
    def initialize(cls):
        # ... initialization if required
        new_project = Project(
            # ... put your project data here
            custom_fields={
                "additional_description": {
                    "years of experience": 5,
                    "software used": "python, c++, go",
                    # ...
                }
            }
        )

    # ... the rest of the state

To add custom description data, add the key additional_description to the custom_fields attribute of your project. additional_description requires to contain a dictionary as value, where the keys are strings and values can be either strings or numbers. The keys and the values will be printed as a table, where all the keys are on the left and the values on the right side.