A Python library to study linear algebra

Find a file

Alexander Hess fb407631d9 Set up code formatting tools - auto-format code with: + autoflake => * remove unused imports and variables * remove duplicate dict keys * expand star imports + black => enforce an uncompromising code style + isort => enforce a consistent import style compliant with Google's Python style guide - add nox session "format" to run these tools		2024-09-10 01:27:34 +02:00
src/lalib	Initialize the project	2024-09-10 01:15:36 +02:00
.gitignore	Set up code formatting tools	2024-09-10 01:27:34 +02:00
LICENSE.txt	Add open-source license	2024-09-10 00:45:24 +02:00
noxfile.py	Set up code formatting tools	2024-09-10 01:27:34 +02:00
poetry.lock	Set up code formatting tools	2024-09-10 01:27:34 +02:00
pyproject.toml	Set up code formatting tools	2024-09-10 01:27:34 +02:00
README.md	Set up code formatting tools	2024-09-10 01:27:34 +02:00

README.md

A Python library to study linear algebra

The goal of the lalib project is to create a library written in pure Python (incl. the standard library) and thereby learn about linear algebra by reading and writing code.

Contributing & Development

This project is open for any kind of contribution, be it by writing code for new features or bugfixes, or by raising issues. All contributions become open-source themselves, under the MIT license.

Local Develop Environment

In order to play with the lalib codebase, you need to set up a develop environment on your own computer.

First, get your own copy of this repository:

git clone git@github.com:webartifex/lalib.git

While lalib comes without any dependencies except core Python and the standard library for the user, we assume a couple of packages and tools be installed to ensure code quality during development. These can be viewed in the pyproject.toml file and are managed with poetry which needs to be installed as well. poetry also creates and manages a virtual environment with the develop tools, and pins their exact installation versions in the poetry.lock file.

To replicate the project maintainer's develop environment, run:

poetry install

Maintenance Tasks

We use nox to run the test suite and other maintenance tasks during development in isolated environments. nox is similar to the popular tox. It is configured in the noxfile.py file. nox is assumed to be installed as well and is therefore not a project dependency.

To list all available tasks, called sessions in nox, simply run:

nox --list or nox -l for short

To execute all default tasks, simply invoke:

nox

Code Formatting

We follow Google's Python style guide.

During development, nox -s format may be helpful. It can be speed up by re-using a previously created environment with the -R flag.

This task formats all source code files with autoflake, black, and isort.

Branching Strategy

The branches in this repository follow the GitFlow model. Feature branches are rebased onto the develop branch before being merged. Whereas a rebase makes a simple fast-forward merge possible, all merges are made with explicit and empty merge commits. This ensures that past branches remain visible in the logs, for example, with git log --graph.