illgrenoble/datacite-doi-bundle

A symfony 2 bundle for communicating with the datacite.org API for minting DOIs and storing metadata for the datasets.

dev-master 2016-08-03 07:38 UTC

Requires

• php: >=5.3.2
• jms/serializer-bundle: 0.13.*
• symfony/framework-bundle: >=2.1
• versionable/prospect: 1.0.*@dev

Requires (Dev)

• monolog/monolog: 1.5.*@dev
• symfony/finder: 2.1.*
• symfony/validator: 2.1.*@dev
• symfony/yaml: 2.1.*@dev

MIT

• Jamie Hall

• doi
• datacite

README

At the moment this bundle is not stable. It is being actively developed.

A symfony 2 bundle for communicating with the mds.datacite.org API to mint DOIs and register associated metadata.

Note

In order to use the API, it requires organisations to first register for an account with a DataCite member.

This bundle has only been tested with Symfony 2.1. If you would like it to work with a Symfony 2.0 project then please fork the repository and modify the code.

Documentation

The bulk of the documentation is stored in the Resources/doc/index.md

Installation

Installation is a quick (I promise!) three step process:

1. Download ILLDataCiteDOIBundle using composer
2. Enable the Bundle
3. Configure your application's config.yml

Step 1: Download ILLDataCiteDOIBundle using composer

Add FOSUserBundle in your composer.json:

{
    "require": {
        "illgrenoble/datacite-doi-bundle": "*"
    }
}

Now tell composer to download the bundle by running the command:

$ php composer.phar update illgrenoble/datacite-doi-bundle

Composer will install the bundle to your project's vendor/illgrenoble directory.

Step 2: Enable the bundle

Enable the bundle in the kernel:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new ILL\DataCiteDOIBundle\ILLDataCiteDOIBundle(),
    );
}

Step 2: Configure your application's config.yml

ill_data_cite_doi:
   username: DataCiteMDSUsername
   password: DataCiteMDSPassword
   prefix:   YourFacilityPrefix
   proxy: ~

License

This bundle is under the MIT license. The license is stored in Resources/meta/LICENSE

Authors

Mr. Jamie Hall - Technical Projects group at Institut Laue-Langevin.