Difference between revisions of "Getting Started with the EPrints Bazaar"

From EPrints Documentation
Jump to: navigation, search
m (mention gitaar)
m (make downloading a sub of command line usage)
Line 46: Line 46:
 
TODO: find out what v= actually does.
 
TODO: find out what v= actually does.
  
== Downloading ==
+
=== Downloading ===
  
 
Command to download a bazaar plugin manually requires setting a custom Accept header. Failing to do so will show the html version of the page.
 
Command to download a bazaar plugin manually requires setting a custom Accept header. Failing to do so will show the html version of the page.

Revision as of 04:02, 26 September 2018


EPrints Bazaar uses EPrints Package Manager to manage EPM packages. EPrints Package Manager has slightly different functionality via web and command line but in both cases they perform the same essential tasks:

  • install
  • update
  • disable

EPM via web will also download the package; EPM via command line can only install an epm package downloaded by other means.


Commandline usage

epm' lives in tools/epm.

Gitaar is available from Eprints User Group and eases the process of installing an EPM from git - for example a pre release or work in progress.

Non eprints utilities

There are a couple of reasons you might want to know how to search and download without using the eprints supplied tools:

  • tools/epm in eprints 3.3 doesn't support searching
  • tools/epm in eprints 3.3 doesn't support downloading
  • you might want to check for updates via cron and email a warning

Search

Encoded in the eprints source are two URIs which can be used for searching, simple and simple2. simple2 accepts an optional parameter v.

In all examples, q= is the value to search for.

style 1

curl --location "http://bazaar.eprints.org/cgi/search?output=EPMI2&q=DOI”

Use curl —location to follow redirection to /cgi/search/simple as is done by eprints.


style 2

optional parameter v not included, equivalent to v=_all

curl "http://bazaar.eprints.org/cgi/search/simple2?output=EPMI2&q_merge=ALL&q=DOI"

v set to 'tbc', this returns an empty list.

curl "http://bazaar.eprints.org/cgi/search/simple2?output=EPMI2&q_merge=ALL&v=tbc&q=DOI"

TODO: find out what v= actually does.

Downloading

Command to download a bazaar plugin manually requires setting a custom Accept header. Failing to do so will show the html version of the page.

 curl -H "Accept: application/vnd.eprints.epm+xml" http://bazaar.eprints.org/id/eprint/545


Developing

See available guides in the EPrints Bazaar wiki category.