Phoenix Pipeline Tool

Phoenix Pipeline Tool

A comprehensive pipeline tool designed for VFX artists, featuring three main components: Loader, Publisher, and Saver. This tool maximizes workflow efficiency and facilitates collaboration by minimizing technical overhead, allowing artists to focus on creative work.

---

Table of Contents

1. Key Features
2. Technology Stack
3. Installation Requirements
4. Project Structure
5. Future Improvements
6. Development Team
7. Project Duration
8. Key Benefits
9. License

---

Key Features

🔐 Login

• Login System using ShotGrid authentication
• User Email–based Account Identification
• Real-time User Information Retrieval via the ShotGrid API

🔄 Loader

• Personalized experience tailored to user roles and project requirements
• Unified version control for assets and shots
• Seamless integration with VFX software including Maya and Nuke
• User-friendly thumbnail-based browsing interface

💾 Saver

• Save work files to custom paths and automatically upload versions to ShotGrid
• Automated file naming and path generation
• Maintain work consistency and save time with automated file management
• Real-time intuitive UI for monitoring work paths and file save status

📤 Publisher

Maya Publisher

• Reference file auto-updates
• Automated slate generation with project information using captured image sequences via Playblast
• Automated workflows in 3D environment, including turntable animation

Nuke Publisher

• Node-based rendering with automated slate generation
• Write and Write Geo node management through tree widget interface
• Automated MOV and EXR rendering

---

Installation Requirements

• Python 3.9
• Required Libraries:
  • PySide6 (6.5.1)
  • certifi (2023.7.22)
  • charset-normalizer (3.3.0)
  • idna (3.4)
  • requests (2.31.0)
  • shiboken6 (6.5.1)
  • shotgun-api3 (3.3.1)
  • urllib3 (2.0.4)

Getting Started

Prerequisites

Python 3.9
Maya 2023+
Nuke 13.0+

Installation

1. Clone the repository

git clone https://github.com/carlton368/phoenix_pipeline_tool.git

2. Install required packages

pip install -r requirements.txt

HOW TO START

1. Edit core/config.ini with your settings:

• Update Shotgun credentials
• Configure Maya/Nuke executable locations

2. Open your terminal and navigate to the directory:

cd phoenix_pipeline_tool

3. Run the following command:

python phoenix_main.py 

Project Structure

phoenix_pipeline_tool/
├── Launcher/           # Login and Loader
├── Publisher/          # Publishing tools
├── Saver/              # Save management
├── core/               # config management & ShotGun api client 
│   └── config.ini      # Core configuration file (API keys, paths)
├── env/                # Environment configurations
├── ui/                 # UI components
└── phoenix_main.py     # Main Entry Point

Future Development

• Extended software compatibility
• Enhanced logging system
• Expanded test coverage
• Performance optimization

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Development Team

Name	Profile	GitHub Profile
Seyoung Kang	Team Leader (3D Rigger)	@kangseyoung
Yumi Kang	Film Major (VP Operator)	@yumai054
Gyeoul Kim	Digital Media Major (3D Rigger)
Sunjin Yun	Industrial Design Major	@gkdlfn1996
Wonjin Lee	Film Major	@carlton368

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made with ❤️ by Team Phoenix