Merge pull request #12 from nipy/update-python

Towards poetry and ruff

.circleci/config.yml

@@ -1,23 +1,29 @@
 version: 2.0
 
 jobs:
-  Python_2.7:
-      docker:
-        - image: circleci/python:2.7
-      steps: &steps
-        - checkout
-        - run: sudo pip install -r requirements.txt
-        - run: sudo pip install pytest
-        - run: python --version ; pip --version ; pwd ; ls
-        - run: pytest
-  Python_3.6:
-      docker:
-        - image: circleci/python:3.6
-      steps: *steps
+  Python_3.9:
+    docker:
+      - image: circleci/python:3.9
+    steps: &steps
+      - checkout
+      - run: sudo pip install -r requirements.txt
+      - run: sudo pip install pytest ruff
+      - run: python --version ; pip --version ; pwd ; ls
+      - run: pytest
+      - run: ruff
+  Python_3.10:
+    docker:
+      - image: circleci/python:3.10
+    steps: *steps
+  Python_3.11:
+    docker:
+      - image: circleci/python:3.11
+    steps: *steps
 
 workflows:
   version: 2
   build:
     jobs:
-      - Python_2.7
-      - Python_3.6
+      - Python_3.9
+      - Python_3.10
+      - Python_3.11

README.md

@@ -2,6 +2,7 @@
 [![coverage](https://github.com/nipy/nilabels/blob/master/coverage.svg)](https://github.com/SebastianoF/nilabels/blob/master/coverage.svg)
 [![CircleCI](https://circleci.com/gh/nipy/nilabels.svg?style=svg)](https://circleci.com/gh/nipy/nilabels)
 [![PyPI version](https://badge.fury.io/py/nilabels.svg)](https://badge.fury.io/py/nilabels)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
 
 <p align="center">
@@ -13,7 +14,7 @@
 NiLabels is a cacophony of tools to automate simple manipulations and measurements of medical image
 segmentations in nifti format. It is strongly based on and influenced by the library [NiBabel](http://nipy.org/nibabel/)
 
-+ Written in [Python 3.6](https://docs.python-guide.org/) back compatible with 2.7
++ Written in [Python 3](https://docs.python-guide.org/)
 + [Motivations](https://github.com/SebastianoF/nilabels/wiki/Motivations)
 + [Features](https://github.com/SebastianoF/nilabels/wiki/What-you-can-do-with-nilabels)
 + [Design pattern](https://github.com/SebastianoF/nilabels/wiki/Design-Pattern)
@@ -94,6 +95,17 @@ More tools are introduced in the [documentation](https://github.com/SebastianoF/
 + [How to run the tests](https://github.com/SebastianoF/nilabels/wiki/Testing)
 
 
+### Development
+
+`nilabel` is a python package managed with [poetry](https://python-poetry.org/) and linted with [ruff](https://docs.astral.sh/ruff/), tested with [pytest](https://docs.pytest.org/en/8.0.x/)
+
+### TODO
+
+Other than the many TODOs around the code, there are two more things:
+
+- typechecking with mypy
+- migrate from cicleCI to github workflows
+
 ### Licencing and Copyright
 
 Copyright (c) 2017, Sebastiano Ferraris. NiLabels  (ex. [LABelsToolkit](https://github.com/SebastianoF/LABelsToolkit))