Metadata-Version: 2.3
Name: ngi-code-academy
Version: 0.3.42
Summary: An example package for use in courses!
Author: Ole-Jakob Olsen
Author-email: ole.jakob.olsen@ngi.no
Requires-Python: >=3.11,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Description-Content-Type: text/markdown

# NGI Code Academy

An example package for the NGI Course "How to collaborate on a software project".

Use at your own risk, made by developers in training!

If you are following the exam, see more information in [EXAM.md](./EXAM.md)

# Contributing

## Dependencies

- Python 3.13.2 (optionally use `pyenv`)
- Poetry

## Set up environment

Create a virtual environment an install the dependencies into it locally using

`poetry install`

Ensure you activate the virtual environment.

## Local code quality checks

Check linting rules: `ruff check .`
Check formatting: `ruff format --check`

## Run tests

```
pytest .
```

## (Optional) Pre commit hooks

Install pre commit hooks to automatically run linting, formatting checks and poetry checks before committing.

```
poetry run pre-commit install
```

