Find file History
Latest commit e213ab9 Jul 14, 2016 @umlaeute umlaeute removed unused code
Permalink
..
Failed to load latest commit information.
server
windows
README.md
builder.md
config.md
deken
deken.hy
requirements.txt

README.md

Developers

You can use the deken command line tool to create packaged zipfiles with the correct searchable architectures in the filename, for example freeverb~-v0.1-(Linux-amd64-64)-externals.zip.

If you don't want to use the deken packaging tool you can zip and upload the files yourself. See the "Filename format" section below.

Get started

$ curl https://raw.githubusercontent.com/pure-data/deken/master/developer/deken > ~/bin/deken
$ chmod 755 ~/bin/deken
$ deken
This is your first time running deken on this machine.
I'm going to install myself and my dependencies into ~/.deken now.
Feel free to ctrl-C now if you don't want to do this.
...

See config.md for deken's configuration file format.

Create and Upload a package

You have a directory containing your compiled externals object files called my_external.

This command will create a file like my_external-v0.1-(Linux-amd64-64)-externals.zip and upload it to your account on http://puredata.info/ where the search plugin can find it:

$ deken package -v 0.1 my_external
$ deken upload my_external

You can also just call the 'upload' directly and it will call the package command for you in one step:

$ deken upload -v 0.1 my_external

The upload step will also generate a .sha256 checksum file and upload it along with the zip file.

Creating/Uploading packages on a different machine

deken inspects the files in the directory to determine the target platform (rather than just checking on which system you are currently runing). Therefore, if it is not feasible to install deken on the machine used for building your Pd library, you can run deken on another machine,

Example: You build the "my_external" library on OSX-10.5, but (due to OSX-10.5 not being supported by Apple anymore) you haven't installed deken there. So you simply transfer the "my_external" directory to your linux machine, where you run deken package my_external and it will magically create the my_external-v3.14-(Darwin-i386-32)(Darwin-x86_64-32)-externals.tgz file for you, ready to be uploaded.

Filename format

The deken tool names a zipfile of externals binaries with a specific format to be optimally searchable on puredata.info;

LIBNAME[-vVERSION-]{(ARCH)}-externals.EXT
  • LIBNAME is the name of the externals package ("zexy", "cyclone", "freeverb~").
  • VERSION contains the version information for the end use (this information is optional though strongly encouraged)
  • ARCH is the architecture specifier, and can be given multiple times (once for each type of architecture the externals are compiled for within this archive). It is either "Sources" (see below or OS-MARCH-BIT, with:
    • OS being the Operating System (Linux, Darwin, W32`,...)
    • MARCH is the machine architecture (e.g. x86_64)
    • BIT is some number of bits (e.g. 64)
  • EXT is the archive extension (either zip or tar.gz)

Note that the archive should contain a single directory at the top level with NAME the same as the externals package itself. For example a freeverb~ externals package would contain a directory "freeverb~" at the top level of the zipfile in which the externals live.

The square brackets around the "-vVERSION-" section are to indicate it is optional, don't include them. The same goes for the curly braces around the "(ARCH)" (indicating that this section can be repeated multiple times). However, the round parentheses "()" around architectures must be included to separate the architectures visibly from each other.

In plain english this means:

the library-name, followed by an optional version string (starting with -v and ending with -), followed by zero or more architecture specifications (each surrounded by (parantheses)), and terminated by -externals (followed by a filename extension).

Here is the actual regular expression used:

(.*/)?(.+?)(-v(.+)-)?((\([^\)]+\))+|-)*-externals\.([a-z.]*)

with the following matching groups:

  • #0 anything before the path (always empty and ignored)
  • #1 = path to filename (ignored)
  • #2 = library name
  • #3 = version string with decoration (ignored)
  • #4 = version
  • #5 = archs
  • #6 = last arch in archs (ignored)
  • #7 = extension
  • #8 anything after the extension (should be empty and is ignored)

Some examples:

adaptive-v0.0.extended-(Linux-i386-32)(Linux-amd64-64)-externals.tar.gz
adaptive-v0.0.extended-(Sources)-externals.tar.gz
freeverb~(Darwin-i386-32)(Darwin-x86_64-32)(Sources)-externals.zip
list-abs-v0.1--externals.zip

Sourceful uploads

deken is very much about sharing. To make sharing a more lasting experience, deken encourages the upload of "source-packages" besides (pre-compiled) binary packages.

This is especially important if you are uploading a library that has been released under a license that requires you to share sources along with binaries (e.g. software licensed under the Gnu GPL), where it is your obligation to provide the source code to the end users. In other situations, having Source packages might be less important (e.g. it is fine to use deken with closed source libraries), however we would like to encourage sharing of sources.

The way deken implements all this is by using a special pseudo architecture "Sources", which contains the sources of a library.

deken package tries to automatically detect whether a package contains Sources by looking for common source code files (*.c, *.cpp, ...).

When uploading a package, deken will ensure that you are also uploading a Source package of any library. If a Source package is missing, deken will abort operation. You can override this (e.g. because you have already uploaded a Source package; or because you simply do not want to upload any sources) by using the --no-source-error flag.

For uploading a Source package along with binary packages, you can upload one package file with multiple archs (including a "Sources" arch) or multiple package files (one for the "Sources" arch).

deken upload frobnozzel(Windows-i386-32)(Sources)-externals.zip
deken upload foobar-v0.1-(Linux-x86_64-64)-externals.tgz foobar-v0.1-(Sources)-externals.tgz

Upgrade

$ deken upgrade
... self upgrades the scripts ...

Show help

$ deken -h

Platform

OSX Example

$ deken --platform
Darwin-i386-64bit

Linux example

$ deken --platform
Linux-x86_64-64bit-ELF

Raspbian

$ deken --platform
Linux-armv6l-32bit-ELF