https://github.com/adilzouitine/boring-template

Boring template for a boring dev
https://github.com/adilzouitine/boring-template

Last synced: about 1 month ago
JSON representation

Boring template for a boring dev

• Host: GitHub
• URL: https://github.com/adilzouitine/boring-template
• Owner: AdilZouitine
• Created: 2021-02-23T18:09:59.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-12-01T15:45:33.000Z (12 months ago)
• Last Synced: 2023-12-01T16:37:07.585Z (12 months ago)
• Language: Python
• Homepage:
• Size: 8.79 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
boring-template

## Install

You need to install `pre-commit` [here](https://pre-commit.com/#install)

```bash

# Change in Makefile the project name

make setup-env

conda activate 

make install-all

```

## Test

```bash

make run-test

```

## Format

```bash

make format-all

```

## Architecture

```

├── CONTRIBUTING.md <- Coding rules for devs

├── data <- Data folder

├── doc <- Documentation

├── Dockerfile

├── Makefile <- Usefull command

├── README.md

├── requirements-dev.txt <- Linting etc ...

├── requirements.txt <- Package dependencies

├── result

├── setup.cfg <- Linting rules etc ...

├── src

│   └── sandbox <- Prototyping folder

└── test

```