https://github.com/dbrgn/fahrplan

A SBB/CFF/FFS commandline based timetable client. Project started at make.opendata.ch.
https://github.com/dbrgn/fahrplan

Last synced: about 2 months ago
JSON representation

A SBB/CFF/FFS commandline based timetable client. Project started at make.opendata.ch.

• Host: GitHub
• URL: https://github.com/dbrgn/fahrplan
• Owner: dbrgn
• License: gpl-3.0
• Created: 2012-03-30T16:30:31.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2023-12-02T13:26:39.000Z (10 months ago)
• Last Synced: 2024-07-12T01:32:52.677Z (2 months ago)
• Language: Python
• Homepage:
• Size: 575 KB
• Stars: 129
• Watchers: 8
• Forks: 19
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
fahrplan

========

.. image:: https://github.com/dbrgn/fahrplan/actions/workflows/CI/badge.svg

    :alt: Build status

    :target: https://github.com/dbrgn/fahrplan/actions

Goal: Simple access to the SBB/CFF/FFS timetable service from the command line with human

readable argument parsing.

Relies on the public transport API by opendata.ch: http://transport.opendata.ch/

Fahrplan supports Python 3.9+.

Installing

----------

To install the current version using pip, issue::

    $ sudo pip install fahrplan

To install from this repository, clone it and use::

    $ python setup.py fahrplan

Usage

-----

``fahrplan --help``::

    usage: fahrplan [--full] [--info] [--debug] [--help] [--version]

		    [--proxy PROXY]

		    ...

    A SBB/CFF/FFS commandline based timetable client.

    positional arguments:

      request

    optional arguments:

      --full, -f            Show full connection info, including changes

      --info, -i            Verbose output

      --debug, -d           Debug output

      --help, -h            Show this help

      --version, -v         Show version number

      --proxy PROXY, -p PROXY

			    Use proxy for network connections (host:port)

    Arguments:

     You can use natural language arguments using the following

     keywords in your desired language:

     en -- from, to, via, departure, arrival

     de -- von, nach, via, ab, an

     fr -- de, à, via, départ, arrivée

     You can also use natural time and date specifications in your language, like

     - "now", "immediately", "at noon", "at midnight",

     - "tomorrow", "monday", "in 2 days", "22/11".

    Examples:

     fahrplan from thun to burgdorf

     fahrplan via bern nach basel von zürich, helvetiaplatz ab 15:35

     fahrplan de lausanne à vevey arrivée minuit

     fahrplan from Bern to Zurich departure 13:00 monday

     fahrplan -p proxy.mydomain.ch:8080 de lausanne à vevey arrivée minuit

.. image:: https://raw.github.com/dbrgn/fahrplan/master/screenshot.png

    :alt: Screenshot

Testing

-------

Testing is done using tox and nosetests.

To run the tests on supported Python versions::

    $ ./test.sh

Sourcecode

----------

The sourcecode is available on Github: https://github.com/dbrgn/fahrplan

License

-------

The code is licensed as GPLv3. See `LICENSE` file for more details.