Initial commit

Author: ahosgood

.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+
+on:
+  workflow_dispatch:
+  push:
+    # branches:
+    #   - main
+    #   - feature/*
+
+jobs:
+  test-python:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-verion: [3.13, 3.12, 3.11, 3.10, 3.9]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Run Python tests
+        run: python -m unittest discover test

.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+.env
+.idea/
+.vscode/
+__pycache__

CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased](https://github.com/nationalarchives/tna-frontend-jinja/compare/v0.0.1...HEAD)
+
+### Added
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security

README.md

@@ -1,2 +1,11 @@
-# python-utilities
-A library of common National Archives Python functions
+# National Archives Python Utilities
+
+A library of common National Archives Python functions.
+
+```sh
+# Run the tests
+python -m unittest discover test
+
+# Format the code
+./tasks/format.sh
+```

setup.py

@@ -0,0 +1,30 @@
+import setuptools
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="tna-utilities",
+    version="0.0.1",
+    author="Andrew Hosgood",
+    author_email="andrew.hosgood@nationalarchives.gov.uk",
+    description="A library of common National Archives Python functions",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/nationalarchives/python-utilities",
+    project_urls={
+        "Bug Tracker": "https://github.com/nationalarchives/python-utilities/issues",
+    },
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Environment :: Web Environment",
+        "Intended Audience :: Developers",
+    ],
+    packages=["tna_utilities"],
+    # package_data={
+    #     "": ["**/*.py", "**/*.html"],
+    # },
+    python_requires=">=3.9",
+)

tasks/format.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+docker run --rm -v "$(pwd)":/app/ ghcr.io/nationalarchives/tna-python-dev:latest format