Photon

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.

Repository:github.com/spookey/photon Documentation:photon.readthedocs.org Package:pypi.python.org/pypi/photon_core

Examples

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

Photon helps at Freifunk MWU to solve some tasks:

• See our collection of backend-scripts for some scripts using photon, running in production.
• To automatically compile gluon firmware for routers, we wrote the gluon builder.

Installation

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

Bleeding-Edge

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.

Versions

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

Structure

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.

• The core
  • Settings
  • Meta
  • Photon
• Tools
  • Git Tool
  • Mail Tool
  • Ping Tool
  • Signal Tool
  • Template Tool
• Utility
  • Files
  • Locations
  • Structures
  • System

I am lost:

• Index
• Module Index
• Search Page

Info

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).

info.author()

Returns:The main author (last entry of contributors())

info.contributors()

Returns:A list of all contributors

info.contributors_str()

Returns:The contributors() as comma joined string

info.email()

Returns:Main author()‘s mail

info.pkg_name()

Returns:The package name (on pypi)

info.release()

Returns:Current release string Current:0.5a4

info.url()

Returns:The repo url (on github)

info.version()

Returns:Current version string Current:0.5 (Release: 0.5a4)