adding an AGENTS.md file with minor updates to the license, manifist, and setup.py

Author: bradmontgomery

AGENTS.md

@@ -0,0 +1,56 @@
+# AI Agent Guidelines (AGENTS.md)
+
+This repository is a small Django test-runner package intended to make test output more human-friendly by highlighting the most relevant portions of tracebacks and messages.
+
+## Goals
+
+- Prefer small, focused changes.
+- Preserve existing behavior unless the task explicitly requires a behavior change.
+- Keep the library usable as a drop-in Django `TEST_RUNNER`.
+
+## Local setup
+
+- Use a virtual environment.
+- Install in editable mode for development:
+
+```bash
+python -m venv .venv
+. .venv/bin/activate
+python -m pip install -U pip
+python -m pip install -e .
+```
+
+- Install Django appropriate to the change you’re making (this project historically targeted older Django, but modernization work may change that).
+
+## How to validate changes
+
+- Run any existing test/lint commands already present in the repo.
+- At minimum, ensure the code still imports and compiles:
+
+```bash
+python -m compileall rainbowtests setup.py
+```
+
+- If you have a sample Django project handy, validate integration by setting:
+
+```python
+TEST_RUNNER = 'rainbowtests.test.runner.RainbowDiscoverRunner'
+```
+
+…and running `python manage.py test`.
+
+## Code & style conventions
+
+- Do not do repo-wide reformatting unless explicitly requested.
+- Avoid adding new dependencies for minor changes.
+- Keep color/output behavior changes isolated to the existing modules (`rainbowtests/colors.py`, `rainbowtests/messages.py`, and `rainbowtests/test/*`) when possible.
+
+## Packaging / docs
+
+- Keep packaging metadata consistent with documentation files in the repo root (e.g., `README.md`, `LICENSE.md`).
+- Prefer Markdown for documentation.
+
+## Safety & privacy
+
+- Do not add secrets (API keys, tokens) to code, tests, docs, or CI.
+- Do not print environment variables or filesystem paths that could contain sensitive info.

LICENSE.md

@@ -1,4 +1,6 @@
-Copyright (c) 2016, Brad Montgomery <brad@bradmontgomery.net>
+# MIT License
+
+Copyright (c) 2026, Brad Montgomery <brad@bradmontgomery.net>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

MANIFEST.in

@@ -1,2 +1,2 @@
-include README.rst LICENSE.txt
+include README.md LICENSE.md
 recursive-include rainbowtests *.py

setup.py

@@ -1,18 +1,21 @@
+import io
+
 from setuptools import setup
 from rainbowtests import __version__
 
 setup(
     name='django-rainbowtests',
     version=__version__,
     description="A colorful Django Test Runner.",
-    long_description=open('README.rst').read(),
+    long_description=io.open('README.md', encoding='utf-8').read(),
+    long_description_content_type='text/markdown',
     author='Brad Montgomery',
     author_email='brad@bradmontgomery.net',
     url='https://github.com/bradmontgomery/django-rainbowtests',
     license='MIT',
     packages=['rainbowtests'],
     include_package_data=True,
-    package_data={'': ['README.rst', 'LICENSE.txt']},
+    package_data={'': ['README.md', 'LICENSE.md']},
     zip_safe=False,
     install_requires=['django'],
     classifiers=[