Requirements and installation

Requirements

Plumage-py

Plumage-py requires Python 3. It was coded using Python 3.8.6 (at least 3.6 required); later releases of Python 3 will probably also work. As of version 1.4.0, Python 2 is no longer supported.

For XML support, Plumage-py uses the lxml Python module, which must be installed prior to using Plumage-py. Plumage was developed and tested with lxml V4.6.2, although I expect that most earlier releases (any release supporting XSLT) will also work. lxml is available at http://lxml.de/; installation instrctions are at https://lxml.de/installation.html .

Plumage-dotnet

Plumage-dotnet requires the the Microsoft .NET Framework 4.5.3 or later. 4.5.3 was the first release of the .NET framework to support the ZIP file format in which the PTO delivers its TSDR data. The current release of the .NET framework is available at http://www.microsoft.com/net .

Installation

Plumage-py

To install Plumage-py:

1. Install lxml (see "Requirements", above) if not already installed.

2. Download the Plumage-py code. For convenience, you can download a .zip file of the most current release from the Plumage-py releases page.

3. Unzip the file. You will find a directory named Plumage containing five files:

   • __init__.py
   • plumage.py
   • ST66.xsl
   • ST96.xsl
   • Plumage-XSLT-metadata.json

4. Copy the Plumage directory to a directory in your PYTHONPATH. For testing purposes, you may wish to create the directory as a subdirectory in the same location as your test application. For general use, you will probably want to place it in the Libs / site-packages directory.

Plumage-dotnet

To install Plumage-dotnet from source:

1. In Visual Studio, create a Library project named Plumage.
2. Add the files TSDRReq.cs, ST66.xsl, ST96.xsl and Plumage-XSLT-metadata.json.
3. In Visual Studio, open TSDRReq.cs and add the files ST66.xsl, ST96.xsl, and Plumage-XSLT-metadata.json as resources; save.
4. Compile.

Use the resulting DLL as you would any other.

If you do not wish to compile from source, you can download a .dll file of the most current release from the Plumage-dotnet releases page. Unzip the zip file and copy the Plumage.dll file to the location needed.