Skip to content

FILESTRUCTURE.md

Latest commit

 

History

History
37 lines (36 loc) · 2.86 KB

FILESTRUCTURE.md

File metadata and controls

37 lines (36 loc) · 2.86 KB
Raw

This is an explanation of the file structure that the cookiecutter generated for you:

  • Python source files:
    • The Python package source files are located in the src/your_project directory.
    • tests/test_your_project.py contains the unit tests for the package.
    • tests/conftest.py contains testing setup and configuration for pytest
  • Markdown files with meta information on the project. Markdown is a good language for these files, as it is easy to write and rendered into something beautiful by your git repository hosting provider.
    • README.md is the file that users will typically see first when discovering your project.
    • COPYING.md provides a list of copyright holders.
    • CITATION.cff provides citation metadata so others know how to reference your project in publications.
    • LICENSE.md contains the license you selected.
    • TODO.md contains a list of TODOs after running the cookiecutter. Following the instructions in that file will give you a fully functional repository with a lot of integration into useful web services activated and running.
    • FILESTRUCTURE.md describes the generated files. Feel free to remove this from the repository if you do not need it.
  • Python build system files
    • pyproject.toml is the central place for configuration of your Python package. It contains the project metadata, setuptools-specific information and the configuration for your toolchain (like e.g. pytest).
  • Configuration for CI/Code Analysis and documentation services
    • .github/workflows/ci.yml describes the Github Workflow for Continuous integration. For further reading on workflow files, we recommend the introduction into Github Actions and the reference of available options.
    • .github/dependabot.yml configures the DependaBot integration on GitHub that allows you to automatically create pull requests for updates of the used actions in .github/workflows/ci.yml.
    • .gitlab-ci.yml describes the configuration for Gitlab CI. For further reading, we recommend Gitlabs quick start guide and the Gitlab CI configuration reference
    • .pre-commit-config.yaml contains a configuration for the pre-commit tool. It was added because the pre-commit tool was found in your Python environment.
    • .readthedocs.yml configures the documentation build process at ReadTheDocs. To customize your build, you can have a look at the available options.