openlayer.Project.commit

Project.commit(*args, **kwargs)

Adds a commit message to staged resources.

Parameters:

messagestr

The commit message, between 1 and 140 characters.

forcebool

If commit is called when there is already a commit message for the staging area, when force=True, the existing message will be overwritten by the new one. When force=False, the user will be prompted to confirm the overwrite first.

Notes

• To use this method, you must first add a model and/or dataset to the staging

  area using one of the add_* methods (e.g., add_model, add_dataset, add_dataframe).

Examples

Related guide: How to upload datasets and models for development.

A commit message is associated with a project version. The commit message is supposed to be a short description of the changes made from one version to the next.

Let’s say you have a project with a model and a dataset staged. You can confirm these resources are indeed in the staging area using the status method:

>>> project.status()

Now, you can add a commit message to the staged resources.

>>> project.commit("Initial commit.")

After adding the commit message, the resources are ready to be pushed to the platform. Use the push method to do so:

>>> project.push()