https://github.com/azulgarza/python-project-template

i usually start my python projects using this template.
https://github.com/azulgarza/python-project-template

Last synced: 21 days ago
JSON representation

i usually start my python projects using this template.

• Host: GitHub
• URL: https://github.com/azulgarza/python-project-template
• Owner: AzulGarza
• License: apache-2.0
• Created: 2023-10-21T04:23:29.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-21T02:27:56.000Z (3 months ago)
• Last Synced: 2024-10-16T11:47:41.155Z (2 months ago)
• Language: Python
• Homepage:
• Size: 17.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# python-project-template  

> a simple template for organizing any python project.

## setup & environment

this template is designed to streamline the setup of any python project. follow these steps to get started:

### 1. install [`uv`](https://github.com/astral-sh/uv/)

use `uv` to manage your virtual environments:

```bash

pip install uv

```

### 2. create a virtual environment

create an environment using python 3.10 (or your preferred version):

```bash

uv venv --python 3.10

```

### 3. activate the environment

activate the virtual environment:

```bash

source .venv/bin/activate

```

### 4. install dependencies

install all the required dependencies from the `requirements.txt` file:

```bash

uv pip install -e .

```

### 5. install pre-commits

```bash

pre-commit install

```

## ready to code  

you're now all set to start building your project.