Skip to content

Frequently Asked Questions

General Setup

Can I use this template without Docker?

Yes, you can use the template with a local Python environment instead of Docker. See the Environment Setup guide for instructions.

Project Structure

Where should I put my data files?

Data files should be organized in the data/ directory as described in the Project Structure guide:

  • data/raw/ - Original, immutable data
  • data/interim/ - Intermediate data that has been transformed
  • data/processed/ - Final, cleaned data for modeling
  • data/external/ - Data from third-party sources

Where should I put my code?

Your code should be organized as a Python package in the src/ directory as outlined in the Project Structure guide.

Development Workflow

How do I ensure code quality?

The template includes a .pre-commit-config.yaml with check-added-large-files active (20MB limit). Several other useful hooks are included but commented out:

  • trailing-whitespace, end-of-file-fixer, check-yaml
  • Ruff linting and formatting hooks

To enable any of these, uncomment them in .pre-commit-config.yaml. You can also run linting and formatting manually:

just ruff

See the Code Quality guide for details.

How do I handle dependencies?

Dependencies are managed using uv. For detailed instructions, see the Installing Additional Dependencies section in the Environment Setup guide.

How do I run Jupyter notebooks?

Use the included just command:

just run_jupyter

Collaboration

How do I contribute to the Template?

See the Contributing guide for detailed instructions on how to contribute to the development of the template itself.

How do I report issues or suggest improvements?

You can report issues or suggest improvements by:

  1. Opening an issue in the project's repository
  2. Discussing with the project maintainers
  3. Submitting a pull request with your changes