https://github.com/hamirmahal/ruff-virtual-environment

Easily get started with formatting, linting and unit testing in a Python project.
https://github.com/hamirmahal/ruff-virtual-environment

ci continuous-integration github github-actions mypy python python-3 python3 ruff ruff-python

Last synced: 15 days ago
JSON representation

Easily get started with formatting, linting and unit testing in a Python project.

• Host: GitHub
• URL: https://github.com/hamirmahal/ruff-virtual-environment
• Owner: hamirmahal
• Created: 2024-05-05T22:52:34.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-05-30T07:29:33.000Z (5 months ago)
• Last Synced: 2024-10-04T16:44:19.636Z (about 1 month ago)
• Topics: ci, continuous-integration, github, github-actions, mypy, python, python-3, python3, ruff, ruff-python
• Language: Python
• Homepage:
• Size: 4.88 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Setup

1.  Run

```

du -sh . && python3 -m venv venv/ && du -sh .

```

2. Restart your terminal or run

```

source venv/bin/activate

```

## To install the packages in [`requirements.txt`](requirements.txt)

```

pip list && echo && du -sh .

pip install -r requirements.txt && echo && pip list && echo && du -sh .

```

## To install the latest packages

```

pip list && echo && du -sh .

pip install ruff && echo && pip list && echo && du -sh .

pip install mypy && echo && pip list && echo && du -sh .

pip install pre-commit && echo && pip list && echo && du -sh .

# "Freeze" the requirements so we know what versions we are using.

pip freeze > requirements.txt && pip list

```

## Pre-commit

Run

```

du -sh . && pre-commit install && du -sh .

```

to setup pre-commit hooks.

# Testing, Type Checking, Formatting and Linting

1. Run

```

./s.sh

```

# Running the Program

You can run the program with

```

time python src/main.py

```

in your terminal after completing setup.