Skip to main content

riotgen: generator for RIOT source code.

Project description

CI status codecov riotgen version

riotgen is a command line interface helper tool that is used to bootstrap RIOT source files for standalone applications, board supports, driver modules, system modules, packages and example/test applications.

Installation

Install riotgen using pip:

pip install riotgen

Installing from source

Clone this repository:

git clone git://github.com/aabadie/riot-generator.git

Install using pip from the source directory:

cd riot-generator
pip install .

Usage

riotgen uses subcommands for generating the code for applications, tests, packages and board support:

riotgen --help
Usage: riotgen [OPTIONS] COMMAND [ARGS]...

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  application  Bootstrap a RIOT application
  board        Bootstrap a RIOT board support
  driver       Bootstrap a RIOT driver module
  example      Bootstrap a RIOT example application
  module       Bootstrap a RIOT system module
  pkg          Bootstrap a RIOT external package
  test         Bootstrap a RIOT test application

Examples

Generate an application in the current directory that build against the RIOT source located in /opt/RIOT and using the interactive wizzard:

riotgen application -i -r /opt/RIOT

or:

RIOTBASE=/opt/RIOT riotgen application -i

The command line wizard will ask for questions about the new application: target board, RIOT base directory, author name, etc.

Generate an application using a configuration file (see the samples provided in the source code):

riotgen application --riotbase /opt/RIOT --config path/to/config/file.cfg

In both cases, once complete, the new application can be built using:

make

example, driver, module, pkg, test and board subcommands generate the skeleton code directly in the RIOT base directory:

riotgen example --riotbase /opt/RIOT -i
riotgen driver --riotbase /opt/RIOT -i
riotgen module --riotbase /opt/RIOT -i
riotgen pkg --riotbase /opt/RIOT -i
riotgen board --riotbase /opt/RIOT -i
riotgen test --riotbase /opt/RIOT -i

Testing

Testing is performed using the Tox automation tool. You can install Tox using pip:

pip install tox

To run the whole tests and checks, use:

tox

To only run the tests, use:

tox -e tests

To only run the static checks (flake8, black, twine --check), use:

tox -e check

To reformat your code following the black tool, use:

tox -e format

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

riotgen-0.12.0.tar.gz (24.6 kB view details)

Uploaded Source

Built Distribution

riotgen-0.12.0-py3-none-any.whl (37.2 kB view details)

Uploaded Python 3

File details

Details for the file riotgen-0.12.0.tar.gz.

File metadata

  • Download URL: riotgen-0.12.0.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for riotgen-0.12.0.tar.gz
Algorithm Hash digest
SHA256 f845169e2525f67b9366db11feaa5a8f70908c60aafdc10661efc268a33d4f8a
MD5 f6f3fba569943633d23d1896fb891058
BLAKE2b-256 57e6ee000b45a41a9a56dc108ce3aa0e5dc57b1804c68781e3350d974f5ffa02

See more details on using hashes here.

File details

Details for the file riotgen-0.12.0-py3-none-any.whl.

File metadata

  • Download URL: riotgen-0.12.0-py3-none-any.whl
  • Upload date:
  • Size: 37.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for riotgen-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 32f34da7ee4a9360792c0be91d4498cca4e259b93745eb1f358ed34d5bec2f7e
MD5 593fff4836e060c54962a26acd75b2e6
BLAKE2b-256 d864d19158e2c7834740a6185a9e813c370f9f9462d3f489c056fca8940ad209

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page