PHPackages opencultureconsulting/simple-oai-pmh - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. opencultureconsulting/simple-oai-pmh Abandoned → [opencultureconsulting/oai-pmh2](/?search=opencultureconsulting%2Foai-pmh2)ArchivedProject[API Development](/categories/api) opencultureconsulting/simple-oai-pmh ==================================== This is a stand-alone and easy to install data provider implementing the Open Archives Initiative's Protocol for Metadata Harvesting (OAI-PMH). v1.8(1y ago)186811[1 PRs](https://github.com/opencultureconsulting/simple-oai-pmh/pulls)GPL-3.0-or-laterPHPPHP 7.4.\*|8.0.\*|8.1.\*|8.2.\* Since Jan 24Pushed 8mo ago3 watchersCompare [ Source](https://github.com/opencultureconsulting/simple-oai-pmh)[ Packagist](https://packagist.org/packages/opencultureconsulting/simple-oai-pmh)[ Docs](https://github.com/opencultureconsulting/simple-oai-pmh)[ RSS](/packages/opencultureconsulting-simple-oai-pmh/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)DependenciesVersions (7)Used By (0) Caution This repository was archived and is no longer maintained. Please consider using [**opencultureconsulting/oai-pmh2**](https://github.com/opencultureconsulting/oai-pmh2/) instead! Simple OAI-PMH 2.0 Data Provider ================================ [](#simple-oai-pmh-20-data-provider) This is a stand-alone and easy to install data provider implementing the [Open Archives Initiative's Protocol for Metadata Harvesting (OAI-PMH)](https://openarchives.org/pmh/). It serves records in any metadata format from directories of XML files using the directory name as `metadataPrefix`, the filename as `identifier` and the filemtime as timestamp. 0-byte files are considered deleted records and handled accordingly. Resumption tokens are managed using files. Sets are currently not supported. Just put the records as XML files in the data directory, adjust a few configuration settings and you are ready to go! A demo installation can be found [here](https://demo.opencultureconsulting.com/simple-oai-pmh/?verb=Identify). [![Codacy Badge](https://camo.githubusercontent.com/1761851d82a573cdaf9240ec4e7bcbd840ab2b3855f95314c0deedd2178392a3/68747470733a2f2f6170692e636f646163792e636f6d2f70726f6a6563742f62616467652f47726164652f3761313230323236313164303437616439656639613063336161646239383661)](https://www.codacy.com/gh/opencultureconsulting/simple-oai-pmh) Installation ------------ [](#installation) 1. Run `composer create-project opencultureconsulting/simple-oai-pmh `. 2. Create a data directory in a location not publicly accessible (i. e. outside of ``). Create a subdirectory inside the specified data directory for every format (i. e. `metadataPrefix`) you want to provide. 3. Copy `Configuration/Main.template.php` to `Configuration/Main.php` and edit the settings according to your preferences. Don't forget pointing `$config['dataDirectory']` to your newly created data directory. 4. Put the records into the respective directories according to their format. Each record has to be a separate XML file with its `identifier` as filename (e. g. the file *12345678.xml* can be adressed using the `identifier` *12345678*). Optionally you can maintain deletions by keeping 0-byte files for deleted records. 5. Congratulations! Now you are running your own Simple OAI-PMH 2.0 Data Provider. You can access the entry point by calling `index.php?verb=Identify` in your browser. Upgrading --------- [](#upgrading) 1. Backup `Configuration/Main.php`! 2. Delete `` and re-install by running `composer create-project opencultureconsulting/simple-oai-pmh `. 3. Move your configuration back into `Configuration/Main.php`. 4. Congratulations! Now you are running the newest version of the Simple OAI-PMH 2.0 Data Provider. You can access the entry point by calling `index.php?verb=Identify` in your browser. Updating -------- [](#updating) Updating your records is just as easy with the `update.php` script! The script automatically handles deletions by maintaining 0-byte files for deleted records. Just call `php update.php` from the command line and follow the instructions. (Of course, you can simply replace the records manually as well.) History ------- [](#history) This project was originally initiated in 2002 by [Heinrich Stamerjohanns](mailto:stamer@uni-oldenburg.de) at [University of Oldenburg](https://www.uni-oldenburg.de/en/). His latest implementation can still be found via the [Internet Archive's Wayback Machine](https://web.archive.org/web/*/http://physnet.uni-oldenburg.de/oai/). It was then modified in 2011 by [Jianfeng Li](mailto:jianfeng.li@adelaide.edu.au) at [University of Adelaide](https://www.adelaide.edu.au/) for [The Plant Accelerator](https://www.plantphenomics.org.au/). The modified version can be found in the [Google Code Archive](https://code.google.com/archive/p/oai-pmh-2/). In 2013 [Daniel Neis Araujo](mailto:danielneis@gmail.com) at [Federal University of Santa Catarina](https://en.ufsc.br/) modified the project again in order to integrate it with [Moodle](https://moodle.org/). His implementation can be found on [GitHub](https://github.com/danielneis/oai_pmh). In 2014 [Kazimierz Pietruszewski](mailto:antenna@antenna.io) provided some [further bugfixes](https://github.com/antennaio/oai_pmh). The current implementation was derived from the latter in 2017 by [Sebastian Meyer](mailto:sebastian.meyer@opencultureconsutling.com) at [Open Culture Consulting](https://www.opencultureconsulting.com/) for the [German Literature Archive](https://www.dla-marbach.de/en/). It is a stand-alone version focused on easy deployment and file based record handling. ### Health Score 42 — FairBetter than 90% of packages Maintenance47 Moderate activity, may be stable Popularity21 Limited adoption so far Community15 Small or concentrated contributor base Maturity73 Established project with proven stability Bus Factor1 Top contributor holds 89.7% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~314 days Recently: every ~251 days Total 6 Last Release 726d ago PHP version history (3 changes)v1.4PHP ^7.0 v1.7PHP ^7.0|^8.0 v1.8PHP 7.4.\*|8.0.\*|8.1.\*|8.2.\* ### Community Maintainers ![](https://www.gravatar.com/avatar/4cb1792455fb3e8e6d9345ec2665d661a011463a58d42db73ce4ae4ceb358c95?d=identicon)[Sebastian Meyer](/maintainers/Sebastian%20Meyer) --- Top Contributors [![sebastian-meyer](https://avatars.githubusercontent.com/u/1798167?v=4)](https://github.com/sebastian-meyer "sebastian-meyer (104 commits)")[![danielneis](https://avatars.githubusercontent.com/u/17608?v=4)](https://github.com/danielneis "danielneis (11 commits)")[![scottlimmer](https://avatars.githubusercontent.com/u/23328069?v=4)](https://github.com/scottlimmer "scottlimmer (1 commits)") --- Tags code4libdata-provideroaioai-pmhphprepositoryrepositoryOAI-PMHdata providerOAIcode4lib ### Embed Badge ![Health badge](/badges/opencultureconsulting-simple-oai-pmh/health.svg) ``` [![Health](https://phpackages.com/badges/opencultureconsulting-simple-oai-pmh/health.svg)](https://phpackages.com/packages/opencultureconsulting-simple-oai-pmh) ``` ### Alternatives [twilio/sdk A PHP wrapper for Twilio's API 1.6k92.9M272](/packages/twilio-sdk)[caseyamcl/phpoaipmh A PHP OAI-PMH 2.0 Harvester library 77184.4k4](/packages/caseyamcl-phpoaipmh)[tobion/openapi-symfony-routing Loads routes in Symfony based on OpenAPI/Swagger annotations 4219.5k](/packages/tobion-openapi-symfony-routing)[erasys/openapi-php Open API 3.0 builder and validation library for PHP that helps you write valid specs. 2080.3k5](/packages/erasys-openapi-php) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)