c-bik / io-template-app

Template for Application Repositories

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

IO-TEMPLATE-APP - Template for Application Repositories

This repository is a sample repository for developing Python related IO-Aero applications.

Documentation

The complete documentation for this repository is contained in the GitHub pages here. See that documentation for installation instructions

Further IO-Aero software documentation can be found under the following links.

Directory and File Structure of this Repository

1. Directories

Directory Content
.github/workflows GitHub Action workflows.
.vscode Visual Studio Code configuration files.
data Application data related files.
dist Dynamic link library version of IO-TEMPLATE-APP.
docs Documentation files.
examples Scripts for examples and special tests.
iotemplateapp Python script files.
libs Contains libraries that are not used via pipenv.
resources Selected manuals and software.
scripts Scripts supporting macOS, Ubuntu and Windows.
tests Scripts and data for examples and tests.

2. Files

File Functionality
.act_secrets_template Template file for the configuration of make action.
.gitattributes Handling of the os-specific file properties.
.gitignore Configuration of files and folders to be ignored.
.pylintrc pylint configuration file.
.settings.io_aero_template.toml Template file for the secret configuration data.
LICENSE.md Text of the licence terms.
logging_cfg.yaml Configuration of the Logger functionality.
Makefile Tasks to be executed with the make command.
Pipfile Definition of the Python package requirements.
pyproject.toml Optional configuration data for the software quality tools.
README.md This file.
run_io_template_app Main script for using the functionality of IO-TEMPLATE-APP.
run_io_template_app_pytest Main script for using the test functionality of IO-TEMPLATE-APP.
settings.io_aero.toml Configuration data.
setup.cfg Configuration data.

About

Template for Application Repositories

License:Other


Languages

Language:Shell 42.0%Language:Python 25.2%Language:Makefile 20.4%Language:Batchfile 12.4%