Skip to content

Entry points (or API endpoints) extension for codemeta? #183

@proycon

Description

@proycon

Schema.org defines EntryPoint as an entrypoint (a URL in some web-based protocol) to software described by the (EntryPoint.actionApplication) property.

Python Packages also define entrypoints in their metadata (see https://github.com/proycon/codemetapy/blob/master/setup.py#L35 for example), referring to the command line scripts that will be installed and bound to execute a particular function in a python module. I would like to represent this in codemeta but come across a few issues:

  1. schema.org EntryPoints are currently rather web-centered and do not take command line tools into consideration, I could cheat this a bit by simply using the file:/// scheme in the URL to reference an executable script, but that is probably not the most elegant solution. Is more needed? Ideally, I'd be in favour of some kind of interfaceType property on EntryPoint (with values like command line interface, graphical user interface, text user interface, web-user interface, webservice interface).
  2. There is only the EntryPoint.actionApplication property, I am missing a reverse property on SoftwareApplication or SoftwareSourceCode to link to entrypoints, I'd propose something simple like codemeta:entryPoints.
  3. Though this is not my take on it, one might argue that command line entrypoints could/should be SoftwareApplication in their own right?

I have implemented 1) and 2) as an optional extension in the brand new Python Codemeta tool (#182).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions