Warning, /multimedia/kdenlive-opentimelineio/README.md is written in an unsupported language. File is not indexed.

0001 <!--
0002     SPDX-License-Identifier: CC-BY-SA-4.0
0003     SPDX-FileCopyrightText: 2022 Julius K├╝nzel <jk.kdedev@smartlab.uber.space>
0004 -->
0005 
0006 
0007 # OpenTimelineIO Kdenlive Adapter
0008 
0009 This repository contains the OpenTimelineIO adapter for the Kdenlive file format (`*.kdenlive`). It is distributed under the MIT License.
0010 
0011 # ATTENTION!!! REPOSITORY IN PREPERATION PHASE
0012 
0013 At the moment the Kdenlive adapter is still part of the OpenTimelineIO core. To be installed via `python -m pip install opentimelineio` there is a ongoing efford to split all adapters from the core. As part of this the Kdenlive adapter will move here and get his own pypi.org python package soon.
0014 
0015 ## What is Kdenlive?
0016 
0017 [Kdenlive](https://kdenlive.org) is a Free and Open Source video editing application, based on MLT Framework and KDE Frameworks.
0018 
0019 In case you are looking for the source code of Kdenlive, it is here: https://invent.kde.org/multimedia/kdenlive
0020 
0021 ## What is OpenTimelineIO?
0022 
0023 [OpenTimelineIO](https://opentimeline.io) is an interchange format and API for editorial cut information. OTIO contains information about the order and length of cuts and references to external media. It is not however, a container format for media.
0024 
0025 For integration with applications, the [core OTIO library](https://github.com/AcademySoftwareFoundation/OpenTimelineIO) is implemented in C++ the project also supports an official python binding. The python binding includes a plugin system which supports a number of different types of plugins, most notably adapters (like this one).
0026 
0027 ### Adapter Plugins
0028 
0029 To provide interoperability with other file formats or applications lacking a native integration, the opentimelineio community has built a number of python adapter plugins. Beside Kdenlive this includes Final Cut Pro XML, AAF, CMX 3600 EDL, and more.
0030 
0031 For more information about this, including supported formats, see: https://opentimelineio.readthedocs.io/en/latest/tutorials/adapters.html
0032 
0033 A list of tools and projects using OpenTimelineIO can be found [here](https://github.com/AcademySoftwareFoundation/OpenTimelineIO/wiki/Tools-and-Projects-Using-OpenTimelineIO).
0034 
0035 ## Installing
0036 
0037 **ATTENTION: THIS SECTION IS NOT YET VALID, see note on top of this document**
0038 
0039 As a user you can usually just install the adapter through the Kdenlive user interface or directly from pypi.org with this command
0040 
0041 ```bash
0042 python -m pip install otio-kdenlive-adapter
0043 ```
0044 
0045 ## Development
0046 
0047 The OpenTimelineIO documentation can be found here: https://opentimelineio.readthedocs.io
0048 
0049 ### Testing the plugin during development
0050 ```bash
0051 # In the root folder of the repo
0052 pip install -e .
0053 
0054 # Test an adapter for instance
0055 otioconvert -i some_timeline.otio -o some_timeline.kdenlive
0056 ```
0057 
0058 The OpenTimelineIO documentation can be found here: https://opentimelineio.readthedocs.io
0059 
0060 ### Unit tests
0061 
0062 It's always a good idea to write unit tests for you code.
0063 Please provide tests that run against supported versions of python and OpenTimelineIO.
0064 
0065 To run the unit tests do
0066 ```bash
0067 # In the root folder of the repo
0068 pytest
0069 ```
0070 
0071 Before pushing changes you should also run the linter
0072 ```bash
0073 flake8 --show-source
0074 ```