---

1. Feature: OpenStudioLandscapes-Kitsu
   1. Brief
   2. Requirements
   3. Install
      1. This Feature
   4. Add to OpenStudioLandscapes
   5. Testing
      1. pre-commit
      2. nox
   6. Variables
      1. Feature Configs
2. Community
3. Kitsu Documentation

---

This README.md was dynamically created with OpenStudioLandscapesUtil-ReadmeGenerator.

---

Feature: OpenStudioLandscapes-Kitsu

Brief

This is an extension to the OpenStudioLandscapes ecosystem. The full documentation of OpenStudioLandscapes is available here.

You feel like writing your own Feature? Go and check out the OpenStudioLandscapes-Template.

Requirements

• python-3.11
• OpenStudioLandscapes

Install

This Feature

Clone this repository into OpenStudioLandscapes/.features:

# cd .features
git clone https://github.com/michimussato/OpenStudioLandscapes-Kitsu.git

Create venv:

# cd .features/OpenStudioLandscapes-Kitsu
python3.11 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip setuptools

Configure venv:

# cd .features/OpenStudioLandscapes-Kitsu
pip install -e "../../[dev]"
pip install -e ".[dev]"

For more info see VCS Support of pip.

Add to OpenStudioLandscapes

Add the following code to OpenStudioLandscapes.engine.features.FEATURES:

FEATURES.update(
    "OpenStudioLandscapes-Kitsu": {
        "enabled": True|False,
        # - from ENVIRONMENT VARIABLE (.env):
        #   "enabled": get_bool_env("ENV_VAR")
        # - combined:
        #   "enabled": True|False or get_bool_env(
        #       "OPENSTUDIOLANDSCAPES__ENABLE_FEATURE_OPENSTUDIOLANDSCAPES_KITSU"
        #   )
        "module": "OpenStudioLandscapes.Kitsu.definitions",
        "compose_scope": ComposeScope.DEFAULT,
        "feature_config": OpenStudioLandscapesConfig.DEFAULT,
    }
)

Testing

pre-commit

• https://pre-commit.com
• https://pre-commit.com/hooks.html

pre-commit install

nox

Generate Report

nox --no-error-on-missing-interpreters --report .nox/nox-report.json

Re-Generate this README

nox -v --add-timestamp --session readme

Generate Sphinx Documentation

nox -v --add-timestamp --session docs

pylint

nox -v --add-timestamp --session lint

pylint: disable=redefined-outer-name

• W0621: Due to Dagsters way of piping arguments into assets.

SBOM

Acronym for Software Bill of Materials

nox -v --add-timestamp --session sbom

We create the following SBOMs:

• cyclonedx-bom
• pipdeptree (Dot)
• pipdeptree (Mermaid)

SBOMs for the different Python interpreters defined in .noxfile.VERSIONS will be created in the .sbom directory of this repository.

• cyclone-dx
• pipdeptree (Dot)
• pipdeptree (Mermaid)

Currently, the following Python interpreters are enabled for testing:

• python3.11

Variables

The following variables are being declared in OpenStudioLandscapes.Kitsu.constants and are accessible throughout the OpenStudioLandscapes-Kitsu package.

Variable	Type
DOCKER_USE_CACHE	bool
KITSUDB_INSIDE_CONTAINER	bool
ASSET_HEADER	dict
FEATURE_CONFIGS	dict

Feature Configs

Feature Config: default

Variable	Type	Value
DOCKER_USE_CACHE	bool	False
KITSU_ENABLE_JOB_QUEUE	bool	True
KITSU_ADMIN_USER	str	[email protected]
KITSU_DB_PASSWORD	str	mysecretpassword
KITSU_SECRET_KEY	str	yourrandomsecretkey
KITSU_PREVIEW_FOLDER	str	/opt/zou/previews
KITSU_TMP_DIR	str	/opt/zou/tmp
KITSU_PORT_HOST	str	4545
KITSU_PORT_CONTAINER	str	80
KITSU_POSTGRES_CONF	str	{DOT_FEATURES}/OpenStudioLandscapes-Kitsu/.payload/config/etc/postgresql/14/main/postgresql.conf
KITSU_DATABASE_INSTALL_DESTINATION	str	{DOT_LANDSCAPES}/{LANDSCAPE}/Kitsu__Kitsu/data/kitsu

Community

Feature	GitHub	Discord
OpenStudioLandscapes	https://github.com/michimussato/OpenStudioLandscapes	# openstudiolandscapes-general
OpenStudioLandscapes-Ayon	https://github.com/michimussato/OpenStudioLandscapes-Ayon	# openstudiolandscapes-ayon
OpenStudioLandscapes-Dagster	https://github.com/michimussato/OpenStudioLandscapes-Dagster	# openstudiolandscapes-dagster
OpenStudioLandscapes-Flamenco	https://github.com/michimussato/OpenStudioLandscapes-Flamenco	# openstudiolandscapes-flamenco
OpenStudioLandscapes-Flamenco-Worker	https://github.com/michimussato/OpenStudioLandscapes-Flamenco-Worker	# openstudiolandscapes-flamenco-worker
OpenStudioLandscapes-Kitsu	https://github.com/michimussato/OpenStudioLandscapes-Kitsu	# openstudiolandscapes-kitsu
OpenStudioLandscapes-RustDeskServer	https://github.com/michimussato/OpenStudioLandscapes-RustDeskServer	# openstudiolandscapes-rustdeskserver
OpenStudioLandscapes-Template	https://github.com/michimussato/OpenStudioLandscapes-Template	# openstudiolandscapes-template
OpenStudioLandscapes-VERT	https://github.com/michimussato/OpenStudioLandscapes-VERT	# openstudiolandscapes-twingate

To follow up on the previous LinkedIn publications, visit:

• OpenStudioLandscapes on LinkedIn.
• Search for tag #OpenStudioLandscapes on LinkedIn.

---

Kitsu Documentation

• https://kitsu.cg-wire.com

Kitsu is written and maintained by CGWire, a company based in France:

Kitsu itself consists of two modules:

1. Gazu - Kitsu Python Client
2. Zou - Kitsu Python API

OpenStudioLandscapes-Kitsu is based on the Kitsu provided Docker image:

• https://kitsu.cg-wire.com/installation/#using-docker-image
• https://hub.docker.com/r/cgwire/cgwire

The default credentials are:

• User: [email protected]
• Password: mysecretpassword

You can override the default credentials by setting:

• KITSU_ADMIN_USER
• KITSU_DB_PASSWORD