Glossary

Project

At it's core, any directory can be a "project", but most projects would have a pyproject.toml or slap.toml configuration file. Most commonly, it will have a pyproject.toml file that contains the Slap configuration under the [tool.slap] namespace. Many concepts in Slap are attached directly to a project. For example if the project has a pyproject.toml, it is considered a Python project, and Python projects can have packages that can be installed, built or published to PyPI or another repository.

A project with a slap.toml configuration file (or with no configuration file) is usually used as the parent project for two or more sub-projects. This configuration represents a mono-repository where multiple projects are stored and versioned together.

Slap understands most details about a project through a ProjectHandlerPlugin. It comes with a default implementation that supports Poetry and Flit Python projects.

Repository

A repository is a directory that contains one or more projects. For singular projects, the repository directory is the same as the project directory. For a mono-repository configuration, any directory that contains multiple projects is considered the repository directory (it usually contains a slap.toml configuration file).

Note that the repository directory is also considered a project directory, but if it isn't also a Python project (i.e. if it has a pyproject.toml instead of a slap.toml) it will be ignored for most Slap commands.

=== "Single project"

```
my_pacakge/                           -> Repository / Project "my_package"
  pyproject.toml
  readme.md
  src/
  tests/
```

=== "Mono repository"

```
/                                     -> Repository / Project "$"
  my_first_package/                   -> Project "my_first_package"
    pyproject.toml
    readme.md
    src/
    tests/
  my_second_package/                  -> Project "my_second_package"
    pyproject.toml
    readme.md
    src/
    tests/
  slap.toml
```

Slap understands most details about a repository through a RepositoryHandlerPlugin. It comes with a default implementation that supports Git repositories and GitHub.