VFX Naming Conventions Docs¶
Installation¶
pip install vfxnaming
A complete suite of tools to manage naming conventions from one or more “Rule repositories”. Structure naming rules with your own custom tokens. Then use the library to solve names following those rules so your naming is consistent, and also to parse metadata from exisiting names (cus a name is basically a collection of metadata, right?)
General Ideas¶
vfxnaming consists of three main entities: Token
, TokenNumber
and Rule
. All of them are saved and read to and from a repository that contains their serialized versions.
A Rule is made of Tokens and hardcoded strings too. This is how a Rule pattern looks like. Values between curly braces ‘{ }’ are Token placeholders.
Note
‘{category}_{function}_{whatAffects}_{digits}_{type}’
naming module¶
vfxnaming.naming
is the main module of vfxnaming. Please refer to Naming Module for further details.
It consists of two key functions:
- parse(path)
- solve(args, kwargs)
And three working functions:
- get_repo()
- load_session()
- save_session()
logger module¶
vfxnaming.logger
uses Python logging to track almost everything that’s happening under the hood. This is really useful for debugging. Please refer to Logger Module for further details.
This is going to initialize the logger and output to stdout (console, terminal, etc)
from vfxnaming import logger
logger.init_logger()
This is going to initalize a log file where everything will be recorded.
from vfxnaming import logger
logger.init_file_logger()
Credits¶
vfxnaming is completely based on Copyright (c) 2017 Cesar Saez work. I highly recommend his Website-Blog and the video tutorial series on his YouTube Channel
For more information and credits please check Credits