summaryrefslogtreecommitdiff
path: root/sandbox/grubert/directory_structur
blob: 44e39d4dff66c8ed60e9410955954a64a9af6a3f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Sandbox directory structure (2002-07-05)

sandbox/
    userid/
        component_name/ # A verbose name is best.
            README.txt  # Please explain requirements,
                        # purpose/goals, and usage.
            docs/
                ...
            component.py    # The component is a single module.
                        # *OR* (but *not* both)
            component/  # The component is a package.
                __init__.py  # Contains the Reader/Writer class.
                other1.py    # Other modules and data files used
                data.txt     # by this component.
                ...
            test/       # Test suite.
                ...
            tools/      # For front-ends etc.
                ...
            setup.py    # Use Distutils to install the component
                        # code and tools/ files into the right
                        # places in Docutils.