Package: libreflow
ChangelogAll notable changes to this project will be documented in this file.The format is based onKeep a Changelog,
and this project adheres toSemantic Versioning[^1].[Unreleased][2.3.0] - 2024-10-01AddedA parameter to theMarkImageSequenceaction to specify the suffix in the name of the generated movie (default:_movie).A set of icons for classic tasks.The entity manager can now define a global collection to be used for file references with theEntityManager.get_file_ref_collection()method.New contextual parameters for the project and the main entities, accessible in the contextual dict of entities using the following keywords:Entity propertyKeywordProject nameproject_nameProject codeproject_codeFilm codefilm_codeFilm display namefilm_display_nameSequence codesequence_codeSequence display namesequence_display_nameShot codeshot_codeShot display nameshot_display_nameAsset display nameasset_display_nameAsset family codeasset_family_codeAsset family display nameasset_family_display_nameAsset type codeasset_type_codeAsset type display nameasset_type_display_nameTask prefixtask_prefixFile extensionfile_extensionRevision is a working copyrevisioin_working_copyThe newfilecontextual key has replaced thefile_mapped_namekey (defined in 2.1.0).Acodeproperty in theTaskTemplateentity. It is used by default for default tasks.Aprefixproperty to theTaskentity.A list of statutes in the project Kitsu settings to configure the statutes available in theUploadPlayblastToKitsuaction's dialog.TheTaskclass now provides apositionproperty which holds the task position among the list of tasks in the UI.A default task now provides anentity_filterparameter used to filter entities by oid in which the default task can be created.A new methodget_default_tasks()in theTaskManagerclass returns a filtered list of default tasks (see docstring for more details about filters).New parameters have been added to theCreateDefaultTasksActionaction to:hideoptionaltaskshidefilteredtasks, i.e. tasks for which the entity oid does not match theentity_filterTheTaskclass provides a new instance methodget_files()returning a filtered list of files - optionally including linked files - existing in a task (see docstring for more details about filtering parameters). It comes with another new methodhas_file_ref()which allows to check if a task has a reference to a given file. This can be useful to filter files and references from the first method output.If theoptional_publish_commentoption in the project settings is enabled, the user must enter a non-empty comment to publish changes made in a file.A newfile_user_statusproperty in theTrackedFileclass which represents the state of the file from the point of view of the current user:User statusValueUI ColorThe user has no working copy.None⚪The user has a working copy which is newer than the latest revision and no other users have working copies."latest"🟢The working copy of the user is older than the latest publication."old"🔴Other users have working copies."warning"🟠The UI of a file entry in the task UI have been updated to indicate if the file isprimary(name in bold) and if it isempty(name in italic). The entry's text/background color also reflects the file's user status (see table above).A new keyframe_ratein the project's contextual settings.ActionsCreateFileActionandCreateFolderActionnow allow to select the target category (Inputs,WorksorOutputs) of the item to create.TheLaunchSessionWorkeraction provides two new methodslauncher_exec_func_args()andlauncher_exec_func_kwargs()to set arguments passed by the worker to the executed method.TheTrackedFile.has_working_copy()method now checks the working copy synchronisation status using the parametersync_status.Optionauto_openin the default file settings allows to automatically open the last revision of a file/folder when double-clicked in the task UI. When the file/folder has no published revision, the default behavior is used.Automatic indexing of search entriesWhen enabled, this feature allows to index OIDs of flow touched objects according to a list of filters. Each filter is composed of:an oid pattern, used to filter touched objectsa boolean option which determine if the touched object must be indexeda list of target oid patterns, which state which target objects relative to the touched object must be indexedThese filters can be managed in the search settings in theFlowViewoption menu. Automatic indexing is disabled by default, and can be enabled from the session (seeSearchactor constructor).FixedCreate default files:NoneTypeerror when a default file was created from a base file which has no revision or whose latest revision wasn't available.Play sequence:NoneTypeerror when a file to be added in the sequence is empty.Render Image Sequence: The source revision comment is now defined in the folder revision.The time to access to file presets in a default task (DefaultTaskFiles) has been reduced by replacing preset parameters with computed values. This avoids broadcasting a 'touch' event whenever a parameter of a preset is set, which was useless since preset data is stored in the session.User tasks: Dialog for editing a task status works again if no revision was found for primary files.An error raising after confirming the creation of a working copy from a revision in the file history, which prevented the dialog from closing and the revision list from being updated.Bug occuring when saving the name and version of a default application while these had not been edited in the dialog. The values displayed by default when the dialog shows up now reflect correctly the actual values.The display of disabled tasks in the UI of an entity (asset/shot).CallingManagedTaskCollection.mapped_names()(e.g., to display the task list UI) does not raise aKeyErrorexception anymore when a task has no corresponding default task in the task manager. Instead, it uses the task'spositionproperty value, or a0position if the latter is undefined.The type of a file is not modified anymore whenever a reference to it is moved by drag-and-drop to another file category.IndexErrorpreventing from moving a file entry after any file placed before in the same list was moved.The list of references of an object wasn't updated when anEntityRefwas added/removed to aEntityRefMap(usingadd_ref()/remove_ref()methods).The cache of the task UI was not updated correctly when a file link was created. When a file link just created was dragged-and-dropped in another list, a new link was created in the target list instead of updating the type of the moved link.Simultaneous rendering of multiple revisions of an AfterEffects file.TheOpenTrackedFileActionaction shows its dialog if the working copy is not available on the current site.Ensure that the marking process for AE playblast rendering waits for the marking to finish to get grayed out in the process view.Runner configuration checkingThe actionsGenericRunActionandLaunchSessionWorkernow provide a methodrunner_configured()to check if a runner is properly configured. Both actions check if the runner type must be registered in the project's factory. In addition, a runner run by theGenericRunActionaction is considered configured if:a default application is defined for the extension of the target file (in the projectadminsection by default)the runner executable path is defined (either in the session, site or system environment)The following action classes have been updated to prompt an error message whenever the corresponding runner still needs to be configured:OpenRevisionOpenTrackedFileActionRenderBlenderPlayblastSelectAEPlayblastRenderModeRevealInExplorerRevealRevisionInExplorerRevealFileInExplorerOpenTrackedFolderRevisionChangedTheCustomEntityCollection'sget_property()andget_properties()methods now check for the properties in the collection cache, which significantly reduces the time needed to display the properties of a large number of entities in the UI.File references are now stored in aGlobalEntityCollection(project scope), which reduces the time to access a large number of references, e.g. for display in the task UI.The Gazu wrapper has been updated to manage sequences and shots belonging to episodes.KitsuAPIWrapper.get_assets_data()takes a new argumentepisode_nameto filter assets by episode.The search engine is now case-insensitive.Only admin users have access to theAdminproject relation.The map of default applications is not static anymore: file formats can be added/removed. Only extensions defined in this map will be available through theCreateFileActiondialog. A list of default file extensions is still provided when adding a new default application.The responsiveness to window resizing of action thumbnails of a task file entry has been improved: thumbnails display/hide so that the file name is always visible.A result in the completion list of the OID bar is automatically validated when it is clicked.TheMarkImageSequenceaction now outputs a movie at the frame rate specified by theframe_ratecontextual setting. If not defined, the frame rate used is 24.0 FPS.TheSelectAEPlayblastRenderModenow allows to select the output module template used by AfterEffects to render a playblast. An error message is also displayed in the dialog with details in the terminal if at least one rendering template in the the current site settings is undefined.Messages of theOpenTrackedFileActiondialog.User TasksThe user interface has been redesigned for greater clarity and to match the new colour scheme.A file list now has the same UI as in the task UI, including the working copy statusTasks data is now cached for a faster UI loadingFile list and comments widgets are now loaded in background to improve UI loading speedNew background thread for updating task data every 30 secondsScrolling of filter drop-down combobox is now correctly resetRemovedThe unusedMarkSequenceAfterRenderaction.[2.2.7] - 2023-03-22AddedA new flow view registerable in the GUI session. Its navigation bar allows a direct edition of the current oid and does not display map names.KitsuAPIWrapper provides aupload_asset_preview()method to upload a preview to an asset task in Kitsu.Project Wizard:Action dialog of an item can now be opened by a mouse double clickIf no project has been created in libreflow, home page links directly to the wizardFor new projects, films entities are now created by defaultA widget to import a project thumbnailIs primary file option has been added to edit task default file action.User tasks:Added popup menus in navigation buttonsAdded a separation line between presets and task status in the filter comboboxIf a libreflow or kitsu task was not found, a warning is now displayedTask default files: a default file can be created/incremented from a base file (which can be configured in the default file preset in the task manager). The creation action now lets the user:choose between creating a file from scratch or from its base fileedit its base file when the default file already existsChangedThe layout of the flow view header: view options are now available in the view title bar.TheTaskManager.get_task_files()method now returns a dictionnary in which data is mapped with the default file flow name to simplify the look-up.Blender playblast: the name of the sequence is marked as is on the frames.The label of a Blender playblast rendering job contains the Blender file oid.Project Wizard:Non editable files and auto-upload parameters have been reworked.The task manager page has been updated with recent changes.User tasks:Buttons to edit a task status and redirect to a task have been reversed.File upload in edit task status action has been completely reworked.Sorting by status has been improved.Added small modifications to the user interface to adapt to the new style class.FixedCreate an After Effects playblast with the path format of its corresponding default file when defined in the task manager. The project default path format is used otherwise.A non-default file can again be defined as a primary fileUser tasks:Better detection if names of libreflow and kitsu tasks are the sameIf the kitsu task was not found for a libreflow bookmark, feature was not workingThe value of thefile_typeparam of theAddDefaultTaskFileEditaction dialog was not reflecting its actual value, which was leading to default files with aNonefile type, as well as the task files created from them.When a file is created with theCreateTaskDefaultFilesaction, itsfile_typeandis_primary_fileproperties are set according to the corresponding file preset in the task manager.[2.2.6] - 2023-02-13AddedA new flow view registerable in the GUI session. Its navigation bar allows a direct edition of the current oid and does not display map names.New data which can be used in a file path format, using the following keywords and formats:Object dataKeywordData type / formatCurrent user nameuserstrCurrent user codeuser_codestrCurrent site namesitestrCurrent site codesite_codestrRevision numberrevision_numberintRevision creation daterevision_datestr/%y%m%dAsset codeasset_codestrTask codetask_codestrEach file link in a task file list displays the label of its origin task.A new style class.ChangedUser and site data is stored in MongoDB collections.RemovedActions to request revisions at the project, sequence and shot scopes.Action to check synchronisation errors.FixedUpdate of a default task file preset: the map cache was not updated.Creation of the default files of a task: created files did not match the selection due to a cache timeout.[2.2.5] - 2023-01-23AddedFile priority actions can be managed in the file presets of the project's default tasks. If priority actions are not defined for a given file, they are retrieved from the corresponding default task's file preset.A revision can be double-clicked in the history. The action run is specified inRevision.activate_oid(), which is the open action by default.FixedPrevent an error raising when a task is touched while its UI has not been built yet.Fix an error raising at the display of the tasks of an entity when the color of at least one of them is undefined (neither in the task manager nor in the task itself).[2.2.4] - 2023-01-11AddedAn action to reveal a revision in the explorer.An action to remove a file of a default task.An action to set a file as a task's primary file.Project WizardA new interface lists all the essential parameters that must be configured for the project.Accessible from a right click on the home page in the navigation barImport FilesAn action to import files into shots and assetsTask ManagerAn action to create default tasks from Kitsu onesA path format can be specified for a task template, which is inherited by default by its files (unless they explicitly override it). A path format can be also specified for a default task, in which case the path format of a file is evaluated to the value of the first path format defined in the following order: default task file > default task > task template file > task template.Task UIA new button to add the task in the bookmarks.Can open the new Import Files action by drag and drop filesUser TasksA dialog to edit task statusHandle libreflow bookmarksChangedTask UI: Button icon that displays disabled tasks is now dynamic according to its activation status.Revealing a tracked file in the explorer opens the grand-parent folder of the revisions by default.The action to open a revision is available only when the revision is marked as available on the current site. A warning dialog still appears if the revision doesn't exists.The action to create a working copy from a revision is available only when this revision is marked as available on the current site.User tasks:Better readability of task commentsShot duration is now displayed by total frames number and timestampFixedTask UI: The last site in file statues list was not displayed.Set the position of a default task when using the creation action.User tasks: Gets Kitsu tasks only from the current project[2.2.3] - 2022-11-29AddedA task provides a list of files which are to be edited by the user, calledprimary files. If no such file is defined for a given task, the primary files defined for the corresponding default task are returned.User tasksA new interface lists the project tasks corresponding to the Kitsu tasks to which the user is assigned.For each task, the view presents its primary files (whose options can be found by right-clicking) and its Kitsu history.PressingShiftkey allows to display the description and duration of the task's shot.A task in Libreflow can be bound to multiple Kitsu tasks in the corresponding default task settings.ChangedWhen a Blender playblast is created, if it belongs to the default files of the current task, its path format is set to that defined in the default file settings. Otherwise, the playblast is created with the same path format as the source Blender file.FixedBlender playblast rendering is possible for files which don't belong to shots. The sequence number and shot name are replaced by placeholders.[2.2.2.3] - 2022-11-29FixedUpdate Gazu required version (0.8.33) to properly check if the host is valid.[2.2.2.2] - 2022-11-28ChangedMake After Effects file template compatible with the 2023 version.[2.2.2.1] - 2022-11-28FixedKitsu host check is done using the original Gazu method (gazu.client.host_is_valid()).[2.2.2] - 2022-11-21TaskFile map actions are accessible in the task UI as buttons under the file list widget.[2.2.1] - 2022-11-08AddedTask UI improvementsAdd new icons to be displayed in the task list of a shot.Links to other files can be created by drag-and-dropping a file onto one of the file list of the task. The user can interact with links the same way as with regular files.File lists are updated whenever a file belonging to the task is touched. Similarly, the selected file history is updated whenever a revision belonging to this file is touched.A revision now holds a status parameter. Default statutes areworking_copyandinitfor working copies and publications respectively. Custom statutes can be defined in therevision_statutesparameter in the project settings.A revision now keeps track of the source revision it is created from. On this basis, a graph in the history view allows to visualise the parentage of the revisions and their statutes.FixedFixed the update of the revision data of the selected file in the task UI, making the application crash when switching to the history display mode.[2.2.0] - 2022-10-14AddedDefine new methods for Gazu wrapper:get_shots_data(sequence): Retrieve all shots data of a sequenceget_sequences_data(): Retrieve all sequences data of the Kitsu projectget_assets_data(asset_type): Retrieve all assets data of a asset typeget_asset_type_data(name): Retrieve all data of a asset typeget_asset_types_data(): Retrieve all asset types data of the Kitsu projectget_users(): Retrieve all users name associated on the Kitsu projectAn choice value for choosing output module for After Effects playblast rendering.RenderImageSequence: Can now handle a custom output file name and path.Task UITasks are ordered in the GUI according the position configured in the default tasks of the project.When reaching a task in the flow, the user is now provided with three lists of files: the input, working and output files of the task. When a file is selected, its revision history appears in the bottom of the page. General information of each revision is displayed by default. One can access to the revision synchronisation statutes of all the project's sites by pressing theshiftkey.ChangedUsers list is now injectable.File lock is now disabled by default.TrackedFile.get_revision()method now returnNoneif the searched revision doesn't exist, rather than raising an exception.FixedProperly set Blender playblast revisions created at rendering (i.e. according to the playblast path format).Name the render folder and movie resulting from AfterEffect playblast rendering with the name of the rendered AfterEffects scene.[2.1.6.3] - 2022-08-19FixedMake action to create a working copy from a file injectable.[2.1.6.2] - 2022-08-17FixedMake action to create a working copy from a revision injectable.[2.1.6.1] - 2022-08-11FixedRevisions are sorted by name in a natural way.[2.1.6] - 2022-08-11AddedA newutils.flow.valuesmodule to gather custom value types.AMultiOSValuewhose value is computed from that of an environment variable if defined, or that of a parameter corresponding to the OS currently running (among Linux, Windows and Darwin).Support for .psb files.[2.1.5] - 2022-07-28AddedA property and operators to the manage task class to assign users.Tasks to which the current user is not assigned are grayed out, unless assignation is disabled for the associated default task.A managed task can now contain subtasks:subtasks are defined in the default tasksa managed task provides an option to assign one of the project users to one or more of its subtasks.the managed task has a parameter which specify the current subtaskA list of tasks in the Kitsu settings now allows to associate a subtask with a task defined in the Kitsu project.ChangedThe oid of the last revision is automatically updated when adding a revision with theTrackedFile.add_revision()method.File advanced options are no longer listed in aAdvancedsubmenu.FixedThe status color of the last revision displayed in the file list, when the revision name begins with at.[2.1.4] - 2022-07-26AddedNew classes defining the following elements of an asset library:asset types, asset families and assets.[2.1.3.1] - 2022-07-22FixedUpload of playblasts to Kitsu.[2.1.3] - 2022-07-21ChangedAuthenticationMultiple users can use the same Kitsu account.A user now logs in with a login defined in its profile. The password is that of the Kitsu account being used by the user.AddedA map of users in the Kitsu settings allowing to redefine the Kitsu account used by each user of the project.[2.1.2] - 2022-07-21FixedThe opening of applications when entering a project from the home page using the search engine. The fix currently assumes that all the required runner types are registered in thetouch()method of the project.AE playblasts: ensure that the render folder revision is created before submitting (and is thus available to) the marking job.Ensure the playblast's last revision oid is updated when the rendering has finished.The extra environment of a runner isn't updated with the content of the contextual dictionary anymore, in order to prevent an environment update error raising when the contextual dictionary contains numerical values.AddedTasks are ordered in the GUI according the position configured in the default tasks of the project.Modifying the display name of the default tasks now update the names of the corresponding tasks displayed in the task list.A task stores 3 icon paths/references, one for each of its size (small, medium and large).APriorityFilesmap which manages a list of files to be prioritised for batch actions.An action for open a full sequence in Shotgun RV.At every use, the parameter values are reset to those stored in the project'saction value store.It retrieves shots according to this priority order. Compositing preview (compositing/compositing_movie.movby default) first or if it's not exist, the latest revision of the animatic (misc/animatic.mp4by default).If no file has been found in a shot, it is possible to replace it with a filler screen (Black,Magenta,SMPTE Bars).ChangedThe action to create default tasks in a task collection has been updated to allow to choose the tasks to create among the default ones defined in the task manager. Non-optional tasks are preselected. Tasks which already exist appear greyed out and can't be selected.A user can now create a working copy from that of another user, provided that theCreate working copiesoption in his/her preferences is enabled.[2.1.1] - 2022-06-01AddedA new type of task (libreflow.baseflow.task.ManagedTask), providing features (e.g., the creation of a list of default files) which use the task manager.A new type of task collection (libreflow.baseflow.task.ManagedTaskCollection). This collection uses, for each of its task, the icon and color defined by its associated default task in the task manager. It also provides an action to create a default task among those defined in the task manager.Actions to add and edit a default file of a task.FixedMake the terminal automatically close when RV is closed.[2.1.0] - 2022-05-17AddedAnEntityManagerobject which manages the collections of common entities (films, sequences, shots, departments, files, revisions, synchronisation statutes).Revision maps provide thefile_base_nameandfile_mapped_nameentries in their contextual dictionary, which are respectively the real name of the parent file on the file system without its extension, and its mapped name in the flow.As for other entities, theTaskandTaskCollectionclasses have been defined to allow to manage tasks, in a single Mongo collection for the entire project.Atask_managermodule to manage the creation of tasks based on default tasks.ChangedRedefine films, sequences and shots as Mongo entities.Films, sequences, shots, files, revisions and synchronisation statutes are retrieved by default from the global entity collections provided by the project's entity manager, assuming the project provides the latter in theget_entity_manager()method.If no default path format is provided to theFileSystemMapadd_file()andadd_folder()methods, the file/folder is created with the path format in the contextual dictionary by default, if defined.RemovedUnusedkitsu_name()andkitsu_id()method of the project class.[2.0.13] - 2022-05-13AddedUse Sentry to monitor jobs flow worker events. The Sentry SDK is initialised before starting aJobsWorkerSession, assuming the project Data Source Name (DSN) is provided in theSENTRY_DSNenvironment variable. When the job executed by the worker encounters an error, an exception is raised after the status of the job is updated, ensuring that the error is reported to Sentry.FixedMake theReveal In Exploreroption reveal the latest available revision.Gazu wrapper'sget_shots()method: tasks undefined in Kitsu are skipped in the filtering.An exception is raised whenever theget_path()method of a revision is called while its relative path is undefined (i.e., the value of itspathproperty is an empty string orNone).[2.0.12] - 2022-04-26FixedGet around the error raised by Gazu upon the upload of some video files.AddedMark Sequence:mark current and total time codes if provided in the marking template, astcandtotal_tcrespectivelyupdate the text fontremove gray bandsChangedGazu wrapper: allow to specify multiple statutes for a given task in theget_shot()method filter.[2.0.11] - 2022-04-21AddedOne can specify the--force-deleteargument to the jobs cleanup session to force job deletion.Gazu wrapper: add a method to upload a preview on a shot task, given the names of the shot and the sequence it belongs to.ChangedGazu wrapper: allow to get a list of shots filtered by their current statutes on given tasks[2.0.10] - 2022-03-30AddedRender AfterEffects playblast/Publish and Render Playblast: allow to choose the render resolution.Whenever the option dialog opens, the parameter value is reset to the value stored in the project'saction value store.A moduleaction_valueswhich defines classes to be used by actions to manage a set of default values (typically that of their parameters), which can be overriden at the project and site scopes.ChangedUtility functions related to context values are located in thelibreflow.utils.flow.context_valuesmodule.FixedMake sure that the last revision oid of each file created during playblast rendering is updated, so that it can show up in the file map.[2.0.9] - 2022-03-21AddedA WAV file templateOperators in Kitsu API wrapper to update the status of a shot's task[2.0.8] - 2022-03-15AddedA new module allowing to browse through project entries. It provides for that purpose:anActorand commands to index and search through projects on the current clusterSearchFlowViews (inherited from Kabaret's base flow views) which embed a search bar at their top.In order make this type of view available in the GUI, one must register theSearchFlowViewPluginplugin type in the session plugins.[2.0.7] - 2022-03-13AddedAfterEffects templates used for rendering (render settings, movie and audio output modules) can be configured in the settings of the current site.An option to export a temporary audio track of an AfterEffects scene, which may be used by image sequence marking option to generate a playblast. This option assumes a template namedaudio_onlyis available in the output module templates of the AfterEffects session used for rendering.FixedFile maps appearing empty when touched from other sessions, because properties of some entities are not yet set: these maps now update their cache whenever an accessed file property is not found in it.Render AfterEffects playblasts:Ensure that paths to the revisions created during rendering and marking are generated using the path formats of the files they belong to.Generate the playblast with the scene audio track, if it exists.[2.0.6] - 2022-03-13AddedTracked file class provides theadd_revisionmethod to add a revision a generic way.Working site type is now injectableWAV file format[2.0.5] - 2022-02-22AddedFile lock can be enabled/disabled in the project settings (with optionEnable File Lock).Indicate the sync status of the last revision displayed in the file list with colors.[2.0.4] - 2022-02-16FixedThe matching between the selected and the displayed values of a param with a preset, which could differ if the preset couldn't be applied: in this case, the param is reverted to its default value.Playblast rendering at sequence level[2.0.3] - 2022-02-09AddedAn option in playblast rendering actions to scale the render resolution given a percentage.[2.0.2] - 2022-02-03ChangedHide dependency request option on working copies.A warning dialog shows up when one is about to download a revision already available locally.AddedIcons for revision optionsFixedFile upload to KitsuForce stored revision paths to contain slashes (/) only to ensure they are correctly interpreted by Unix systems when revisions are synced.Waiting download jobs which reference revisions unavailable on the exchange server are not processed.When submitted, a synchronisation job stored the local path of the referenced revision, rooted at the current site's root directory. This ineluctably raised a conflict when the job was processed from another site with a different root path.Instead, only the revision relative path is stored, and its local path is computed on the fly, when the job is processed.[2.0.1] - 2022-02-02AddedAdded a path format property to file objects, used by default to generate revision paths.A system allowing to configure and create default files.FixedEnsure local paths are valid on Windows, Linux and MacOS systems.Fix tracked fileis_emptymethod when used to check if the file is empty on the current site.[2.0.0] - 2022-01-28IMPORTANT NOTEThis 2.x version of Libreflow embed many changes, including way more speed for map components, using a MongoDB service. Thus, it requires the setup of a MongoDB for Libreflow to work.ChangedUsekabaret.flow_entitiesextension to manage file system objects (files, revisions, synchronisation statutes) and site synchronisation queues in a Mongo database.Encapsulate file transfert operations in a single object hold by the exchange site.Revision paths are stored in the database.Revision paths can be generated and updated based on the content of the revision's contextual settings.Hide file publish option on locked files and when the current user has no working copy on them.AddedAdd an action to test the connection to the file exchange server.FixedWarn the user when an unavailable revision is double-clicked.Hide revision request option if the revision is already available on the exchange server.Hide revision upload option if the revision isn't available.Hide user's bookmarks if not registered in the project's users.Hide Kitsu options if the project's Kitsu settings aren't configured.[1.6.30] - 2021-12-16AddedA preset system for each user which pre-fills option parameters (available forUpload to Kitsu, publication and playblast rendering options)[1.6.29] - 2021-12-03FixedTemporary forced gazu dependency version, as latest version is making trouble to connect[1.6.28] - 2021-11-30FixedPublish from history: fix window display errorPublish from history: ensure that the revision is uploaded (whenUpload After Publishenabled) and Blender dependencies are saved.[1.6.27] - 2021-11-25ChangedAdd -autoRetime 0 option to RV launcher, so that sequences with different frame rates are kept in sync.AddedPlayblast: add options to reduce texture sizes and set target texture sizePublish: hideUpload After Publishoption for files matching one of the patterns provided in the project settings[1.6.26] - 2021-11-15ChangedImprove synchronization job management: show requested revisions in the history, reset erroneous jobsAddedA site option to automatically upload playblasts to the exchange server while they are being uploaded to Kitsu.FixedDon't store parameters of user environment variable creation dialog in the DB, to avoid access conflicts between sessions.[1.6.25] - 2021-11-08FixedAdd a missed synchronization icon, preventing the project root page to display entirely.[1.6.24] - 2021-11-08ChangedDo not copy in current folder anymore when publishing.FixedCorrect the warning message that appears when opening a file edited by other users.So far, site environment variables could only be redefined for a single OS. These variables have now one value for each OS (Linux, Darwin or Windows), active depending on the OS being used.Fix crash when trying to create a tracked folder's empty working copy folder while it already exists.Create a user's profile upon the first loginUsers can log in using their Kitsu desktop login or email[1.6.23] - 2021-10-14AddedThe possibility to select the columns to display in the job list, by right-clicking on the list header.Application versions can be overriden in a department's contextual environment. This can be achieved creating a variable that follows the naming convention<RUNNER_NAME>_VERSIONin the environment map of a department (optionShow Environment).NB:In order for overrides to be effective, one must have defined the executable paths corresponding to the runner overriden versions, either in the system, site or user environment. For instance, setting Blender version used in a given department to2.93requires theBLENDER_2_93_EXEC_PATHvariable to be set up. Otherwise, the application will launch in its default version.[1.6.22] - 2021-09-30AddedA launchable session which deletes jobs emitted before a given date, daily at a given time. Additionally, the cleaning process can stop on some days of the week specified by the user.Allow users to add sequences to their bookmarks.FixedThe job view now reacts to job creation and deletion events. This allows two optimisations:Items are added/removed as jobs are created/deleted, without a complete refresh of the listThe job list is built once, the first time the view is shownFirst step toward chaining jobs: When generating the playblast of an AfterEffects scene, ensure the generated image sequence is marked only when the job in charge of the rendering has terminated.[1.6.21] - 2021-09-20FixedSpeed up the display time of the waiting job count on the synchronization section, updating a counter at site level as files are requested and synchronized.Allow to upload playblasts to Kitsu in tasks of different types.[1.6.20] - 2021-09-13AddedA parameter to set the MinIO server bucket name, which can be set in the current exchange site.Upload after publishoption is now enabled by default for all files matching one of the patterns provided in the projet settings.FixedSite names are cached in the order defined in the current site, improving the time for histories to display.Prevent users from synchronizing files if the exchange server is not configured.[1.6.19] - 2021-09-09FixedDownload MinIO's intermediate files in a folder at the project's root path, named.tmp, to ensure that the drive of intermediate files is the same as that of the final downloaded files.Fixes 1.6.18 synchronisation error occuring at download when the project root drive and the OS temporary folder drive differ.[1.6.18] - 2021-09-07FixedMinimise the risk of exceeding the maximum path length on Windows when using MinIO API to download a file from the exchange server, using a custom intermediate temporary file.[1.6.17] - 2021-09-01AddedA new session to periodically clear synchronisation jobs.An option to compare the playblasts of two tasks of a shot in Shotgun RV. Available tasks: layout, blocking, animation, compositingChangedRemove unused options (locking, open with...) on files.Rework thePublish and playblastoption for Blender files, and define it for AfterEffects files. Make this option accessible right under thePublishoption.FixedEnsure that image sequence rendering and playblast generation for AfterEffects scenes areprocessed the same way: locally or on a jobs node session. In the latter case, ensure that both steps arehandled in the same pool.Addfileseqto the project's dependencies, needed to render AfterEffects playblasts.Prevent the user from publishing in a non-editable file, and from creating a working copy when the file is double-clicked.[1.6.16] - 2021-08-24AddedAn option to upload all playblasts of a sequence to the right tasks in Kitsu.If a task type is provided in the Kitsu data of a task (in the dependency template), it is used in priority for all files belonging to this task.An option to request revisions towards multiple sites, with an automatic source site selection option.ChangedDo not pack AfterEffects playblast images after they have been rendered (cf. 1.6.12 folder packing update).Mark playblast images with the name of the original AfterEffects scene (or the containing folder's, if it doesn't exist) instead of the resulting playblast name.FixedOne can validate credentials pressing the Enter key.[1.6.15] - 2021-08-17FixedHandle synchronization errors, now reported in the log of jobs.[1.6.14] - 2021-08-11FixedOptions to request a single revision and its dependencies.[1.6.13] - 2021-08-03AddedEach site can define a custom list of site names to change their display order in file histories and request option windows (these now includeRequestandRequest asoptions available on a single revision).OBJ file formatThe possibility to define shot elements that are not requestable, which can be achieved adding arequestableentry in the data of the element in the shot dependency template.ChangedRequest actions have been revised.[1.6.12] - 2021-07-20ChangedThe content of a tracked folder revision is packed/unpacked only when it needs to be uploaded to/downloaded from the exchange server.[1.6.11] - 2021-07-19AddedA set of job and action classes to render playblasts of After Effects scenes. The procedure is made in two steps:The image sequence rendering. This step can be achieved in a subprocess or using a job.The marking of images to generate the playblast. When using theRender Image Sequence, this step is handled in a job by default. This step is also available as a standalone option on any tracked folder which contains at least one image; in this case, the generate of the playblast can be achieved in a subprocess or using a job.ChangedBy default, a file's history displays only the synchronisation statutes of sites considered as active on the project.Display synchronisation statutes and site short names by default in a file's history.Sequence playblast rendering action has been update in order to render playblasts of After Effects scenes existing (depending on the defined shot dependencies).FixedEnsure that the source site and creator of sequence marking jobs are the same as those of the image rendering jobs.[1.6.10] - 2021-07-07FixedSequence playblast rendering action dialog:Make the first available head revision be the default selected revisionMake unavailable revisions unselectableEnsure runner types are registered when the project root is touched. This fixes the case where a runner is not found when launching an application, because the project root has not been accessed at least once.Systematically remove the content of thecurrentrevision folder when a revision is made current. This prevents the packaging of files already present in thecurrentfolder, making the archive grow each time a revision is made current.[1.6.9] - 2021-07-01FixedMake runner id accessible to the submitted job when rendering a playblast.[1.6.8] - 2021-07-01FixedThe setting of the environment variable holding a runner executable path has been moved, so that every RunAction which aims at opening a file properly updates the current environment before launching its corresponding runner.[1.6.7] - 2021-06-28AddedAn action to render playblasts of Blender scenes of a whole sequence.Note:This early version needs the different tasks of a shot (e.g., layout, animation, etc.) to be explicitly defined in a dependency template namedshot.ChangedAn application executable path is searched in the different environments just before launching the application, in the following order of priority: System environment > user environment > site environment.FixedAdded status icons with lowercase names to prevent resource lookup error on Linux.[1.6.6] - 2021-06-23FixedWhen a user logs in, the Libreflow ID (computed from the Kitsu ID) is changed to lowercase before the map of users is looked up. This prevents multiple users from having the same IDs with different character cases, and thus ensures the same behaviour in Windows and Linux when the user creates and access working copies.[1.6.5] - 2021-06-09FixedAll files in a tracked folder working copy are properly zipped when a publication is made.Make the revision upload after publication work again.MakeKeep editingoption work again when publishing a working copy from a file history.AddedBrute-force integration of thekabaret.jobsmodule implementation (with subtle corrections) to manage jobs.Based onkabaret.jobs, the possibility for studios to handle playblast renderings as jobs.Jobs can be submitted in one of the pools of the current site.The feature can be used choosing theSubmit joboption when rendering a playblast.Adaptations ofkabaret.jobs:Make view's job filter case-sensitive, and include pool name in filtering attributesProvide a job with a label and definable owner and creatorDefine a JOBS_DEFAULT_FILTER environment variable, usable by the JobsView as a default filter. If not explicitly provided at session startup, the variable defaults to the current site name.[1.6.4] - 2021-05-27AddedAllow Kitsu admin sites to upload playblasts toward any Kitsu task type available for the project.ChangedUsers are warned whenever one or more users have a working copy on a file, but are not prevented anymore from publishing in that case.Reference revision name in the dialog to create a working copy is set to the file's last publication name by default (if it exists).[1.6.3] - 2021-05-21FixedCopy of runner command to clipboard is handled by native Qt application clipboard object, instead of TKinter features (not integrated to Python main package on all LInux distributions).A new action to request elements related to a shot (assets, scenes, misc), including their dependencies.[1.6.2] - 2021-05-20AddedRunner implementation provides additional information, such as the command used, the time of the last run, etc.A panel in theSubprocessViewdisplays information about the currently selected runner.A new option in theSubprocessViewmenu allows to hide completed runner instances.FixedA runner instance is now identified by a Universal Unique Identifier, which eases its deletion in the subprocess manager.[1.6.1] - 2021-05-11AddedA new flow utility functionget_context_valuecan be used to recursively find and concatenate the values of all flow params of a given name declared in the parents of an object, including itself. To improve the flexibility of the context value parameterisation, the function makes use of the contextual dict when param values are specified between braces.[1.6.0] - 2021-05-11AddedA newkabaret.subprocess_managerutility module has been created to redefine and extend the core classes of the original Kabaret extension.Core classes have been extended to keep track of runner instances.A bunch of commands has been added to manage the underlying processes of these instances (launch, terminate, kill).A new view, which inherits from the originalSubprocessView, lists all the runners instanciated from the current session, and allow to display the output of the subprocess launched by the selected runner in the list. For now, the list has to be manually refreshed.A shortcut to the current site's job queue is available in theSynchronizationsection of the project's root page.ChangedThe base runner class has been adapted as required by the first version of theSubprocessView. Notable changes are:The redirection of bothstdoutandstderrof the subprocess to the same file.Additional data and operators to manage the subprocess, usable by the actor commands.FixedThe SubprocessManager does not add a runner's data in the list of runner infos if it has not run at least once. This is a temporary check which prevents from accessing unavailable data about a subprocess, because currently not provided by some runner types (e.g.DefaultEditor).[1.5.12] - 2021-05-07FixedExchange sites have been removed from theRequestAsaction's lists of requesting and requested sites.The revision published in a target file is automatically made current. Consequently, the last comment in the file list updates to the published revision's comment.Revision upload after publishing into another file has been fixed.AddedA new action allows to upload a published revision on the exchange server.[1.5.11] - 2021-05-04ChangedPlayblast upload dialog messages have been reworked.FixedAn additional test checks if the current's user data retrieved with Kitsu API provides the user's role. If not, the user is considered as not having the required rights to upload the target playblast while not assigned to the corresponding task.[1.5.10] - 2021-04-30FixedThe revision drop-down menu display isn't raising an error anymore when the file reference is not set.AddedThe option to use simplified rigs has been made available on the action dialog to publish and render a playblast.JSX file format is available.[1.5.9] - 2021-04-22FixedKitsu entity data is retrieved only when the preview uploading action shows up or run (not in the constructor). This fixes an issue occuring whenever the action object was instantiated, since it tried to get data from flow object not yet instantiated.[1.5.8] - 2021-04-22FixedChecking if a user is assigned to a Kitsu task is done exclusively by the preview uploading action. This means the internal function used to upload a preview assumes the user has sufficient rights.[1.5.7] - 2021-04-22ChangedKitsu supervisors and studio managers can upload previews regardless of their task assignment.[1.5.6] - 2021-04-22ChangedTwo choice values have been redefined to select a file's revision:One list all available revisions of the fileThe other list all available published revisionsRevision type (working copy or publication) is no longer checked from the revision creator's name but a name pattern (currently,v\d\d\d).[1.5.5] - 2021-04-21AddedA new action allows to upload files with eligible names as Kitsu previews. For now, uploadable files are defined in the project's Kitsu configuration.ChangedChange time format in log files, to make it human readable[1.5.4] - 2021-04-20FixedSingle files are checked to see if they match a folder in the flow, before checking if they match a file. It prevents folders containing a single file from being considered files.[1.5.3] - 2021-04-20AddedTwo new features of the Blender playblast are used by the playblast action:to enable the use of low-definition rigs in the Blender scene, available as a checkboxto print on the sequence the name of the selected revisionA new actionGetDependenciesallows to summarise dependency information of a given object and request all those which can be requested.As of now, real dependencies are collected from the Blender Asset Tracer tracing result. The feature is thus truly practical for Blender files, and dependencies related to files of any other format remain theoretical.ChangedOpen file action displays by default last revision, or user's working copy if it does not exist.A revision is systematically made current when published.FixedProject root path is added to the environment when opening a revision from a file history.File relation to department has been temporarily removed, allowing to define files elsewhere than in a department.Users can publish in files which are not related to a department in the flow.[1.5.2] - 2021-04-16AddedLogin page shows up when accessing bookmarks if user is not connected to Kitsu.[1.5.1] - 2021-04-02FixedPublishing into another file creates the necessary intermediate directories when the target file has not been created on the current site.[1.5.0] - 2021-04-01AddedJSON file format has been made available.libreflow.utils.b3d has been created with a wrapper for python-expressions to handle specific launch cases on windows.FixedThe python expression wrapper is applied to playblasts so they work when Blender is called through a .bat file.[1.4.3] - 2021-03-30Force Kabaret version to 2.2.0rc2[1.4.2] - 2021-03-26ChangedAllow the creation of working copies only on authorised files.FixedA workaround has been added to make GUI display on latest MacOS version (Kabaret issue #96).Requested and requesting sites are properly taken into account when requesting revisions.AddedAn additional parameter on revisions indicates if they are ready for synchronisation. A typical use case motivating this change is to prevent files not entirely created and initialised to be synchronised.An action now allows to request (for both source and target sites) elements of a given sequence.Requestable elements: sets, characters, props, sound files, storyboards and layout scenesAn action allows to resize all PNG images in a tracked folder revision into another tracked folder. Resulting tracked folder has the same name of source folder suffixed with_half.Revision oid pattern has been updated:to include multiple subpatterns separated by;so that each subpattern can include multiple substrings in the form{substring0, substring1, ...}A new action now allows to remove jobs emitted for a site before a given date, and of given type and status.[1.4.1] - 2021-03-22FixedRedefinition of TrackedFolderopenandhistoryrelated types have been removed, as it mistakenly redefined the same relations in the TrackedFile class.Force the indices ofopenandhistoryin TrackedFolder relation list to be the same as for TrackedFile in order to bypass submenu display issue.[1.4.0] - 2021-03-22ChangedThe way the names of new users are computed has been updated to take into account mail IDs.User class is now injectableAddedA warning message appears in home page when the computed name of a new user is already registered in the project's user list.Revisions now hold a dict of dependencies stored at publication. This feature applies exclusively for Blender files using pil libraryblender-asset-tracer(aka BAT) which is now mandatory.FixedSubmenus show up again when right clicking on tracked folders.[1.3.4] - 2021-03-18ChangedPublish action has been made injectable.Some improvements on advanced action dialogs have been made (message content, reset of file reference).[1.3.3] - 2021-03-16AddedAction for requesting file revisions now displays a list of found oids given a wildcard-based oid pattern (** not supported).Using[last]keyword in the pattern allows to get the latest published revision of a file. For instance, according to how the base flow is currently designed,/project/sequences/*/shots/*/departments/*/files/*/history/revisions/[last]allows to retrieve the latest publications of all files of the project namedproject.[1.3.2] - 2021-03-15FixedAction for requesting file revisions does not stop anymore when it falls onto a revision already available on requesting site, or not available on requested site.Current user is stored when profile has not already been registered.ChangedActions on tracked files have been refined and reorganised.AddedTwo new actions on tracked files allow respectively:to publish changes made in a file into another fileto create a working copy on a file from a selected revision of another fileUsers can now publish their changes made to a file from their working copy in the revision history.[1.3.1] - 2021-03-10Changedproject settings are now injectable[1.3.0] - 2021-03-10AddedFile maps now display tracked element latest revisions and their availability. These can be requested directly from the file map.ChangedSite definitions have been updated to distinguish working and exchange sites.Exchange server configuration is held by the project's exchange site.A working site's job queue can be accessed by right-clicking on its entry in the site map.Default exchange site has been renamed asdefault_site, to be distinguished from default working site.FixedJob emission date is stored as a floating point timestamp (not a formatted date string anymore) to be easily processed.Corrections on file list UI for untracked items.Publication option is not available anymore when rendering a playblast on a Blender file if the user hasn't a working copy on this file. This fixes an error which causes the resulting publication to be empty.[1.2.8] - 2021-03-10FixedLogout from project has been fixed.[1.2.7] - 2021-03-09FixedSubprocess environments are updated with the current site's root path. In particular, this makes root path, required in scene builder, accessible in Blender environment whenever a Blender scene is opened from Libreflow.AddedSubprocess extra environments also include the current user name and contextual settings.[1.2.6] - 2021-03-05FixedAdded FBX file format in PyPI package data to make FBX template available.[1.2.5] - 2021-03-01Omitted in 1.2.4:scriptfolder made as a valid Python package.[1.2.4] - 2021-03-01AddedAn action to batch revisions request as another site (currently not publicly available).ChangedA new Blender template file.Fixedscriptfolder made as a valid Python package.Project object is systematically touched when accessed from a home page widget to ensure user environment update.[1.2.3] - 2021-02-15AddedMP4, Illustrator and FBX file formats supportChangedActions to render a Blender file playblast is available in the base flow. Moreover, rendering a revision playblast generate a revision of the same index in a .mov tracked file.Map clearing action relations have been removed to prevent unfortunate deletions.Folder hierarchy in which user settings are stored has been changed to<user_folder>/.libreflow/<project_name>/<user_name>/<user_settings>.. This allows:a single user to be part of multiple projectsmultiple users to authenticate on a project on the same workstation.Revisions display the time elapsed since their publication[1.2.2] - 2021-02-09FixedChangeRequestaction allowing context condition[1.2.1] - 2021-02-09ChangedUser name is now computed from Kitsu ID at first connectionFiles and folders of any type can be revealed in file explorer[1.2.0] - 2021-02-08ChangedBookmarks have been changed from a local json file to a dedicated map on the project's flow. #12File extensions and icons are now constantsRevisions and TrackedFiles are now injectableA site can now request file revisions for other sites, if authorized (request_files_from_anywhereBoolParam).AddedThe project thumbnail flow can now be saved within the project admin/project settings area. So the thumbnail is available from anywhere no matter the site or OS. The old system is still present. #13DeprecatedThe old system for the thumbnail will soon be removed.FixedAt publish of a trackedFolder on python 3.7 an error appears because of a 3.8 update of stdlib shutil. Made a dirty fix for that.[1.1.7] - 2021-02-04AddedUsers can log out from the project, sending them back to the login page.FixedUser Kitsu id and the one used in the flow are distinguished, in order to ensure users are identified with a unique flow id which matches the pattern of a valid Python attribute, as required by Kabaret features. This currently implies users working on the project to be registered in this map.[1.1.6] - 2021-02-01FixedFile data formats have been added insetup.pyto make template files available within PyPI package.
Unforgivable hard-coded paths of several scripts have been changed for relative ones.[1.1.5] - 2021-01-29FixedFix revision playblast rendering: Get playblast folder path fromComputeddepartment path.[1.1.4] - 2021-01-29FixedFix revision upload:Revision.get_relative_path()gets parent file Computed path, instead of wrongly accessingget_contextual_dict.[1.1.3] - 2021-01-29FixedUntil now, the computation ofFileandRevisionpaths implied implying a costly non-linear look-up of contextual edits, and long wait for maps to display. There is now only one contextual settings look-up to compute aDepartmentpath, from which department's file paths are computed and cached.[1.1.2] - 2021-01-21FixedUser environment map items are nowSessionValues to make environment variable values stored at session's scope.[1.1.1] - 2021-01-20FixedMinIO and timeago added in setuptools requirements.[1.1.0] - 2021-01-20Multisite v1 releaseAddedA ComputedParam namedroot_diris now available in admin and it's cached as requiered by issue #4. A functionget_root()at the Project level use it and is able to provide the root folder of the project according to the operative system. Call it from anywhere in the flow withself.root().project().get_root().CHANGELOG.md,LICENCEandAUTORSfiles have been added to the repoMulti-sitefile synchronization features (related to issue #5):Add and configure project's sites (type - studio, user or exchange -, per-OS root directories, exchange server properties)Request tracked file's revisions unavailable on current site for download, based on a job submission featureASynchronizeFileaction allow users to process files they requested, and files other sites requested from theirs. This currently uses a MinIO client.Retrieve the current site and exchange site in the flow withself.root().project().[get_current_site()|get_exchange_site()]UI improvement: revision history maps can toggle site sync statusesRunners redirect their logs in a file placed in the user folder (bce8aadf)A newDefaultRunneris available to let the OS choose the default application for a given file path.Previews and renders of AfterEffects file revisions can be launched at revision and episode level, given AfterEffectsRender render settings and output module templatesPlayblasts of blender file revisions can be made with an action (previewfolder created in department's files if not already added)Md5 hash is computed for publishes for later features (cc0478e8)ChangedAccording to the newget_root()function added and requiered by issue #4, the default contextual dict doens't provide aROOT_DIRvalue anymore. Calls to that value have been changed, and you must defineROOT_DIR_WINDOWS,ROOT_DIR_LINUXand/orROOT_DIR_MACin the admin panel.Cosmetic changes to get some maps expanded or not (832605d8).There is no need to manually specify the user folder anymore: project'sget_user_folder()method now returns the path to a.libreflowin the user's home directory.For sake of readability, file maps showcase the time elapsed since file last modification, instead of date (59d364a8).[1.0.3] - 2020-12-24Fixedissue #7 libreflow icons are missing from the distributed package (and also the example packages where not accessible)[1.0.2-1.0.1] - 2020-12-23Initial public commit and pypi setup. This version is an early version of libreflow. It includes a baseflow and examples flows overriding the baseflow. We have been working on departments, files, file version history, and stuff like that.Fixedissue #6 : Pip Package is now ready for use[^1]: Except we started libreflow MAJOR version number at 1, as we consider our in-house previous flow being version 0.