File organisation#

This chapter aims to take a look at the main files and folders of the project.

  • pyproject.toml : this is the describing file, it contains all metadata necessary to describe and make work the project.

  • makefile : it uses GNU Make to have some commands available easily. See Makefile to know all available targets.

  • dist : this is the folder in which are the .whl files after building the lib.

  • docs : this is where the docs are written and built (see Documentation).

  • pygeodes : this is the main source folder, where all the python sources are written (see Sources).

  • tests : this is where the tests folder, where all the tests cases are written (see Unit testing).

  • utils : this folder contains some useful scripts to help building around the docs (see Makefile).