Welcome to the Photon Documentation.

Photon Intro

It could be best described as a shell backend as python module

Contributions are highly welcome [1], also feel free to use the issue tracker if you encounter any problems.


The /examples directory contains some basic receipts on how to use Photon in your scripts.

Photon helps at Freifunk MWU to solve some tasks:


Photon is available as package on pypi, it is called photon_core [2].

You can install/update the package via pip3 [3]:

pip3 install photon_core
pip3 install -U photon_core


Development is still at an very early stage, expect anything to change any time.

pip3 install -U photon_core

To update to some alpha or beta version (see info file) use pip3 with the --pre switch.


Tags in the git repository will be released as a new pypi package version. Versions of a pypi package has always it’s git tag. And vice versa.

Not every version increase will be tagged/released. I will only do so if I feel the urge to do so.

[1]Teach me how to write good code, help me to improve.
[2]because photon itself was already taken :/
[3]Photon is written in python3 ~ be careful with easy_install


Photon aimes to be modular and can be divided into The core, it’s Utility and some Tools, provided through Photon itself.

If you just want to use Photon in your Scripts as a normal User you may especially be interested in the parts Photon and Tools.

I am lost:


The info file

The info file is not vital to Photon, it just helps to share common values between documentation and the package builder (setup file).[source]
Returns:The main author (last entry of contributors())
Returns:A list of all contributors
Returns:The contributors() as comma joined string[source]
Returns:Main author()‘s mail
Returns:The package name (on pypi)
Returns:Current release string
Returns:The repo url (on github)
Returns:Current version string
Current:0.5 (Release: 0.5a4)