/wordwise

Wordwise is a tool designed to help you expand your vocabulary and learn new words effectively.

Primary LanguagePython

Wordwise

My Project Description

Project setup

The project uses pre-commit cli to add git hooks for:

In order to setup the development environment it is possible to run the following command on terminal:

$ make setup-dev-env

This command will install development requirements from requirements-dev.txt file, including pytest, and setup pre-commit hooks.

Git hooks

Git hook scripts are useful for identifying simple issues before submission to code review. We run our hooks on every commit to automatically point out issues in code such as missing semicolons, trailing whitespace, and debug statements.

Before commit every change you should install pre-commit package in your enviroment:

pip install pre-commit
pre-commit install

then you can simply run against all the files:

pre-commit run --all-files

trim trailing whitespace.................................................Passed
fix end of files.........................................................Passed
check toml...............................................................Passed
check yaml...............................................................Passed
check for merge conflicts................................................Passed
ruff.....................................................................Passed
ruff-format..............................................................Failed
- hook id: ruff-format
- files were modified by this hook

1 file reformatted

Modify configuration for these utility tools:

  • pre-commit general settings -> .pre-commit-config.yaml
  • ruff settings -> .pyproject.toml
  • commitizen settings -> .pyproject.toml

Dependencies management

There are 2 levels of dependencies:

  • development dependencies: they are all the dependencies needed to develop on the current repository, such as pytest and ruff
  • library/package dependencies: they are all dependencies used by the library

To add more dependencies it is necessary to modify the requirements*.in files and run the following command:

$ make requirements*.txt

This command will lock all the direct and transitive dependencies in the requirements*.txt file.

Important more commands are stored in the Makefile