FAIMS Tools is a collection of scripts to make module development easier. This readme outlines what's contained in each directory. Further information can often be found in individual readme files within directories.
Further instructions how to use FAIMS Tools and the autogen can be found in the User to Developer Instructions.
For information about FAIMS, visit the FAIMS Webpage or the FAIMS Mobile Platform User Guide. Alternatively, you can contact us at enquiries@fedarch.org and we will get back to you within one business day.
- formatter
- generators/christian
- module-dev-scripts
- userManagement
- generate.sh
- validate.sh
Software in this directory allows you to execute SQLite queries as they would be in the FAIMS app. In particular, formatter deals with format strings correctly, however it also allows queries which depend on spatialite to be run.
The most commonly used script is testFormat.sh. If testFormat.sh is given the path of a file containing a query as its first argument, another file will be created with that query's output. The file will be created in the current working directory.
A list of dependencies can be found in formatter's readme.
This folder contains the module autogenerator (also known as the "autogen"). The autogen produces
module definition files and wireframes from a single module.xml file.
The autogen can be invoked using the generate.sh and validate.sh scripts
found in the same directory as this readme (root directory of this repo).
This directory is for small scripts frequently used to ease development. In
includes upload.py, to upload modules and as.py to substitute arch16n values
into files. If you are not sure what this means, do not interact with this directory.
This is a collection of scripts which make it possible to manage user accounts
on a FAIMS server from a command-line interface. Illustrative examples of such
scripts are addUser.py to add a list of users to the server by one command and delUser.py to delete them, also using one command.
See generators/christian for details.
See generators/christian for details.