This is an attempt to re-write the official TRA VFD's API in a developer friendly way.

Overview

TRA VFD API Documentation

This is an attempt to re-write the official TRA VFD's API in a developer friendly way.

The current documentation is written in PDF which makes it difficult to work on and hard to browse through the documentation.

This is an attempt to make it easier for developers to work on this new & exciting API.

A lot of effort was spent to make this as accurate as possible, However, If there is any error/confusion please refer to the original documents.

Contributions

This documentation is created using mkdocs therefore in order run it locally you need to have python, pip and ofcourse mkdocs installed

Using venv

virtualenv venv
source venv/bin/activate
pip install -r requirements.txt

Start the live-reloading docs server.

mkdocs serve

Now you can view the documentation by just going to http://localhost:8000

Licence

MIT

Contributing

If you want to help, just fork the repo and make changes and submit a Pull request.

Issues
  • chore(deps): update dependency pymdown-extensions to v9 - autoclosed

    chore(deps): update dependency pymdown-extensions to v9 - autoclosed

    WhiteSource Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | pymdown-extensions | ==8.2 -> ==9.0 | age | adoption | passing | confidence |


    Release Notes

    facelessuser/pymdown-extensions

    v9.0

    Compare Source

    9.0

    Please see Migration Notes for details on upgrading to 9.0.

    • NEW: Arithmatex: Wrap MathJax "script" format (non-preview) with a container element just like all other Arithmatex output formats.
    • NEW: Arithmatex: MathJax (non-generic) form's container element now has the arithmatex class added just like everywhere else.
    • NEW: Arithmatex: Add options to override HTML element container type of inline and block math.
    • NEW: Arithmatex: Add new formatter functions intended to replace old math fenced/inline block formatters. New formatter functions are configurable. All others are marked as deprecated and will be removed at some future date.
    • NEW: Emoji: Upgraded Twitter emoji database to support latest emoji. It is a known issue that Twitter has :man_in_santa_hat: and :mx_claus: backwards -- same for :mrs_claus: and :woman_in_santa_hat:. That is on Twitter's side, not ours.
    • NEW: Highlight: Add support for the Pygments option linespans.
    • NEW: Highlight: Add support for Pygments option lineanchors.
    • NEW: Highlight: Add support for Pygments option anchorlinenos.
    • NEW: Highlight: Remove legacy_no_wrap_code option.
    • NEW: Add support for generating title headers pulled from the Pygments lexer for code blocks. Feature can be enabled via the new auto_title option. If a specific name is not preferred, these names can be overridden via a user defined mapping called auto_title_map.
    • NEW: SuperFences: Allow setting a title, or overriding an auto title via the new title option in a fenced code header.
    • NEW: SuperFences: Allow adding ID and arbitrary data- attributes on Pygments code blocks. The latter requires the attr_list extension to be enabled.
    • NEW: SuperFences: Removed old deprecated option highlight_code which no longer did anything.
    • NEW: SuperFences: Remove legacy code meant to help with transitioning to new custom fence function format.
    • NEW: Tabbed: New alternate style that allows for a scrollable tabs if they overflow. Feature is experimental, see docs for more information.
    • NEW: Slugs: Add new configurable slugify function that aims to replace all other slugify methods. Deprecate uslugify, uslugify_encoded, uslugify_case, uslugify_case_encoded, gfm, and gfm_encoded. slugify takes parameters returning a function that performs the desired slug handling. slugify adds new options case="fold" for case folding and normalize='<normalize format here>' (uses NFC by default).
    • FIX: BetterEm: Fix some complex cases related to "smart" logic. (#​1413)
    • FIX: EscapeAll: Fix issue where an escaped HTML entity may end up with incorrect slug and incorrect table of content entry.
    • FIX: Highlight: Fix issue that occurs when showing only nth line numbers and using pymdownx-inline. Lines not showing a line number would not render with the proper leading space.

    Configuration

    πŸ“… Schedule: At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    β™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    πŸ”• Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box.

    This PR has been generated by WhiteSource Renovate. View repository job log here.

    opened by renovate[bot] 1
  • chore(deps): update dependency pymdown-extensions to v9

    chore(deps): update dependency pymdown-extensions to v9

    WhiteSource Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | pymdown-extensions | ==8.2 -> ==9.0 | age | adoption | passing | confidence |


    Release Notes

    facelessuser/pymdown-extensions

    v9.0

    Compare Source

    9.0

    Please see Migration Notes for details on upgrading to 9.0.

    • NEW: Arithmatex: Wrap MathJax "script" format (non-preview) with a container element just like all other Arithmatex output formats.
    • NEW: Arithmatex: MathJax (non-generic) form's container element now has the arithmatex class added just like everywhere else.
    • NEW: Arithmatex: Add options to override HTML element container type of inline and block math.
    • NEW: Arithmatex: Add new formatter functions intended to replace old math fenced/inline block formatters. New formatter functions are configurable. All others are marked as deprecated and will be removed at some future date.
    • NEW: Emoji: Upgraded Twitter emoji database to support latest emoji. It is a known issue that Twitter has :man_in_santa_hat: and :mx_claus: backwards -- same for :mrs_claus: and :woman_in_santa_hat:. That is on Twitter's side, not ours.
    • NEW: Highlight: Add support for the Pygments option linespans.
    • NEW: Highlight: Add support for Pygments option lineanchors.
    • NEW: Highlight: Add support for Pygments option anchorlinenos.
    • NEW: Highlight: Remove legacy_no_wrap_code option.
    • NEW: Add support for generating title headers pulled from the Pygments lexer for code blocks. Feature can be enabled via the new auto_title option. If a specific name is not preferred, these names can be overridden via a user defined mapping called auto_title_map.
    • NEW: SuperFences: Allow setting a title, or overriding an auto title via the new title option in a fenced code header.
    • NEW: SuperFences: Allow adding ID and arbitrary data- attributes on Pygments code blocks. The latter requires the attr_list extension to be enabled.
    • NEW: SuperFences: Removed old deprecated option highlight_code which no longer did anything.
    • NEW: SuperFences: Remove legacy code meant to help with transitioning to new custom fence function format.
    • NEW: Tabbed: New alternate style that allows for a scrollable tabs if they overflow. Feature is experimental, see docs for more information.
    • NEW: Slugs: Add new configurable slugify function that aims to replace all other slugify methods. Deprecate uslugify, uslugify_encoded, uslugify_case, uslugify_case_encoded, gfm, and gfm_encoded. slugify takes parameters returning a function that performs the desired slug handling. slugify adds new options case="fold" for case folding and normalize='<normalize format here>' (uses NFC by default).
    • FIX: BetterEm: Fix some complex cases related to "smart" logic. (#​1413)
    • FIX: EscapeAll: Fix issue where an escaped HTML entity may end up with incorrect slug and incorrect table of content entry.
    • FIX: Highlight: Fix issue that occurs when showing only nth line numbers and using pymdownx-inline. Lines not showing a line number would not render with the proper leading space.

    Configuration

    πŸ“… Schedule: "before 3am on Monday" (UTC).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    β™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    πŸ”• Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box.

    This PR has been generated by WhiteSource Renovate. View repository job log here.

    opened by renovate[bot] 1
  • chore(deps): update all dependencies

    chore(deps): update all dependencies

    WhiteSource Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | click (changelog) | ==8.0.1 -> ==8.0.3 | age | adoption | passing | confidence | | joblib | ==1.0.1 -> ==1.1.0 | age | adoption | passing | confidence | | mkdocs-material | ==7.3.1 -> ==7.3.3 | age | adoption | passing | confidence | | regex | ==2021.9.24 -> ==2021.10.8 | age | adoption | passing | confidence | | watchdog (changelog) | ==2.1.5 -> ==2.1.6 | age | adoption | passing | confidence | | zipp | ==3.5.1 -> ==3.6.0 | age | adoption | passing | confidence |


    Release Notes

    gorakhargosh/watchdog

    v2.1.6

    Compare Source

    • [bsd] Fixed returned paths in kqueue.py and restored the overall results of the test suite. (#​842)
    • [bsd] Updated FreeBSD CI support .(#​841)
    • [watchmedo] Removed the argh dependency in favor of the builtin argparse module. (#​836)
    • [watchmedo] Removed unexistant WindowsApiAsyncObserver references and --debug-force-winapi-async arguments.
    • [watchmedo] Improved the help output.

    :heart_decoration: Thanks to our beloved contributors: @​knobix, @​AndreaRe9, @​BoboTiG

    jaraco/zipp

    v3.6.0

    Compare Source

    ======

    #​78: Only Path is exposed in the public API.


    Configuration

    πŸ“… Schedule: "before 3am on Monday" (UTC).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    β™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    πŸ‘» Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.


    • [ ] If you want to rebase/retry this PR, check this box.

    This PR has been generated by WhiteSource Renovate. View repository job log here.

    opened by renovate[bot] 1
  • chore(deps): update dependency click to v8.0.3 - autoclosed

    chore(deps): update dependency click to v8.0.3 - autoclosed

    WhiteSource Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | click (changelog) | ==8.0.1 -> ==8.0.3 | age | adoption | passing | confidence |


    Configuration

    πŸ“… Schedule: At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    β™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    πŸ”• Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box.

    This PR has been generated by WhiteSource Renovate. View repository job log here.

    opened by renovate[bot] 1
  • chore(deps): update dependency joblib to v1.1.0 - autoclosed

    chore(deps): update dependency joblib to v1.1.0 - autoclosed

    WhiteSource Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | joblib | ==1.0.1 -> ==1.1.0 | age | adoption | passing | confidence |


    Configuration

    πŸ“… Schedule: At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    β™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    πŸ”• Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box.

    This PR has been generated by WhiteSource Renovate. View repository job log here.

    opened by renovate[bot] 1
  • chore(deps): update dependency mkdocs-material to v7.3.2 - autoclosed

    chore(deps): update dependency mkdocs-material to v7.3.2 - autoclosed

    WhiteSource Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | mkdocs-material | ==7.3.1 -> ==7.3.2 | age | adoption | passing | confidence |


    Configuration

    πŸ“… Schedule: At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    β™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    πŸ”• Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box.

    This PR has been generated by WhiteSource Renovate. View repository job log here.

    opened by renovate[bot] 1
  • chore(deps): update dependency jinja2 to v3.0.2

    chore(deps): update dependency jinja2 to v3.0.2

    WhiteSource Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | Jinja2 (changelog) | ==3.0.1 -> ==3.0.2 | age | adoption | passing | confidence |


    Configuration

    πŸ“… Schedule: At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    β™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    πŸ”• Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box.

    This PR has been generated by WhiteSource Renovate. View repository job log here.

    opened by renovate[bot] 1
  • chore(deps): update dependency mkdocs-material to v7.3.1

    chore(deps): update dependency mkdocs-material to v7.3.1

    WhiteSource Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | mkdocs-material | ==7.3.0 -> ==7.3.1 | age | adoption | passing | confidence |


    Configuration

    πŸ“… Schedule: At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    β™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    πŸ”• Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box.

    This PR has been generated by WhiteSource Renovate. View repository job log here.

    opened by renovate[bot] 1
  • chore(deps): update dependency pytz to v2021.3

    chore(deps): update dependency pytz to v2021.3

    WhiteSource Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | pytz | ==2021.1 -> ==2021.3 | age | adoption | passing | confidence |


    Configuration

    πŸ“… Schedule: At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    β™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    πŸ”• Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box.

    This PR has been generated by WhiteSource Renovate. View repository job log here.

    opened by renovate[bot] 1
  • chore(deps): update dependency watchdog to v2.1.6 - autoclosed

    chore(deps): update dependency watchdog to v2.1.6 - autoclosed

    WhiteSource Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | watchdog (changelog) | ==2.1.5 -> ==2.1.6 | age | adoption | passing | confidence |


    Release Notes

    gorakhargosh/watchdog

    v2.1.6

    Compare Source

    • [bsd] Fixed returned paths in kqueue.py and restored the overall results of the test suite. (#​842)
    • [bsd] Updated FreeBSD CI support .(#​841)
    • [watchmedo] Removed the argh dependency in favor of the builtin argparse module. (#​836)
    • [watchmedo] Removed unexistant WindowsApiAsyncObserver references and --debug-force-winapi-async arguments.
    • [watchmedo] Improved the help output.

    :heart_decoration: Thanks to our beloved contributors: @​knobix, @​AndreaRe9, @​BoboTiG


    Configuration

    πŸ“… Schedule: At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    β™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    πŸ”• Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box.

    This PR has been generated by WhiteSource Renovate. View repository job log here.

    opened by renovate[bot] 1
Releases(1.0.1)
  • 1.0.1(Sep 23, 2021)

    Updates

    • chore(deps): update dependency mkdocs-material to v7.3.0 #8
    theer minor deps bumps?

    updates

    • chore(deps): update dependency tqdm to v4.62.3 #7
    • chore(deps): update dependency nltk to v3.6.3 #6
    • chore(deps): update dependency mkdocs-material to v7.2.8 #5
    • chore(deps): update dependency gitpython to v3.1.24 #4
    • chore(deps): update dependency mkdocs-material to v0.2.4 #2
    • chore(deps): update dependency lunr to v0.6.0
    Source code(tar.gz)
    Source code(zip)
  • 1.0.0(Sep 12, 2021)

Owner
Alpha Olomi
Software Engineer, Laravel, Nextjs, React.js, Python, ML, Opensource,,
Alpha Olomi
Single file PHP script that adds a REST API to a SQL database

PHP-CRUD-API Single file PHP script that adds a REST API to a MySQL/MariaDB, PostgreSQL, SQL Server or SQLite database. NB: This is the TreeQL referen

Maurits van der Schee 2.9k Oct 18, 2021
Open source API management platform

About Fusio is an open source API management platform which helps to build and manage REST APIs. Fusio provides all tools to quickly build an API from

Apioo 1k Oct 17, 2021
Simple and effective multi-format Web API Server to host your PHP API as Pragmatic REST and / or RESTful API

Luracast Restler ![Gitter](https://badges.gitter.im/Join Chat.svg) Version 3.0 Release Candidate 5 Restler is a simple and effective multi-format Web

Luracast 1.3k Oct 14, 2021
AWS Cognito package using the AWS SDK for PHP/Laravel

Laravel Package to manage Web and API authentication with AWS Cognito AWS Cognito package using the AWS SDK for PHP This package provides a simple way

EllaiSys 23 Oct 14, 2021
Ariama Victor (A.K.A. OVAC4U) 80 Oct 17, 2021
Fully unit tested Facebook SDK v5 integration for Laravel & Lumen

Laravel Facebook SDK A fully unit-tested package for easily integrating the Facebook SDK v5 into Laravel and Lumen 5.0, 5.1, 5.2, & 5.3. This is packa

Sammy Kaye Powers 699 Oct 7, 2021
Create REST and GraphQL APIs, scaffold Jamstack webapps, stream changes in real-time.

API Platform is a next-generation web framework designed to easily create API-first projects without compromising extensibility and flexibility: Desig

API Platform 7k Oct 23, 2021
The efficient and elegant JSON:API 1.1 server library for PHP

Woohoo Labs. Yin Woohoo Labs. Yin is a PHP framework which helps you to build beautifully crafted JSON:APIs. Table of Contents Introduction Features W

Woohoo Labs. 224 Oct 9, 2021
Laravel A2Reviews Client API lets you build apps, extensions, or plugins to get reviews from the A2reviews APP.

Overview Laravel A2Reviews Client API lets you build apps, extensions or plugins to get reviews from the A2reviews APP. Including adding reviews to a

Be Duc Tai 2 Sep 26, 2021
A PHP library to support implementing representations for HATEOAS REST web services.

Hateoas A PHP library to support implementing representations for HATEOAS REST web services. Installation Working With Symfony Usage Introduction Conf

William Durand 981 Oct 1, 2021
The efficient and elegant, PSR-7 compliant JSON:API 1.1 client library for PHP

Woohoo Labs. Yang Woohoo Labs. Yang is a PHP framework which helps you to communicate with JSON:API servers more easily. Table of Contents Introductio

Woohoo Labs. 154 Sep 21, 2021
Courier API adalah project API untuk mengetahui ongkos kirim Logistik-logistik pengiriman barang antar kota & International

Courier API Courier API adalah project API untuk mengetahui ongkos kirim Logistik-logistik pengiriman barang antar kota (dalam negeri) & International

Rangga Darmajati 2 Sep 24, 2021
Zoho CRM API SDK is a wrapper to Zoho CRM APIs. By using this sdk, user can build the application with ease

Archival Notice: This SDK is archived. You can continue to use it, but no new features or support requests will be accepted. For the new version, refe

null 77 Sep 14, 2021
A simple way of authenticating your RESTful APIs with API keys using Laravel

ApiGuard This package is no longer maintained This package is no longer maintained as Laravel already has a similar feature built-in since Laravel 5.8

Chris Bautista 690 Sep 12, 2021
This API provides functionality for creating and maintaining users to control a simple To-Do-List application. The following shows the API structure for users and tasks resources.

PHP API TO-DO-LIST v.2.0 This API aims to present a brief to consume a API resources, mainly for students in the early years of Computer Science cours

Edson M. de Souza 1 Oct 23, 2021
pedre-response is a standard structure of json response

PedreResponse It's very important to use same structure for responses in large projects that PedreResponse package can do it for you. PedreResponse is

Pedram Rezaei 2 Oct 22, 2021
Laravel wrapper for Facebook's GraphQL

Laravel GraphQL Use Facebook's GraphQL with Laravel 6.0+. It is based on the PHP port of GraphQL reference implementation. You can find more informati

Mikk Mihkel Nurges 1.7k Oct 21, 2021
A RESTful API package for the Laravel and Lumen frameworks.

The Dingo API package is meant to provide you, the developer, with a set of tools to help you easily and quickly build your own API. While the goal of

null 9.2k Oct 14, 2021
A PHP library for the CoinMarketCap API designed to be easy to use.

Help wanted: I don't have enough time to keep updating this library, if you can, don't be shy. Pull requests are welcome. PHP CoinMarketCap API This p

Shahrad Elahi 4 Sep 6, 2021