Project Files

Top Level Project Files and Directories

The project contains several directories and files. A brief description is provided in the table immediately below, for all the important files and folders.

File/Directory	Description
docs	Documentation for the library including class and function doc strings. The documents use the .rst format, are compiled using Sphinx and are hosted on the readthedocs.org website.
supplychainpy	This directory contains the main source code for the application.
tests	The unit and behavioural tests for the python and javascript application can be found here
.gitignore	The files and directories for git to ignore when commiting changes and pushing to the repository.
.travis.yml	Configuration file for Travis continous integration.
AUTHORS	Text File containing names of contributors (pretty lonely in here right now).
LICENSE	The BDS-3-Clause license.
LOG.txt	Provides the text required using .rst syntax for the PyPi repository documents page. Contains basic information and change logs.
MANIFEST.ini	Controls some of the files to include and exclude from the build process.
README.md	The repository readme file, responsible for the front page documentation on the repository.
dev_requirements.txt	All the requirements necessary to have a working development environment.
docker_requirements.txt	All the requirements necessary to have a working docker environment.
requirements.txt	All the requirements necessary to have a working environment to run the application
setup.py	The setup file to use with sdist.

Source Files and Directories

The next table provides a description of the files and folders found in the source code directory (files and folders inside the 'supplychainpy' directory).

File/Directory	Description
supplychainpy/model_inventory.py	Public module for performing inventory analysis: `from supplychainpy.model_inventory import analyse`