Merge pull request #28 from quaternionmedia/ruff

🐶 Ruff

Author: mrharpo

.flake8

@@ -28,4 +28,4 @@ dist/
 build/
 
 # pdm
-.pdm.toml
+.pdm-python

.gitignore

@@ -5,3 +5,131 @@
 # otto
 
 an ottomatic video creator
+
+## Install from pip
+
+```bash
+pip install al-otto
+```
+
+## Optional packages
+
+Otto ships with several optional packages, which can be installed with `pip` or `pdm`
+
+#### pip install
+
+```bash
+pip install al-otto[test]
+```
+
+#### local pip install
+
+```bash
+pip install .[test]
+```
+
+#### pdm
+
+```bash
+pdm install -G test
+```
+
+## Development
+
+0. Install pdm
+
+```bash
+pip install pdm
+```
+
+1. Clone the repository
+
+```bash
+git clone https://github.com/quaternionmedia/otto.git
+```
+
+2. cd into the repo
+
+```bash
+cd otto
+```
+
+3. Install the development dependencies
+
+```bash
+pdm install
+```
+
+4. Create a local virtual environment
+
+```bash
+pdm venv create
+```
+
+5. Activate your local virtual environment
+
+```bash
+eval $(pdm venv activate)
+```
+
+Or...
+
+```bash
+source .venv/bin/activate
+```
+
+Deactivate your virtual environment by running `deactivate`
+
+### `test`
+
+Inlcudes pytest and other testing dependencies. Run with:
+
+```bash
+pytest
+```
+
+Can also be run with VSCode Python test extension, or VSCode debugger.
+
+### `render`
+
+Includes the python dependencies needed for rendering and effects.
+
+**NOTE** Requires a working installation of [imagemagick](https://imagemagick.org/)
+
+#### `docs`
+
+Includes documentation building tool. Run with:
+
+```bash
+mkdocs serve -a 0.0.0.0:9000
+```
+
+Then visit [localhost:9000](http://localhost:9000/)
+
+## nox
+
+Running all tests and formatters can be done as a one-liner using `nox`
+
+```bash
+pip install nox
+```
+
+Then run:
+
+```bash
+nox
+```
+
+### Sessions
+
+To run a single session, i.e. just the test suite, run:
+
+```bash
+nox -s coverage
+```
+
+See [noxfile.py](noxfile.py) for other commands.
+
+## Credits
+
+Created by [Quaternion Media, LLC](https://www.quaternion.media/)

README.md

@@ -1 +1,3 @@
 from ._version import __version__
+
+__all__ = ['__version__']

otto/__init__.py

@@ -1 +1 @@
-__version__ = '0.2.1'
+__version__ = '0.2.2'

otto/_version.py

@@ -12,7 +12,7 @@ async def previewFrame(t: float, render: Render):
     """# Preview frame
     Generates a frame of a given `edl` at time `t`, with `width` and `height`.
 
-     Returns the name of a file on this server when available, or a relevant error message
+    Returns the name of a file on this server when available, or a relevant error
     """
     print('previewing', render.edl, 'at frame', t)
     active_clips = [

otto/preview.py

@@ -45,7 +45,7 @@ docs = [
 dev = [
     "uvicorn >= 0.21.1",
     "black >= 23.1.0",
-    "flake8 >= 6.0.0"
+    "ruff >= 0.0.261"
 ]
 nox = ["nox >= 2022.11.21"]