List files with lucidity templates.
Project description
Lucidity Files
Lucidity Files is a project for listing files and folders using the popular Lucidity templating module.
Made this for another project called Lucidity Browser (Aka Browser) that handles files listing and contextual actions across many folders and templates. This was tested with good results in the production Bad Dinos at Able & Baker studios. Since the focus was on the Browser part, this end up not being a great thing, but it works.
Have not tested this in Mac or Linux, although I plan to do it.
Badges
Installation
Install module with pip
python -m pip install lucidity_files
You can also target a folder like this (a pip thing, not anything i did)
python -m pip install --target=P:\my\path lucidity_files
Usage/Examples
import os
import lucidity_files
# create 'asset' file template -------
# define roots for files (useful for different os or the farm)
roots = {'root': 'C:'}
# define a relative path from the root
pattern = '{root:[\w_.\-:]+}/{project}/{entitytype}/{entity}/{step}/{task}/{entity}_{step}_{task}_{name}_v{version}.{ext}'
lf_template = lucidity_files.TemplateFile.create('assets', pattern, roots=roots)
# lets create a file to be listed
path = r"C:\test\asset\car\mod\hi\car_mod_hi_default_v001.txt"
os.makedirs(os.path.dirname(path), exist_ok=True)
with open(path, 'w'):
pass
# list all assets in project 'test'
paths_found = lf_template.getPaths({'project': 'test'})
# now get each path's data
for path in paths_found:
data = lf_template.parse(path)
print(path)
print('\t', data)
# # will print something like
# C:\test\asset\car\mod\hi\car_mod_hi_default_v001.txt
# {'entity': 'car', 'entitytype': 'asset', 'ext': 'txt', 'name': 'default',
# 'project': 'test', 'root': 'C:', 'step': 'mod', 'task': 'hi', 'version': '001'}
...
Documentation
Documentation on Read The Docs
Environment Variables
To run this project, you can add the following environment variables to your .env file
LUCIDITY_TEMPLATE_PATH
Where you store files defining your lucidity templates.
Acknowledgements
- Thanks to Jordi Amposta, Angel Galindo and Marco Sancho for the patience while testing this in production!
- This depends on the Lucidity Project, please check it out!
Authors
License
Used By
This project is used by the following companies:
Roadmap
-
Make module pip installable :)
-
Test on Linux
Support
For questions, email eduardo@eduardograna.com.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for lucidity_files-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5e31fa35789e6c9e1d8cfca5e13282e494ade8503895534da078f22bbcafeef5 |
|
MD5 | 8af21068e9cd7d41cc0542e0fba14757 |
|
BLAKE2b-256 | 563dfaa2315752c894f76c74c193d376a5b60dd07ab5010e5d1add6af86669e2 |