switch from setuppy to pyprojecttoml

.devcontainer/Dockerfile

@@ -0,0 +1,72 @@
+# SPDX-FileCopyrightText: 2024 Jev Kuznetsov, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+# note: using 3.11 because pre-commit is not compatible with 3.12
+FROM python:3.11-slim
+
+ARG USERNAME=dev
+ARG UID=1000
+ARG GID=1000
+ARG VERSION="circup-dev"
+
+# Create the user
+RUN groupadd --gid $GID $USERNAME \
+    && useradd --uid $UID --gid $GID -m $USERNAME \
+    #
+    # [Optional] Add sudo support. Omit if you don't need to install software after connecting.
+    && apt-get update \
+    && apt-get install -y sudo \
+    && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME \
+    && chmod 0440 /etc/sudoers.d/$USERNAME
+
+# dialout group
+RUN usermod -a -G dialout $USERNAME
+
+# install packages
+RUN apt-get install -y \
+    locales \
+    tree \
+    git \
+    iputils-ping
+
+# cleanup
+RUN rm -rf /var/lib/apt/lists/*
+
+# set locale
+RUN export LC_ALL=en_US.UTF-8
+RUN export LANG=en_US.UTF-8
+RUN locale-gen en_US.UTF-8
+
+RUN pip install --upgrade pip
+
+
+USER ${USERNAME}
+RUN echo 'export PS1="🐍  \[\033[1;36m\]'"${VERSION}"' \[\e[33m\]\W\[\e[m\] \[\033[1;36m\]# \[\033[0m\]"' >> ~/.bashrc
+
+# add local bin to path
+RUN echo "export PATH=\$PATH:/home/${USERNAME}/.local/bin" >> ~/.bashrc
+ENV PATH="${PATH}:/home/${USERNAME}/.local/bin"
+
+WORKDIR /home/${USERNAME}
+
+
+# setup folders for saving vscode extensions
+# https://code.visualstudio.com/remote/advancedcontainers/avoid-extension-reinstalls
+RUN mkdir -p /home/$USERNAME/.vscode-server/extensions \
+    && chown -R $USERNAME \
+    /home/$USERNAME/.vscode-server
+
+
+# install requirements
+COPY requirements.txt requirements.txt
+RUN pip3 install -r requirements.txt && rm requirements.txt
+
+
+# build timestamp
+USER root
+RUN echo ${VERSION} >> /build_date.txt && \
+    date >> /build_date.txt
+
+USER ${USERNAME}
+WORKDIR /home/${USERNAME}

.devcontainer/devcontainer.json

@@ -0,0 +1,26 @@
+{
+  "initializeCommand": ".devcontainer/prepare_host.sh", // executed on HOST system
+  "image": "local/circup-dev",
+
+  "mounts": [
+    "source=/var/tmp/container-extensions,target=/home/dev/.vscode-server/extensions,type=bind,consistency=cached"
+  ],
+  "postCreateCommand": "pip install -e '.[dev]'",
+
+
+  // Configure tool-specific properties.
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "shardulm94.trailing-spaces",
+        "njpwerner.autodocstring",
+        "mhutchie.git-graph",
+        "doi.fileheadercomment",
+        "donjayamanne.githistory",
+        "charliermarsh.ruff"
+      ]
+    }
+  }
+}

.devcontainer/devcontainer.json.license

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2024 Jev Kuznetsov, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT

.devcontainer/prepare_host.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+# SPDX-FileCopyrightText: 2024 Jev Kuznetsov, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+
+# this script prepares the host for the devcontainer.
+
+
+# it is easier to use this script to pre-build the image, instead of using
+# `build` directive in `devcontainer.json`. Less chance of errors ducing container start.
+
+IMG_NAME="local/circup-dev"
+# Get the directory of the script
+SCRIPT_DIR=$(dirname "$0")
+
+# create a directory for the container extensions to avoid reinstallation
+# on container rebuild. Mounted inside devcontainer.
+mkdir -p /var/tmp/container-extensions
+
+
+# buld image
+echo "Building image $IMG_NAME"
+docker build -t $IMG_NAME --build-arg UID=$(id -u) --build-arg GID=$(id -g) -f $SCRIPT_DIR/Dockerfile $SCRIPT_DIR

.devcontainer/requirements.txt

@@ -0,0 +1,13 @@
+bump2version
+coverage
+invoke
+ipython
+mypy
+pre-commit
+pytest
+pytest-asyncio
+pytest-cov
+pytest-coverage
+pytest-faulthandler
+pytest-random-order
+ruff

.devcontainer/requirements.txt.license

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2024 Jev Kuznetsov, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT

CONTRIBUTING.rst

@@ -30,11 +30,26 @@ Developer Setup
     `Black code formatter <https://black.readthedocs.io/en/stable/index.html>`_
     (which only works with Python 3.6+).
 
+
+
 Clone the repository and from the root of the project,
+
+
+setup a virtual environment and activate it.::
+
+    python3 -m venv .env
+    source .env/bin/activate
+
 install the requirements::
 
     pip install -e ".[dev]"
 
+
+.. note::
+    This repository provides a devcontainer environment that can be used in VSCode. For more information, read `VSCode containers docs <https://code.visualstudio.com/docs/devcontainers/containers>`_.
+    This provides a ready to use development environment when you launch VSCode in the devcontainer.
+
+
 Run the test suite::
 
     pytest --random-order --cov-config .coveragerc --cov-report term-missing --cov=circup

pyproject.toml

@@ -0,0 +1,73 @@
+# SPDX-FileCopyrightText: 2024 Jev Kuznetsov, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+[build-system]
+requires = ["setuptools>=61.0", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "circup"
+dynamic = ["version"]
+description = "A tool to manage/update libraries on CircuitPython devices."
+readme = "README.rst"
+authors = [{ name = "Adafruit Industries", email = "circuitpython@adafruit.com" }]
+license = { file = "LICENSE" }
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: POSIX",
+    "Operating System :: MacOS :: MacOS X",
+    "Operating System :: Microsoft :: Windows",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Topic :: Education",
+    "Topic :: Software Development :: Embedded Systems",
+    "Topic :: System :: Software Distribution"
+]
+keywords = ["adafruit", "blinka", "circuitpython", "micropython", "libraries"]
+
+
+dependencies = [
+    "semver~=3.0",
+    "build",
+    "click>=8.0",
+    "appdirs>=1.4.3",
+    "requests>=2.22.0",
+    "findimports>=2.1.0",
+    "toml>=0.10.2",
+    "update_checker",
+    "importlib_metadata; python_version == '3.7'"
+]
+requires-python = ">=3.6"
+
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "pylint",
+    "pytest-cov",
+    "pytest-random-order>=1.0.0",
+    "pytest-faulthandler",
+    "coverage",
+    "black",
+    "sphinx",
+    "wheel",
+    "twine"
+]
+
+
+[project.scripts]
+circup = "circup:main"
+
+[project.urls]
+homepage = "https://github.com/adafruit/circup"
+
+[tool.setuptools.packages.find]
+where = ["."]  # This tells setuptools to look in the project root directory
+include = ["circup"]  # This pattern includes your main package and any sub-packages within it