https://github.com/spookey/photon

shell backend as python module
https://github.com/spookey/photon

Last synced: 3 months ago
JSON representation

shell backend as python module

• Host: GitHub
• URL: https://github.com/spookey/photon
• Owner: spookey
• License: bsd-3-clause
• Created: 2014-09-20T07:47:07.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-11-19T10:58:27.000Z (about 9 years ago)
• Last Synced: 2023-03-27T12:07:49.387Z (almost 2 years ago)
• Language: Python
• Homepage: http://photon.readthedocs.org/
• Size: 157 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        

Photon Intro

------------

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

Contributions are highly welcome [#contributions]_, 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`` [#photon_core]_.

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

.. code-block:: sh

    pip3 install photon_core

.. code-block:: sh

    pip3 install -U photon_core

.. topic:: Bleeding-Edge

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

    any time.

    .. code-block:: sh

        pip3 install -U photon_core

    To update to some alpha or beta version (see *info* file)

    use *pip3* with the ``--pre`` switch.

.. topic:: 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.

.. [#contributions] Teach me how to write good code, help me to improve.

.. [#photon_core] because photon itself was already taken :/

.. [#pip3] Photon is written in python3 ~ be careful with easy_install