Skip to content

Commit

Permalink
Update the EditConfig file
Browse files Browse the repository at this point in the history
- Added default behaviour settings for files
  • Loading branch information
habedi committed Aug 9, 2024
1 parent d45b22d commit 3fb27d7
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 6 deletions.
13 changes: 10 additions & 3 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,22 @@
# Top-most EditorConfig file
root = true

# Global settings (applicable to all files unless overridden)
[*]
charset = utf-8 # Default character encoding
end_of_line = lf # Use LF for line endings (Unix-style)
indent_style = space # Use spaces for indentation
indent_size = 4 # Default indentation size
insert_final_newline = true # Make sure files end with a newline
trim_trailing_whitespace = true # Remove trailing whitespace

# Python specific settings, complying with PEP 8 style guide, except for the line length
[*.py]
indent_size = 4
max_line_length = 120

# Markdown files
[*.md]
trim_trailing_whitespace = false
trim_trailing_whitespace = false # Don't remove trailing whitespace in Markdown files
# Bash scripts
[*.sh]
Expand All @@ -27,4 +35,3 @@ indent_size = 2
# JSON files
[*.json]
indent_size = 2

9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
[![Tests](https://github.com/habedi/template-python-project-repo/actions/workflows/tests.yml/badge.svg)](https://github.com/habedi/template-python-project-repo/actions/workflows/tests.yml)
[![Made with Love](https://img.shields.io/badge/Made%20with-Love-red.svg)](https://github.com/habedi/template-python-project-repo)

This repository is as a template for starting Python projects. It includes a basic structure for organizing the things like code,
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.

Expand All @@ -12,8 +13,10 @@ as a starting point for your own projects if you find it useful.

## Installing Poetry

We use [Poetry](https://python-poetry.org/) 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
We use [Poetry](https://python-poetry.org/) 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.

```bash
Expand Down

0 comments on commit 3fb27d7

Please sign in to comment.