Skybeard Enhancement Proposal (SEP) #1: Proposed file structure for beards

Introduction

Owing to the fact that beards are growing quite fast now, and may include more than just python. I propose the following file structure (in this example for a beard called mybeard).

$ tree --dirsfirst mybeard
mybeard
├── python
│   └── mybeard
│       ├── __init__.py
│       └── mybeard.py
├── tests
├── requirements.dev.txt
├── requirements.txt
└── setup_beard.py

3 directories, 5 files

Various files

python folder

This folder will be the one added to the PYTHONPATH when the beard is imported. All python parts of the beard should be put in here.

tests folder

This folder should contain unit tests.

NOTE: I'm not sure this should only be python or js? Or maybe only test js by using python?

requirements.txt and requirements.dev.txt

Ordinary requirements files.

setup_beard.py

This would be a setup script for beards. It would probably contain instructions for installing requirements, how to update, etc..

Extensions

This would allow easy extension to include other languages by including other folders (e.g. js and html for admin pages for beards).