Update contributing instructions, README, and setup scripts for improved clarity and functionality

Author: fasteiner

.devcontainer/devcontainer.json

@@ -0,0 +1,16 @@
+{
+  "name": "Xurrent Python Dev Container",
+  "image": "mcr.microsoft.com/devcontainers/base:ubuntu",  
+  "features": {
+    "ghcr.io/devcontainers/features/common-utils:2": {}
+  },
+  "postCreateCommand": "bash .devcontainer/setup.sh",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "elagil.pre-commit-helper",
+        "ms-python.python"
+      ]
+    }
+  }
+}

.devcontainer/setup.sh

@@ -0,0 +1,14 @@
+@echo off
+
+
+echo "Install poetry"
+pip install poetry
+
+echo "Install project dependencies including dev dependencies"
+poetry install --with dev
+
+echo "Activate poetry virtual environment and open shell"
+eval $(poetry env activate)
+
+echo "Install pre-commit hooks"
+pre-commit install

Contributing.md

@@ -5,12 +5,12 @@
 1. Clone the repository
 2. pip install poetry
 3. poetry install --with dev
-4. poetry shell
+4. eval $(poetry env activate)
 5. pre-commit install
 
 ## Activate the virtual environment
 
 ```bash
-poetry shell
+eval $(poetry env activate)
 ```
 

README.md

@@ -1,5 +1,10 @@
 # Xurrent Module
 
+[![PyPI version](https://img.shields.io/pypi/v/xurrent)](https://pypi.org/project/xurrent/)
+[![Downloads](https://img.shields.io/pypi/dm/xurrent)](https://pypistats.org/packages/xurrent)
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+
+
 This module is used to interact with the Xurrent API. It provides a set of classes to interact with the API.
 
 ## Change Log

pyproject.toml

@@ -33,6 +33,7 @@ pytest = "^8.3.4"
 python-dotenv = "^1.0.1"
 mock = "^5.1.0"
 pre-commit = "^4.0.1"
+shell = "^1.0.1"
 
 [build-system]
 requires = ["poetry-core"]