This is used to generate the specifications from a CA (Capability Architect) database in Markdown form. Since CA uses a Microsoft Access Database (.accdb) which is a flat-file database, the .accdb file can be moved into this repository, where it's data can be extracted.

This generator only works on Windows due to a lack of support for .accdb files which is what CA uses. Assuming you are on windows and have python + pip installed, run the following commands in command prompt to set up the dependencies.

# Install virtual environment
pip install venv

# Create virtual environment
python -m venv env

# Start virtual environment
.\env\Scripts\activate.bat

# Install dependencies
pip install -r requirements.txt

To get the automatic pdf generation, you will have to install wkhtmltopdf here. Else you can always manually convert from markdown to pdfs. Note that the pdf files are ignored by git as their file sizes are larger than your typical text file.

To create the documentation, run the following command, which will save the updated spec in md-specs/. Note the <database name> is an optional command line argument which defaults to database.accdb. Currently database.accdb is the database to be used for SS8, whilst database2.accdb is the one used for SS7.

python main.py <database name>

The database name is an optional positional argument. If no command line arguments are given, then it will connect to database.accdb.

I.e. python main.py database2.accdb -vp -p will generate the verification packages documents in pdf form as well for the database database2.accdb.

The requirements can be found in "System Requirement" categorised by department.

The table below explains the metadata.