RAPIDS Apprentice Upload Specification

This specification aims to standardize and validate the apprentice data that will be uploaded into the RAPIDS system. It provides documentation and guidelines to ensure data consistency and integrity.

Table of Contents

• Installation
• Documentation
• Getting Help

Installation

To set up the project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/csg-org/rapids-apprentice-upload-spec.git

2. Navigate to the project directory:

   cd rapids-apprentice-upload-spec

3. Install dependencies using pipenv:

   pipenv install

Documentation

This project uses Sphinx for documentation. To build the documentation locally, follow these steps:

1. Refresh any changes to the data fields from the tableschema

   pipenv run python docs/update.py > docs/source/fields.inc

2. Start auto-building the docs

   pipenv run sphinx-autobuild docs/source docs/build

3. Open the generated HTML files in your browser: Open http://127.0.0.1:8000 in your browser

Getting Help

If you encounter any issues or have questions, feel free to open an issue on the GitHub repository.