annorepo-client

A Python client for accessing an AnnoRepo server

Provided tools & services

version

Type
  • Command-line Application
Executable name
version

Tool suite: AnnoRepo

The following closely related tools are in a tool suite together with annorepo-client:

  • Web API
  • Experimental: The technology is implemented and ready for experimental settings (beta), but requires further work and validation.
  • Active: The project has reached a stable, usable state and is being actively developed.

AnnoRepo 0.6.2

Implementation of W3C Web Annotation Protocol (root project) [view more]
  • web-annotation
  • web-annotation-protocol
Created: 2022-03-24
Modified: 2024-02-02

Citation

You can cite this software using the following citation generated from its metadata:

(2023) annorepo-client 0.1.3 .
  • (KNAW Humanities Cluster)
.

Logs & Reviews

Name
Automatic software metadata validation report for annorepo-client 0.1.3
Author
  • codemetapy validator using software.ttl
Date
2024-02-25 03:01:30
Review
Please consult the CLARIAH Software Metadata Requirements at https://github.com/CLARIAH/clariah-plus/blob/main/requirements/software-metadata-requirements.md for an in-depth explanation of any found problems

Validation of annorepo-client 0.1.3 was successful (score=4/5), but there are some remarks which you may or may not want to address:

1. Info: Software source code *SHOULD* link to a continuous integration service that builds the software and runs the software's tests (This is missing in the metadata)
2. Info: Reference publications *SHOULD* be expressed, if any (This is missing in the metadata)
3. Info: The funder *SHOULD* be acknowledged (This is missing in the metadata)
Rating
★ ★ ★ ★ ☆
(log file starts at Sun Feb 25 03:01:01 UTC 2024)

