Skip to content

Latest commit

 

History

History
101 lines (71 loc) · 3 KB

README.rst

File metadata and controls

101 lines (71 loc) · 3 KB
Raw

FTN Tools for Python

Python-ftn is an API and suite of tools for manipulating FTN message and packet data. The package currently includes tools for:

  • Generating FTN messages.
  • Editing message data.
  • Displaying and querying message data.
  • Packing/unpacking FTN mail packets.
  • Editing packet data.
  • Displaying and querying packet data.
  • Parsing and querying FTN nodelists.
  • Making routing decsisions from nodelist data.

The python-ftn API makes it easy to develop new tools that interact with FTN format data.

Python-ftn support FTS-0001 "on disk" and "packed" messages (and can convert between them), and supports both FTS-0001 ("type 2") and FSC-0048 ("type 2+") packets.

Documentation is available online at:

Requirements

This software requires the following Python modules:

  • bitstring -- for reading/writing binary formats.
  • sqlite3 -- for interacting with SQLite databases.

Installation

Install this package by running setup.py:

python setup.py install

Configuration

Many of the tools in this package read configuration information from a file named ftn.cfg, which is by default found in /etc/ftn/ftn.cfg. You can change this default in the following ways:

  • Use the -f command line option to provide an explicit path to a configuration file.
  • Set the FTN_CONFIG_DIR environment variable. The python-ftn tools will look in this directory for ftn.cfg and other config files.
  • Set the FTN_CONFIG_FILE environment variable. The python-ftn tools will use this file, but continue to look for other files in FTN_CONFIG_DIR or /etc/ftn.

Reporting bugs

If you would like to report bugs or make a feature request, please use the project issue tracker:

Author

Python-ftn was written by Lars Kellogg-Stedman.

License

Python-ftn is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this software. If not, see <http://www.gnu.org/licenses/>.

Fido, FidoNet and the dog-with-diskette are registered trademarks of Tom Jennings, San Francisco California, USA.