Skip to content

Commit 055871d

Browse files
mpasternakclaude
andcommitted
Add badges, version matrix, license section, and fix readme reference
- Added Python version and BSD-3-Clause license badges - Added supported Python versions table - Added pip install alternative alongside uv - Added license section at bottom - Fixed pyproject.toml readme field pointing to ABOUT.txt → README.md Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent c9103e9 commit 055871d

2 files changed

Lines changed: 21 additions & 6 deletions

File tree

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# MOAI — Open Access Server Platform for Institutional Repositories
22

33
[![Tests](https://github.com/iplweb/moai-iplweb/actions/workflows/test.yml/badge.svg)](https://github.com/iplweb/moai-iplweb/actions/workflows/test.yml)
4+
![Python Version](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fiplweb%2Fmoai-iplweb%2Fmain%2Fpyproject.toml)
5+
[![License](https://img.shields.io/badge/license-BSD--3--Clause-blue.svg)](LICENSE.txt)
46

57
MOAI is a platform for aggregating content from different sources and publishing it through the [Open Archive Initiative Protocol for Metadata Harvesting](http://www.openarchives.org/pmh/) (OAI-PMH). It can harvest data from various sources — OAI feeds, SQL databases, XML files, Fedora Commons, EPrints, DSpace — and serve multiple OAI feeds from a single server, each with independent configuration.
68

@@ -17,19 +19,28 @@ This is a maintained fork of [MOAI by Infrae](https://github.com/infrae/moai/),
1719
1820
## Installation
1921

20-
MOAI is a normal Python package. It is tested with Python 3.9, 3.10, 3.11, 3.12, 3.13.
21-
We recommend using [uv](https://docs.astral.sh/uv/) for dependency management.
22+
### Supported Python versions
2223

23-
Instructions below are for Unix, but MOAI should also work on Windows.
24+
| Python | 3.9 | 3.10 | 3.11 | 3.12 | 3.13 |
25+
|--------|-----|------|------|------|------|
26+
| ||||||
2427

25-
Install MOAI using uv:
28+
We recommend using [uv](https://docs.astral.sh/uv/) for dependency management. Instructions below are for Unix, but MOAI should also work on Windows.
29+
30+
### Using uv (recommended)
2631

2732
```bash
2833
cd moai
2934
uv sync
3035
```
3136

32-
To run tests:
37+
### Using pip
38+
39+
```bash
40+
pip install MOAI-iplweb
41+
```
42+
43+
### Running tests
3344

3445
```bash
3546
uv sync --extra test
@@ -177,3 +188,7 @@ So a return value would look like:
177188
...}
178189
}
179190
```
191+
192+
## License
193+
194+
BSD-3-Clause — see [LICENSE.txt](LICENSE.txt) for details.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
66
name = "MOAI-iplweb"
77
version = "2.0.0"
88
description = "MOAI, A Open Access Server Platform for Institutional Repositories"
9-
readme = "ABOUT.txt"
9+
readme = "README.md"
1010
license = "BSD-3-Clause"
1111
requires-python = ">=3.9"
1212
authors = [

0 commit comments

Comments
 (0)