joaomcteixeira / tree-of-life

A Python-written and stand-alone library to setup Python-based user-oriented scientific projects.

Tree-of-Life

Tree-of-Life is a Python-written and stand-alone library that installs the Python dependencies, configures the executable files and provides an updating interface for Python-based projects oriented for non-developer users. Reducing the task of installation and updating to simple double-click operations (something that was so common in the past but which is becoming rare to find in most Scientific softwares today).

As the name implies, it provides a tree of routines that give life to your project (inside user's computers) :-).

Vision

Read here about the complete motivation and vision behind Tree-of-Life.

Projects which have adopted Tree-of-Life

Hosting Tree-of-Life in a project does not prevent it being available through other sources, such as, Conda packages or PiPy. Some Scientific projects already use Tree-of-Life to manage their installation and updating routines:

• Farseer-NMR
• Tauren-MD

How to implement Tree-of-Life in your projects

If you are a software developer with Python-based or Python-dependent projects, and you wish to know how to implement Tree-of-Life in your project, find all information in our Wiki page or docs folder. Implementing Tree-of-Life is almost as easy as copy+pasting a folder ;-).

LICENSE

Tree-of-Life is licensed under LGPL version 3, and you are allowed to modify and use it according to this license terms.

tree-of-life's Issues

[DEVELOPMENT] Separate Banner from messages.py

Separate banner from messages.py. This will allows users to directly copy+paste messages.py to the latest version without replacing the host project banner.

Add banner to host_project_vars.py.

[DEVELOPMENT] Separate Host Projects variables completely from Tree-of-life libs

Currently developing this issue.

Host project specific libraries are stored inside system lib. They should be transferred to a separate file so that update of Tree-of-Life in host projects is facilitated.

follow development progress in branch

[DEVELOPMENT] Separate shebang from executable files.

Separate shebang from executable files.

Shebangs are inserted into executable files via string .format()method. The current implementation hinders the usage of {} in the executable raw strings because of IndexError: tuple index out of range.

To solve this, shebang should be separated to a different variable. In this way, shebang is placed during commons.create_executables() via executables.shebang.format(python_exec) and the executable code (raw string) is appended to generate the executable python file, avoiding IndexError.