Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the documentation theme to furo. #98

Merged
merged 2 commits into from
Nov 5, 2024
Merged

Updated the documentation theme to furo. #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dde4340
* [#90] Updated the documentation theme to `furo`.
eoyilmaz Nov 5, 2024
e54707c
[#90] Fix a typo in `design.rst` and add the mention of PostgreSQL ve…
eoyilmaz Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -476,9 +476,9 @@ testing the library.
* **Fix:** Fixed ``Task.path`` to always return a path with forward slashes.

* **New:** Introducing ``EntityGroups`` that lets one to group a bunch of
``SimpleEntity``s together, it can be used in grouping tasks even if they are
in different places on the project task hierarchy or even in different
projects.
``SimpleEntity`` instances together, it can be used in grouping tasks even if
they are in different places on the project task hierarchy or even in
different projects.

* **Update:** ``Task.percent_complete`` is now correctly calculated for a
``Duration`` based task by using the ``Task.start`` and ``Task.end``
Expand Down Expand Up @@ -530,8 +530,8 @@ testing the library.
variables for each repository in the database.

* **New:** Added a new ``after_insert`` which listens ``Repository`` instance
``insert``s to automatically add environment variables for the newly inserted
repositories.
``insert`` instances to automatically add environment variables for the newly
inserted repositories.

* **Update:** ``Repository.make_relative()`` now handles paths with environment
variables.
Expand All @@ -550,7 +550,8 @@ testing the library.
``linux_path`` on Linux or setting the ``windows_path`` on Windows or setting
the ``osx_path`` on OSX will update the environment variable.

* **New:** Added ``Task.good`` attribute to easily connect tasks to ``Good``s.
* **New:** Added ``Task.good`` attribute to easily connect tasks to ``Good``
instances.

* **New:** Added new methods to ``Repository`` to help managing paths:

Expand All @@ -562,10 +563,12 @@ testing the library.
* ``Repository.env_var`` a new property that returns the related environment
variable name of a repo instance. This is an instance property::

# with default settings
repo = Repository(...)
repo.env_var # should print something like "REPO131" which will be used
# in paths as "$REPO131"
.. code=block:: python

# with default settings
repo = Repository(...)
repo.env_var # should print something like "REPO131" which will be used
# in paths as "$REPO131"

* **Fix:** Fixed ``User.company_role`` attribute which is a relationship to
the ``ClienUser`` to cascade ``all, delete-orphan`` to prevent
Expand Down
14 changes: 13 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,10 @@ install:
clean: FORCE
@printf "\n\033[36m--- $@: Clean ---\033[0m\n"
-rm -rf .pytest_cache
-rm -rf $(VIRTUALENV_DIR)
-rm -rf dist
-rm -rf build
-rm -rf docs/build
-rm -rf docs/source/generated/*

clean-all: clean
@printf "\n\033[36m--- $@: Clean All---\033[0m\n"
Expand Down Expand Up @@ -82,5 +83,16 @@ tests:
echo -e "\n\033[36m--- $@: Using python interpretter '`which python`' ---\033[0m\n"; \
PYTHONPATH=src pytest -v -n auto -W ignore --color=yes --cov=src --cov-report term --cov-fail-under 99 tests;


# sphinx-build \
# {tty:--color} \
# -b html \
# doc/sphinx/source doc/sphinx/build \
# {posargs}
.PHONY: docs
docs:
cd docs && $(MAKE) html


# https://www.gnu.org/software/make/manual/html_node/Force-Targets.html
FORCE:
233 changes: 42 additions & 191 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,249 +20,100 @@
:target: https://pypi.python.org/pypi/stalker
:alt: Wheel Support



=====
About
=====

Stalker is an Open Source Production Asset Management (ProdAM) Library designed
specifically for Animation and VFX Studios but can be used for any kind of
projects. Stalker is licensed under LGPL v3.
specifically for Animation and VFX Studios. But it can be used for any kind of
projects from any other industry. Stalker is licensed under LGPL v3.

Features
========

Stalker has the following features:

* Designed for **Animation and VFX Studios**.
* Platform independent.
* Default installation handles nearly all the asset and project management
needs of an animation and vfx studio.
* Customizable with configuration scripts.
* Designed for **Animation and VFX Studios** (but not limited to).
* OS independent, can work simultaneously with **Windows**, **macOS** and
**Linux**.
* Supplies excellent **Project Management** capabilities, i.e. scheduling and
tracking tasks, milestones and deadlines (via **TaskJuggler**).
* Powerful **Asset management** capabilities, allows tracking of asset
references in shots, scenes, sequences and projects.
* Customizable object model (**Stalker Object Model - SOM**).
* Uses **TaskJuggler** as the project planing and tracking backend.
* Mainly developed for **PostgreSQL** in mind but **SQLite3** is also
supported.
* Can be connected to all the major 3D animation packages like **Maya,
Houdini, Nuke, Fusion, Softimage, Blender** etc. and any application that
has a Python API. And with applications like **Adobe Photoshop** which does
not have a direct Python API but supports ``win32com`` or ``comtypes``.
* Mainly developed for **Python 3.0+** and **Python 2.7** is fully supported.
* Developed with **TDD** practices.
Houdini, Nuke, Fusion, DaVinci Resolve, Blender** etc. and any application
that has a Python API, and for **Adobe Suite** applications like
**Adobe Photoshop** through ``win32com`` or ``comtypes`` libraries.
* Developed with religious **TDD** practices.

Stalker is build over these other OpenSource projects:
Stalker is mainly build over the following OpenSource libraries:

* Python
* SQLAlchemy and Alembic
* Jinja2
* TaskJuggler

Stalker as a library has no graphical UI, it is a python library that gives you
the ability to build your pipeline on top of it. There are other python
packages like the Open Source Pyramid Web Application `Stalker Pyramid`_ and
the Open Source pipeline library `Anima`_ which has PyQt/PySide/PySide2 UIs for
applications like Maya, Nuke, Houdini, Fusion, Photoshop etc.
As Stalker is a Python library and doesn't supply any graphical UI you can use
other tools like `Stalker Pyramid`_ which is a Pyramid Web Application and
`Anima`_ which has PyQt/PySide UIs for applications like Houdini, Maya,
Blender, Nuke, Fusion, DaVinci Resolve, Photoshop and many more.

.. _`Stalker Pyramid`: https://github.com/eoyilmaz/stalker_pyramid
.. _`Anima`: https://github.com/eoyilmaz/anima

Installation
============

Use::
Simply use:

pip install stalker
.. code-block:: shell

pip install stalker

Examples
========

Let's play with **Stalker**.

Initialize the database and fill with some default data:

.. code:: python

from stalker import db
db.setup()
db.init()

Create a ``User``:

.. code:: python

from stalker.db.session import DBSession
from stalker import User
me = User(
name='Erkan Ozgur Yilmaz',
login='erkanozgur',
email='[email protected]',
password='secretpass'
)

# Save the user to database
DBSession.save(me)

Create a ``Repository`` for project files to be saved under:

.. code:: python

from stalker import Repository
repo = Repository(
name='Commercial Projects Repository',
windows_path='Z:/Projects',
linux_path='/mnt/Z/Projects',
macos_path='/Volumes/Z/Projects'
)

Create a ``FilenameTemplate`` (to be used as file naming convention):

.. code:: python

from stalker import FilenameTemplate

task_template = FilenameTemplate(
name='Standard Task Filename Template',
target_entity_type='Task', # This is for files saved for Tasks
path='{{project.repository.path}}/{{project.code}}/'
'{%- for parent_task in parent_tasks -%}'
'{{parent_task.nice_name}}/'
'{%- endfor -%}', # This is Jinja2 template code
filename='{{version.nice_name}}_v{{"%03d"|format(version.version_number)}}'
)

Create a ``Structure`` that uses this template:

.. code:: python

from stalker import Structure
standard_folder_structure = Structure(
name='Standard Project Folder Structure',
templates=[task_template],
custom_template='{{project.code}}/References' # If you need extra folders
)

Now create a ``Project`` that uses this structure and will be placed under the
repository:

.. code:: python
Because Stalker uses SQLAlchemy, it is very easy to retrieve complex data.
Let's say that you want to query all the Shot Lighting tasks where a specific
asset is referenced:

from stalker import Project
new_project = Project(
name='Test Project',
code='TP',
structure=standard_folder_structure,
repositories=[repo], # if you have more than one repository you can do it
)

Define the project resolution:

.. code:: python

from stalker import ImageFormat
hd1080 = ImageFormat(
name='1080p',
width=1920,
height=1080
)

Set the project resolution:

.. code:: python

new_project.image_format = hd1080

# Save the project and all the other data it is connected to it
DBSession.save(new_project)

Create Assets, Shots and other Tasks:

.. code:: python

from stalker import Task, Asset, Shot, Type

# define Character asset type
char_type = Type(name='Character', code='CHAR', target_entity_type='Asset')

character1 = Asset(
name='Character 1',
code='CHAR1',
type=char_type,
project=new_project
)

# Save the Asset
DBSession.save(character1)

model = Task(
name='Model',
parent=character1
)

rigging = Task(
name='Rig',
parent=character1,
depends_on=[model], # For project management, define that Rig can not start
# before Model ends.
)

# Save the new tasks
DBSession.save([model, rigging])

# A shot and some tasks for it
shot = Shot(
name='SH001',
code='SH001',
project=new_project
)

# Save the Shot
DBSession.save(shot)
.. code-block:: python

animation = Task(
name='Animation',
parent=shot,
)
from stalker import Asset, Shot, Version

lighting = Task(
name='Lighting',
parent=shot,
depends_on=[animation], # Lighting can not start before Animation ends,
schedule_timing=1,
schedule_unit='d', # The task expected to take 1 day to complete
resources=[me]
)
DBSession.save([animation, lighting])
my_asset = Asset.query.filter_by(name="My Asset").first()
refs = Version.query.filter_by(name="Lighting").filter(Version.inputs.contains(my_asset)).all()

Let's create versions for the Animation task.
Let's say you want to get all the tasks assigned to you in a specific Project:

.. code-block:: python

from stalker import Version
from stalker import Project, Task, User

new_version = Version(task=animation)
new_version.update_paths() # to render the naming convention template
new_version.extension = '.ma' # let's say that we have created under Maya
me = User.query.filter_by(name="Erkan Ozgur Yilmaz").first()
my_project = Project.query.filter_by(name="My Project").first()
query = Task.query.filter_by(project=my_project).filter(Task.resources.contains(me))
my_tasks = query.all()

Let's check how the version path is rendered:
You can further query let's say your WIP tasks by adding more criteria to the ``query``
object:

.. code-block:: python

assert new_version.absolute_full_path == \
"Z:/Projects/TP/SH001/Animation/SH001_Animation_Main_v001.ma"
assert new_version.version_number == 1

Create a new version and check that the version number increased automatically:

.. code-block:: python
from stalker import Status

new_version2 = Version(task=animation)
new_version2.update_paths() # to render the naming convention template
new_version2.extension = '.ma' # let's say that we have created under Maya
wip = Status.query.filter_by(code="WIP").first()
query = query.filter_by(status=wip)
my_wip_tasks = query.all()

assert new_version2.version_number == 2
and that's the way to get complex data in Stalker.

See more detailed example in `API Tutorial`_.
See more detailed examples in `API Tutorial`_.

.. _API Tutorial: https://pythonhosted.org/stalker/tutorial.html
Loading
Loading