Commit 3071662b authored by Niall McDaid's avatar Niall McDaid Committed by Niall McDaid
Browse files

Repository structure

parent 47089533
...@@ -9,6 +9,8 @@ ...@@ -9,6 +9,8 @@
- [Linting and Tests](#linting-and-tests) - [Linting and Tests](#linting-and-tests)
- [Architecture](#architecture) - [Architecture](#architecture)
- [Repository Structure](#repository-structure) - [Repository Structure](#repository-structure)
- [src](#src)
- [wbdutil](#wbdutil)
- [Branching and Merge Policies](#branching-and-merge-policies) - [Branching and Merge Policies](#branching-and-merge-policies)
- [Branching](#branching) - [Branching](#branching)
- [Merge Requests](#merge-requests) - [Merge Requests](#merge-requests)
...@@ -92,6 +94,19 @@ Include a listing of the purposes of modules in here. ...@@ -92,6 +94,19 @@ Include a listing of the purposes of modules in here.
## Repository Structure ## Repository Structure
### src
The `src` directory contains all the code and tests for this system.
Within the `src` folder:
- `wbdutil` directory - source code for the application
- `test` directory - unit tests for all modules within `wbdutil`
- `.flake8` file - flake8 linting configuration file
- `Pipfile` file - pipfile for managing virtual environment
#### wbdutil
The `wbdutil` contains the entry point for the command line application (`wbdutil.py`), a range of supporting modules and a `commands` directory.
All supporting modules are documented using docstrings. The `commands` directory includes a file for each top level command available to the user. Within these files all sub-commands are defined.
## Branching and Merge Policies ## Branching and Merge Policies
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment