https://github.com/spookey/ffflash

FreiFunk File nodeList And Sidecar Helper
https://github.com/spookey/ffflash

Last synced: about 2 months ago
JSON representation

FreiFunk File nodeList And Sidecar Helper

• Host: GitHub
• URL: https://github.com/spookey/ffflash
• Owner: spookey
• License: bsd-3-clause
• Created: 2014-04-30T11:05:48.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2021-01-19T13:24:13.000Z (almost 4 years ago)
• Last Synced: 2023-03-27T12:07:46.559Z (over 1 year ago)
• Language: Python
• Homepage: http://ffflash.readthedocs.org
• Size: 130 KB
• Stars: 2
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
FFFlash

=======

This Program helps to manage `Freifunk APIfiles `_.

To use it you need an existing APIfile.

`Create one here `_ if necessary.

Commandline

-----------

There is no configuration.

Everything **ffflash** needs to know is passed each time as shell parameters.

(It's not much).

-  To get help, use ``ffflash.py -h``::

    usage: ffflash [-h] [-s SIDECARS [SIDECARS ...]] [-n NODELIST] [-r RANKFILE]

               [-rc RANKCLIENTS] [-rf RANKOFFLINE] [-rn RANKONLINE]

               [-rp RANKPOSITION] [-rw RANKWELCOME] [-d] [-v]

               APIfile

-  You always need to pass the location to your ``APIfile``.

-  ``--nodelist`` or ``-n`` expects the full url of your ``nodelist.json``

   file, generated by the

   `ffmap-backend `_.

-  Do some number crunching and store the *scores* in the ``--rankfile``.

   (Only works if passed together with an ``--nodelist``).

    -  ``--rankwelcome`` sets the initial *score* to start with.

    -  ``--rankposition`` increases *score* by that value if any location data is

       provided.

    -  ``--rankonline`` increases *score* by that value if node is online.

    -  ``--rankoffline`` decreases *score* by that value if node is offline.

    -  ``--rankclients`` increases *score* per client by that value.

-  Pass one or more ``--sidecars`` (or ``-s``) to merge content from there

   into the APIfile.

-  Use ``--dry`` (or ``-d``) to preview all changes.

   Then, nothing is written to the APIfile!

-  If both ``-s`` and ``-n`` are omitted, no action is taken.

   So to just display your APIfile you could use this::

    ffflash.py /path/to/your/ffapi_file.json -d

   (makes no sense anyway, better use ``cat``)

-  The ``--verbose`` (or ``-v``) switch just displays more information.