This repository is as a template for starting Python projects. It includes a basic structure for organizing the things like code, data, and notebooks, as well as a configuration file for managing the dependencies using Poetry. The repository also includes a GitHub Actions workflow for running tests on the codebase.
I made it mainly for my personal and professional machine learning data science projects, but feel free to use it as a starting point for your own projects if you find it useful.
We use Poetry for managing the dependencies and virtual environment for the project. To get started, you need to install Poetry on your machine. We can install Poetry by running the following command in the command line using pip.
pip install poetryWhen the installation is finished, run the following command in the shell in the root folder of this repository to install the dependencies, and create a virtual environment for the project.
poetry installAfter that, enter the Poetry environment by invoking the poetry shell command.
poetry shellThe repository has the following structure:
bin/: scripts and executables for command line usedata/: data files and datasetssrc/: source code filesnotebooks/: Jupyter notebooks filesmodels/: trained models and model filestests/: test files for the source codepyproject.toml: project metadata and dependenciesLICENSE: license informationREADME.md: project information and instructions
Files in this repository are licensed under the MIT License - see the LICENSE file for details.