https://github.com/kaislar/ds_template
https://github.com/kaislar/ds_template
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kaislar/ds_template
- Owner: kaislar
- Created: 2022-08-25T12:45:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-09-07T13:15:48.000Z (over 2 years ago)
- Last Synced: 2024-08-09T02:18:11.205Z (7 months ago)
- Language: Makefile
- Size: 53.7 KB
- Stars: 38
- Watchers: 1
- Forks: 22
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - kaislar/ds_template - (Makefile)
README
# template_ds_project
Project Title
[]()
---
## 🧐 About
Write about 1-2 paragraphs describing the purpose of your project.
## 🔖 Project structure
```
Project_folder/
|- bin/ # contains scripts and main files that should be run
|- config/ # config files
|- notebooks/ # notebooks for EDA and exploration
|- secrets # contains api keys and secret parameters. It should be ignored from git
|- src/ # source code - contains functions
|- tests/ # Test files should mirror the src folder
|- Makefile # automatize taks through make utility
```
## 🏁 Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
Setup your environement and install project dependencies
```
conda create -n my_project python=3.10
source activate my_project
python -m pip install pip-tools
pip-compile --output-file requirements.txt requirements.in requirements_dev.in
python -m pip install -r requirements.txt
```
### Installing
## 🔧 Running the tests
Tests are implemented in ./tests, you need to run the following command to run them.
```
make tests
```
## 🚀 Deployment
Add additional notes about how to deploy this on a live system.
## 🎈 Contributions
To contribute in this project, please setup locally the project following the steps in Getting started section.
We use few packages to guarantee high quality code. Before commiting you can run:
To format you code using black
```
make black
```
To get warning message on non respect of pep8 code guidance:
(the command runs on all .py files in the project)
```
make lint
```
You can also run automatically, black, lint and few other packages to analyze and check your code base before commiting
```
make precommit
```
## ✍️ Authors