[harvester info] --> Processing annorepo-client (https://github.com/knaw-huc/annorepo-python-client) [Sun Feb 25 03:01:01 UTC 2024]

[harvester info] Git updating cached clone of https://github.com/knaw-huc/annorepo-python-client...

[harvester info] Found release 0.1.3

[harvester info] Using '0.1.3'

[harvester info] Git reference: 0.1.3

[harvester info] Scanning directory /tmp/codemeta-harvester.cache/annorepo-client for harvestable resources...

[harvester info] found python setup for annorepo-client, converting to codemeta

[harvester info] Looking for license....

[harvester info] Found license MIT

[harvester info] Parsing MAINTAINERS...

[harvester info] Parsing AUTHORS...

[harvester info] Parsing CONTRIBUTORS...

[harvester info] Getting top contributor from git...

[harvester info] Git top contributor Bram Buitendijk <bram.buitendijk@di.huc.knaw.nl> will be assigned as author (and maintainer) if none are found in the metadata

[harvester info] Extracting last and first commit date from git log....

[harvester info] Date created: 2022-04-07T12:02:03Z+0200, date modified: 2023-11-29T16:33:58Z+0100

[harvester info] Querying Github/GitLab API (https://github.com/knaw-huc/annorepo-python-client)

[harvester info] Adding URL for found README: README.md

[harvester info] Found releaseNotes

[harvester info] Querying Zenodo API for DOI (access token provided)...

[harvester info] Looking for TRL information in README.md...

[harvester info] Looking for repostatus information in README.md...

[harvester info] Found repostatus https://www.repostatus.org/#wip

[harvester info] Looking for continuous integration information in README.md...

[harvester info] Looking for documentation links in README.md...

[harvester info] Scraping title from https://annorepo-python-client.readthedocs.io/en/latest/

[harvester info] Found documentation at https://annorepo-python-client.readthedocs.io/en/latest/ : "name": "annorepo-client — annorepo-python-client latest documentation",

[harvester info] Scraping title from https://annorepo-python-client.readthedocs.io/en/latest/?badge=latest

[harvester info] Found documentation at https://annorepo-python-client.readthedocs.io/en/latest/?badge=latest : "name": "annorepo-client — annorepo-python-client latest documentation",

[harvester info] Falling back to git tag (0.1.3) if no version number is specified...

[harvester info] Inferring repostatus information from git activity (used only as a fallback if not explicitly provided)...

[harvester info] Inferred repostatus https://www.repostatus.org/#active

[harvester info] Looking for repostatus information in README.md in master branch...

[harvester info] Found repostatus (master branch) https://www.repostatus.org/#wip

[harvester info] Parsing MAINTAINERS from master branch...

[harvester info] Setting group AnnoRepo

[harvester info] Reconciliating: codemetapy  --baseuri https://tools.clariah.nl --baseuri https://tools.clariah.nl --includecontext --addcontext https://w3id.org/nwo-research-fields --addcontext https://w3id.org/research-technology-readiness-levels --addcontextgraph https://vocabs.dariah.eu/rest/v1/tadirah/data?format=text/turtle --trl --identifier "annorepo-client" --codeRepository "https://github.com/knaw-huc/annorepo-python-client" --validate /etc/software.ttl --released --enrich --textv "Please consult the CLARIAH Software Metadata Requirements at https://github.com/CLARIAH/clariah-plus/blob/main/requirements/software-metadata-requirements.md for an in-depth explanation of any found problems" -O /tmp/out/annorepo-client.codemeta.json /tmp/codemeta-harvester.cache//tmp/99-version.annorepo-client.codemeta.json /tmp/codemeta-harvester.cache//tmp/99-repostatus.annorepo-client.codemeta.json /tmp/codemeta-harvester.cache//tmp/90-authors.annorepo-client.codemeta.json /tmp/codemeta-harvester.cache//tmp/50-documentation.annorepo-client.codemeta.json /tmp/codemeta-harvester.cache//tmp/43-releasenotes.annorepo-client.codemeta.json /tmp/codemeta-harvester.cache//tmp/41-readme.annorepo-client.codemeta.json /tmp/codemeta-harvester.cache//tmp/40-gitapi.annorepo-client.codemeta.json /tmp/codemeta-harvester.cache//tmp/39-gitdate.annorepo-client.codemeta.json /tmp/codemeta-harvester.cache//tmp/32-contributors.annorepo-client.codemeta.json /tmp/codemeta-harvester.cache//tmp/31-authors.annorepo-client.codemeta.json /tmp/codemeta-harvester.cache//tmp/30-maintainers.annorepo-client.codemeta.json /tmp/codemeta-harvester.cache//tmp/29-license.annorepo-client.codemeta.json /tmp/codemeta-harvester.cache//tmp/20-python.annorepo-client.codemeta.json /tmp/codemeta-harvester.cache//tmp/11-repostatus.annorepo-client.codemeta.json /tmp/codemeta-harvester.cache//tmp/05-repostatus.annorepo-client.codemeta.json /tmp/codemeta-harvester.cache//tmp/05-maintainers.annorepo-client.codemeta.json /tmp/codemeta-harvester.cache//tmp/04-applicationSuite.annorepo-client.codemeta.json 

-- begin log --

Passed 17 files/sources but specified 0 input types! Automatically guessing types...

Detected input types: [('/tmp/codemeta-harvester.cache//tmp/99-version.annorepo-client.codemeta.json', 'json'), ('/tmp/codemeta-harvester.cache//tmp/99-repostatus.annorepo-client.codemeta.json', 'json'), ('/tmp/codemeta-harvester.cache//tmp/90-authors.annorepo-client.codemeta.json', 'json'), ('/tmp/codemeta-harvester.cache//tmp/50-documentation.annorepo-client.codemeta.json', 'json'), ('/tmp/codemeta-harvester.cache//tmp/43-releasenotes.annorepo-client.codemeta.json', 'json'), ('/tmp/codemeta-harvester.cache//tmp/41-readme.annorepo-client.codemeta.json', 'json'), ('/tmp/codemeta-harvester.cache//tmp/40-gitapi.annorepo-client.codemeta.json', 'json'), ('/tmp/codemeta-harvester.cache//tmp/39-gitdate.annorepo-client.codemeta.json', 'json'), ('/tmp/codemeta-harvester.cache//tmp/32-contributors.annorepo-client.codemeta.json', 'json'), ('/tmp/codemeta-harvester.cache//tmp/31-authors.annorepo-client.codemeta.json', 'json'), ('/tmp/codemeta-harvester.cache//tmp/30-maintainers.annorepo-client.codemeta.json', 'json'), ('/tmp/codemeta-harvester.cache//tmp/29-license.annorepo-client.codemeta.json', 'json'), ('/tmp/codemeta-harvester.cache//tmp/20-python.annorepo-client.codemeta.json', 'json'), ('/tmp/codemeta-harvester.cache//tmp/11-repostatus.annorepo-client.codemeta.json', 'json'), ('/tmp/codemeta-harvester.cache//tmp/05-repostatus.annorepo-client.codemeta.json', 'json'), ('/tmp/codemeta-harvester.cache//tmp/05-maintainers.annorepo-client.codemeta.json', 'json'), ('/tmp/codemeta-harvester.cache//tmp/04-applicationSuite.annorepo-client.codemeta.json', 'json')]

Adding to contextgraph: /tmp/turtle

Initial URI automatically generated, may be overriden later: https://tools.clariah.nl/annorepo-client

Processing source #1 of 17

Parsing json-ld file from /tmp/codemeta-harvester.cache//tmp/99-version.annorepo-client.codemeta.json

    NOTE: Not a valid JSON-LD document, @context missing! Attempting to inject automatically...

    Injected (possibly temporary) URI https://tools.clariah.nl/annorepo-client

[CODEMETA COMPOSITION (https://tools.clariah.nl/annorepo-client)] processed 1 new triples, total is now 2

Processing source #2 of 17

Parsing json-ld file from /tmp/codemeta-harvester.cache//tmp/99-repostatus.annorepo-client.codemeta.json

    NOTE: Not a valid JSON-LD document, @context missing! Attempting to inject automatically...

    Injected (possibly temporary) URI https://tools.clariah.nl/annorepo-client

[CODEMETA COMPOSITION (https://tools.clariah.nl/annorepo-client)] processed 1 new triples, total is now 3

Processing source #3 of 17

Parsing json-ld file from /tmp/codemeta-harvester.cache//tmp/90-authors.annorepo-client.codemeta.json

    Found main resource with URI https://tools.clariah.nl/annorepo-client.topcontributor/snapshot

    Injected (possibly temporary) URI https://tools.clariah.nl/annorepo-client

[CODEMETA COMPOSITION (https://tools.clariah.nl/annorepo-client)] processed 8 new triples, total is now 10

Processing source #4 of 17

Parsing json-ld file from /tmp/codemeta-harvester.cache//tmp/50-documentation.annorepo-client.codemeta.json

    NOTE: Not a valid JSON-LD document, @context missing! Attempting to inject automatically...

    Injected (possibly temporary) URI https://tools.clariah.nl/annorepo-client

[CODEMETA COMPOSITION (https://tools.clariah.nl/annorepo-client)] processed 8 new triples, total is now 18

Processing source #5 of 17

Parsing json-ld file from /tmp/codemeta-harvester.cache//tmp/43-releasenotes.annorepo-client.codemeta.json

    NOTE: Not a valid JSON-LD document, @context missing! Attempting to inject automatically...

    Injected (possibly temporary) URI https://tools.clariah.nl/annorepo-client

[CODEMETA COMPOSITION (https://tools.clariah.nl/annorepo-client)] processed 2 new triples, total is now 20

Processing source #6 of 17

Parsing json-ld file from /tmp/codemeta-harvester.cache//tmp/41-readme.annorepo-client.codemeta.json

    NOTE: Not a valid JSON-LD document, @context missing! Attempting to inject automatically...

    Injected (possibly temporary) URI https://tools.clariah.nl/annorepo-client

[CODEMETA COMPOSITION (https://tools.clariah.nl/annorepo-client)] processed 1 new triples, total is now 21

Processing source #7 of 17

Parsing json-ld file from /tmp/codemeta-harvester.cache//tmp/40-gitapi.annorepo-client.codemeta.json

    Found main resource with URI https://tools.clariah.nl/annorepo-python-client/snapshot

    Injected (possibly temporary) URI https://tools.clariah.nl/annorepo-client

[CODEMETA COMPOSITION (https://tools.clariah.nl/annorepo-client)] processed 12 new triples, total is now 32

Processing source #8 of 17

Parsing json-ld file from /tmp/codemeta-harvester.cache//tmp/39-gitdate.annorepo-client.codemeta.json

    NOTE: Not a valid JSON-LD document, @context missing! Attempting to inject automatically...

    Injected (possibly temporary) URI https://tools.clariah.nl/annorepo-client

[CODEMETA COMPOSITION (https://tools.clariah.nl/annorepo-client)] overriding old http://schema.org/dateCreated (2022-04-07T10:43:58Z -> 2022-04-07T12:02:03Z+0200)

[CODEMETA COMPOSITION (https://tools.clariah.nl/annorepo-client)] overriding old http://schema.org/dateModified (2023-11-30T22:26:05Z -> 2023-11-29T16:33:58Z+0100)

[CODEMETA COMPOSITION (https://tools.clariah.nl/annorepo-client)] processed 2 new triples, total is now 32

Processing source #9 of 17

Parsing json-ld file from /tmp/codemeta-harvester.cache//tmp/32-contributors.annorepo-client.codemeta.json

    Found main resource with URI https://tools.clariah.nl/contributors/snapshot

    Injected (possibly temporary) URI https://tools.clariah.nl/annorepo-client

[CODEMETA COMPOSITION (https://tools.clariah.nl/annorepo-client)] processed 8 new triples, total is now 33

Processing source #10 of 17

Parsing json-ld file from /tmp/codemeta-harvester.cache//tmp/31-authors.annorepo-client.codemeta.json

    Found main resource with URI https://tools.clariah.nl/authors/snapshot

    Injected (possibly temporary) URI https://tools.clariah.nl/annorepo-client

[CODEMETA COMPOSITION (https://tools.clariah.nl/annorepo-client)] processed 8 new triples, total is now 33

Processing source #11 of 17

Parsing json-ld file from /tmp/codemeta-harvester.cache//tmp/30-maintainers.annorepo-client.codemeta.json

    Found main resource with URI https://tools.clariah.nl/maintainers/snapshot

    Injected (possibly temporary) URI https://tools.clariah.nl/annorepo-client

[CODEMETA COMPOSITION (https://tools.clariah.nl/annorepo-client)] processed 6 new triples, total is now 34

Processing source #12 of 17

Parsing json-ld file from /tmp/codemeta-harvester.cache//tmp/29-license.annorepo-client.codemeta.json

    NOTE: Not a valid JSON-LD document, @context missing! Attempting to inject automatically...

    Injected (possibly temporary) URI https://tools.clariah.nl/annorepo-client

[CODEMETA COMPOSITION (https://tools.clariah.nl/annorepo-client)] overriding old http://schema.org/license (http://spdx.org/licenses/MIT -> MIT)

[CODEMETA CORRECTION (https://tools.clariah.nl/annorepo-client)] automatically converting license to spdx URI

[CODEMETA COMPOSITION (https://tools.clariah.nl/annorepo-client)] processed 1 new triples, total is now 34

Processing source #13 of 17

Parsing json-ld file from /tmp/codemeta-harvester.cache//tmp/20-python.annorepo-client.codemeta.json

    Found main resource with URI https://tools.clariah.nl/annorepo-client/0.1.3

    Injected (possibly temporary) URI https://tools.clariah.nl/annorepo-client

[CODEMETA COMPOSITION (annorepo-client)] overriding old https://codemeta.github.io/terms/developmentStatus (https://www.repostatus.org/#active -> https://www.repostatus.org/#concept)

[CODEMETA COMPOSITION (annorepo-client)] overriding old http://schema.org/name (annorepo-python-client -> annorepo-client)

[CODEMETA COMPOSITION (annorepo-client)] processed 85 new triples, total is now 104

Processing source #14 of 17

Parsing json-ld file from /tmp/codemeta-harvester.cache//tmp/11-repostatus.annorepo-client.codemeta.json

    NOTE: Not a valid JSON-LD document, @context missing! Attempting to inject automatically...

    Injected (possibly temporary) URI https://tools.clariah.nl/annorepo-client

[CODEMETA COMPOSITION (annorepo-client)] overriding old https://codemeta.github.io/terms/developmentStatus (https://www.repostatus.org/#concept -> https://www.repostatus.org/#wip)

[CODEMETA COMPOSITION (annorepo-client)] processed 1 new triples, total is now 104

Processing source #15 of 17

Parsing json-ld file from /tmp/codemeta-harvester.cache//tmp/05-repostatus.annorepo-client.codemeta.json

    NOTE: Not a valid JSON-LD document, @context missing! Attempting to inject automatically...

    Injected (possibly temporary) URI https://tools.clariah.nl/annorepo-client

[CODEMETA COMPOSITION (annorepo-client)] processed 1 new triples, total is now 104

Processing source #16 of 17

Parsing json-ld file from /tmp/codemeta-harvester.cache//tmp/05-maintainers.annorepo-client.codemeta.json

    Found main resource with URI https://tools.clariah.nl/maintainers/snapshot

    Injected (possibly temporary) URI https://tools.clariah.nl/annorepo-client

[CODEMETA COMPOSITION (annorepo-client)] processed 6 new triples, total is now 104

Processing source #17 of 17

Parsing json-ld file from /tmp/codemeta-harvester.cache//tmp/04-applicationSuite.annorepo-client.codemeta.json

    NOTE: Not a valid JSON-LD document, @context missing! Attempting to inject automatically...

    Injected (possibly temporary) URI https://tools.clariah.nl/annorepo-client

[CODEMETA COMPOSITION (annorepo-client)] processed 1 new triples, total is now 105

Remapping URI to (possibly) new identifier and version component: https://tools.clariah.nl/annorepo-client -> https://tools.clariah.nl/annorepo-client/0.1.3

[CODEMETA VALIDATION (annorepo-client)] done

[CODEMETA ENRICHMENT (annorepo-client)] automatically adding programmingLanguage Python derived from runtimePlatform Python

VALIDATION https://tools.clariah.nl/annorepo-client/0.1.3 #1: Info: Software source code *SHOULD* link to a continuous integration service that builds the software and runs the software's tests (This is missing in the metadata)

VALIDATION https://tools.clariah.nl/annorepo-client/0.1.3 #2: Info: Reference publications *SHOULD* be expressed, if any (This is missing in the metadata)

VALIDATION https://tools.clariah.nl/annorepo-client/0.1.3 #3: Info: The funder *SHOULD* be acknowledged (This is missing in the metadata)

-- end log --

[harvester info] Output written to /tmp/out/annorepo-client.codemeta.json

[harvester info] <-- Finished processing annorepo-client (https://github.com/knaw-huc/annorepo-python-client) [Sun Feb 25 03:01:31 UTC 2024]

        

Metadata Properties

Version
0.1.3 (release notes)
Interface types
  • Command-line Application
Software website
Source code repository
 https://github.com/knaw-huc/annorepo-python-client  Stars are an indicator of the popularity of this project on GitHub
Development Status
  • Planning: The technology is in an initial planning stage (pre-alpha), no implementation is available yet
  • WIP: Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.
Issue Tracker (Support)
https://github.com/knaw-huc/annorepo-python-client/issues  The number of open issues on the issue tracker  The number of closes issues on the issue tracker
Documentation
License
Author(s)
Maintainer(s)
Contributor(s)
Producer
Programming Language
  • Python
Runtime Platform
  • Python 3
Operating System
  • OS Independent
Software dependencies
  • colorama
  • google
  • google-api-python-client
  • icecream
  • python
  • requests
  • tabulate
Metadata validation
★ ★ ★ ★ ☆
Created
2022-04-07 12:02:03 +0200
Last modified
2023-11-29 16:33:58 +0100  Last commit (main branch). Gives an indication of project development activity and rough indication of how up-to-date the latest release is.  Number of commits since the last release. Gives an indication of project development activity and rough indication of how up-to-date the latest release is.