Skip to content

Project initialization

In order to create a new project in your current directory, just run pilotis init in a terminal. If you want to create it in another directory, you can also run pilotis init --project-parent-dir my/other/directory/path.

Pilotis will ask you for your desired project name. It will then create your project directories organization for both the code and the data, and it will set up your project virtual environment.

What you will get at the end of this command is:

  1. A directory with your project source code, divided between domain, application and infrastructure code
  2. A tests directory
  3. A notebooks directory
  4. A pyproject.toml file with your Poetry environment configuration, containing some useful libraries for your project life cycle. Among them, the pilotis-io library will allow you to read from and write to multiple storage locations while always keeping the same simple API.
  5. A file for onboarding new people on your project
  6. A mkdocs.yml file and a docs directory, with an initial documentation website documenting the tools and conventions used in the bootstrapped project
  7. A .flake8 file with linter conventions
  8. A containers directory with some docker files for facilitating your deployments
  9. A workdir directory with your local data
  10. Some makefiles with some useful commands (run make --help to know more about that)

Your project structure should then look like this:

|_ docs
|_ notebooks
|_ tests
|_ <package_name>
|_ .flake8
|_ Makefile
|_ mkdocs.yml
|_ pyproject.toml
|_ landing
| |_ raw
| |_ parsed
|_ use_cases