tracking of upstream project metadata

Project description

Upstream Ontologist

The upstream ontologist provides a common interface for finding metadata about upstream software projects.

It will gather information from any sources available, prioritize data that it has higher confidence in as well as report the confidence for each of the bits of metadata.

The ontologist originated in Debian and the currently reported metadata fields are loosely based on DEP-12, but it is meant to be distribution-agnostic.

Provided Fields

Standard fields:

Homepage: homepage URL
Name: human name of the upstream project
Contact: contact address of some sort of the upstream (e-mail, mailing list URL)
Repository: VCS URL
Repository-Browse: Web URL for viewing the VCS
Bug-Database: Bug database URL (for web viewing, generally)
Bug-Submit: URL to use to submit new bugs (either on the web or an e-mail address)
Screenshots: List of URLs with screenshots
Archive: Archive used - e.g. SourceForge
Security-Contact: e-mail or URL with instructions for reporting security issues
Documentation: Link to documentation on the web

Extensions for upstream-ontologist, not defined in DEP-12:

X-SourceForge-Project: sourceforge project name
X-Wiki: Wiki URL
X-Summary: one-line description of the project
X-Description: longer description of the project
X-License: Single line license (e.g. "GPL 2.0")
X-Copyright: List of copyright holders
X-Version: Current upstream version
X-Security-MD: URL to markdown file with security policy
X-Author: List of people who contributed to the project
X-Maintainer: The maintainer of the project

Supported Data Sources

At the moment, the ontologist can read metadata from the following upstream data sources:

Python package metadata (PKG-INFO, setup.py, setup.cfg, pyproject.timl)
package.json
composer.json
package.xml
Perl package metadata (dist.ini, META.json, META.yml, Makefile.PL)
Perl POD files
GNU configure files
R DESCRIPTION files
Rust Cargo.toml
Maven pom.xml
metainfo.xml
.git/config
SECURITY.md
DOAP
Haskell cabal files
go.mod
ruby gemspec files
nuspec files
OPAM files
Debian packaging metadata (debian/watch, debian/control, debian/rules, debian/get-orig-source.sh, debian/copyright, debian/patches)
Dart's pubspec.yaml
meson.build

It will also scan README and INSTALL for possible upstream repository URLs (and will attempt to verify that those match the local repository).

In addition to local files, it can also consult external directories using their APIs:

Example Usage

The easiest way to use the upstream ontologist is by invoking the guess-upstream-metadata command in a software project:

$ guess-upstream-metadata ~/src/dulwich
X-Security-MD: https://github.com/dulwich/dulwich/tree/HEAD/SECURITY.md
Name: dulwich
X-Version: 0.20.15
Bug-Database: https://github.com/dulwich/dulwich/issues
Repository: https://www.dulwich.io/code/
X-Summary: Python Git Library
Bug-Submit: https://github.com/dulwich/dulwich/issues/new

Alternatively, there is a Python API. There are also autocodemeta and autodoap commands that can generate output in the codemeta and DOAP formats, respectively.

Project details

Release history Release notifications | RSS feed

0.2.1

Nov 3, 2024

0.2.0

Oct 19, 2024

0.1.38

Aug 20, 2024

0.1.37

Jun 29, 2024

0.1.36

Sep 11, 2023

0.1.35

Feb 10, 2023

This version

0.1.34

Feb 1, 2023

0.1.33

Jan 27, 2023

0.1.32

Jan 6, 2023

0.1.31

Dec 10, 2022

0.1.30

Nov 1, 2022

0.1.29

Nov 1, 2022

0.1.28

Nov 1, 2022

0.1.27

Oct 20, 2022

0.1.26

Aug 24, 2022

0.1.25

Mar 5, 2022

0.1.24

Dec 26, 2021

0.1.23

Oct 23, 2021

0.1.22

Jun 13, 2021

0.1.21

Jun 13, 2021

0.1.20

Jun 9, 2021

0.1.19

May 19, 2021

0.1.18

Apr 9, 2021

0.1.17

Apr 3, 2021

0.1.16

Mar 26, 2021

0.1.15

Mar 22, 2021

0.1.14

Mar 16, 2021

0.1.13

Mar 13, 2021

0.1.12

Mar 9, 2021

0.1.11

Feb 24, 2021

0.1.10

Feb 17, 2021

0.1.9

Feb 12, 2021

0.1.8

Feb 10, 2021

0.1.7

Feb 5, 2021

0.1.6

Jan 31, 2021

0.1.5

Jan 30, 2021

0.1.4

Jan 30, 2021

0.1.3

Jan 30, 2021

0.1.2

Jan 30, 2021

0.1.1

Dec 10, 2020

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

upstream-ontologist-0.1.34.tar.gz (102.6 kB view details)

Uploaded Feb 1, 2023 Source

Built Distribution

upstream_ontologist-0.1.34-py3-none-any.whl (61.3 kB view details)

Uploaded Feb 1, 2023 Python 3

File details

Details for the file upstream-ontologist-0.1.34.tar.gz.

File metadata

Download URL: upstream-ontologist-0.1.34.tar.gz
Upload date: Feb 1, 2023
Size: 102.6 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.2 CPython/3.11.1

File hashes

Hashes for upstream-ontologist-0.1.34.tar.gz
Algorithm	Hash digest
SHA256	`a00d7053996a23e5936cc7ba959cc12eb23c4102707992d80552ca256ac58a45`
MD5	`5afca2bcee135fb5c62366e4b8211ea2`
BLAKE2b-256	`deb92e9664266179390c250fd81a8f027be40acd7ff2cd1cb5cb11b2154d9f1d`

See more details on using hashes here.

File details

Details for the file upstream_ontologist-0.1.34-py3-none-any.whl.

File metadata

Download URL: upstream_ontologist-0.1.34-py3-none-any.whl
Upload date: Feb 1, 2023
Size: 61.3 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.2 CPython/3.11.1

File hashes

Hashes for upstream_ontologist-0.1.34-py3-none-any.whl
Algorithm	Hash digest
SHA256	`9c278bea5f23473089f34e3feb34a7811bfbb1f20cef003b7548820b5b782bfb`
MD5	`6c0ecd9c97e5045415f282586ad91ff4`
BLAKE2b-256	`bc5c382e82f4dfca37926a19a858af7649f9f11f5dfd0f27e0757a4bce58fc0d`