# General Codebase Orientation

The [spyder-ide/spyder](https://github.com/spyder-ide/spyder) repository contains
code for many plugins that are versioned and published into a single package.

See the [Contributing Guidelines]() for detailed developer installation instructions.

## Directories

The repository contains a number of top-level directories, the contents of which
are described here.

### Binder setup: ``binder/``

This contains an environment specification for ``repo2docker`` which allows
the repository to be tested on [mybinder.org](https://mybinder.org>)

This specification is developer focused.

### external-deps

### img_src

### requirements

### rope_profiling

### scripts

### Python package: ``spyder/``

TODO:

#### Package module: ``spyder/api``

TODO:

#### Package module: ``spyder/app``

TODO:

#### Package module : ``spyder/config``

TODO:

#### Package module : ``spyder/fonts``

TODO:

#### Package module : ``spyder/images``

TODO:

#### Package module : ``spyder/locale``

TODO:

#### Package module : ``spyder/plugins``

TODO:

#### Package module : ``spyder/preferences``

TODO:

#### Package module : ``spyder/tests``

TODO:

#### Package module : ``spyder/utils``

TODO:

#### Package module : ``spyder/widgets``

TODO:

#### Package module : ``spyder/windows``

TODO:

#### Package module : ``spyder/workers``

TODO: