https://github.com/fer-aguirre/cookiecutter-data-analysis-extensive

A cookiecutter template for data analysis projects using Python.
https://github.com/fer-aguirre/cookiecutter-data-analysis-extensive

cookiecutter data-analysis project-template python

Last synced: 23 days ago
JSON representation

A cookiecutter template for data analysis projects using Python.

• Host: GitHub
• URL: https://github.com/fer-aguirre/cookiecutter-data-analysis-extensive
• Owner: fer-aguirre
• Created: 2022-02-17T05:43:42.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-11T13:55:33.000Z (7 months ago)
• Last Synced: 2024-11-05T21:16:06.703Z (2 months ago)
• Topics: cookiecutter, data-analysis, project-template, python
• Language: Python
• Homepage:
• Size: 72.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Cookiecutter Data Analysis Extensive 🪲

A [cookiecutter](https://github.com/cookiecutter/cookiecutter) template for data analysis projects using Python. By using this template, users can save time and effort in setting up project directories, ensuring consistency across projects, and promoting collaboration among team members.

---

## Directory Structure

```

┬

|- .gitignore              # Customized .gitignore for python projects

|- config.ini              # Configuration file

|- setup.py                # Import project as a python module

|- LICENSE                 # Project's license

|- pyproject.toml          # Project dependencies

|- README.md               # Top-level README for this project

|

|- assets                  # Resources for the project

|

|- data                    # Categorized data files                      

|  |- processed            # Cleaned data

|  |- raw                  # Original data

|

|- docs                    # Quarto files

|

|- notebooks               # Jupyter notebooks

|  |- 0.0-process.ipynb    # Data processing (fixing column types, data cleansing, etc.)

|  |- 1.0-analyze.ipynb    # Exploratory data analysis

|  └─ 2.0-visualize.ipynb  # Data visualization methods

|

|- outputs                 # Exports generated by notebooks

|  |- figures              # Generated graphics, maps, etc. to be used in reporting

|  └─ tables               # Generated pivot tables to analyze data

| 

|- project                 # Python package

|  |- __init__.py

|  |- data                 # Functions to manipulate data

|  |  |- load.py           # Module to load data

|  |  |- process.py        # Module to process data

|  |  |- analyze.py        # Module to analyze data

|  |  |- export.py         # Module to save exports

|  |  └─ __init__.py 

|  |  

|  └─ utils                # Functions to make common patterns shorter and easier

|     |- paths.py          # Module to generate relative paths

|     └─ __init__.py

|

|- references              # Explanatory materials

|

|- scripts                 # Python files

|

|- website                 # Quarto files

|  |- pages                # Multi-page website

|  |- _quarto.yml          # Project configuration file

|  └─ index.qmd            # Home page

┴

```

---