refactor and clean the code

This commit is contained in:
Sina Atalay
2024-12-08 15:07:38 -05:00
parent 329b961b63
commit 686c8e1a15
24 changed files with 538 additions and 540 deletions

View File

@@ -24,9 +24,9 @@ There are two ways of developing RenderCV: locally or with GitHub Codespaces.
5. RenderCV uses three virtual environments:
- `default`: For the development and testing. It contains packages like [Ruff](https://github.com/astral-sh/ruff), [Black](https://github.com/psf/black), [pytest](https://github.com/pytest-dev/pytest) etc.
- `docs`: For building the documentation.
Create the virtual environments with the following commands.
```bash
hatch env create default
hatch env create docs
@@ -38,11 +38,11 @@ There are two ways of developing RenderCV: locally or with GitHub Codespaces.
```bash
hatch shell default
```
```bash
hatch shell docs
```
- Select one of the virtual environments in your Integrated Development Environment (IDE).
=== "Visual Studio Code"
@@ -69,7 +69,7 @@ This is done with [Development containers](https://containers.dev/), and the env
These commands are defined in the [`pyproject.toml`](https://github.com/sinaatalay/rendercv/blob/main/pyproject.toml) file.
- Format the code with [Black](https://github.com/psf/black)
- Format the code with [Black](https://github.com/psf/black) and [Ruff](https://github.com/astral-sh/ruff)
```bash
hatch run format
```
@@ -77,10 +77,6 @@ These commands are defined in the [`pyproject.toml`](https://github.com/sinaatal
```bash
hatch run lint
```
- Sort the imports with [isort](https://github.com/timothycrosley/isort/)
```bash
hatch run sort-imports
```
- Check the types with [Pyright](https://github.com/RobertCraigie/pyright-python)
```bash
hatch run check-types