Data

Tools

Indexes

Applications

Experiments

Open Source Science

pyswh

Python wrapper around the Software Heritage API

https://github.com/sdruskat/pyswh

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 2 committers (50.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.3%) to scientific vocabulary

Keywords from Contributors

mesh sequences interactive hacking
Last synced: 7 months ago · JSON representation ·

Repository

Python wrapper around the Software Heritage API

Basic Info
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 3
  • Releases: 0
Created over 3 years ago · Last pushed almost 3 years ago
Metadata Files
Readme Changelog Contributing License Citation

README.md

pyswh - a Python wrapper library for the Software Heritage API

pyswh aims to wrap interactions with the Software Heritage REST API into a comfortable Python API.

Quality Gate Status Docs build codecov REUSE status

Getting started

Install pyswh via pip:

bash pip install pyswh

Include pyswh in your project by adding a respective dependency to your project, e.g.,

```bash

requirements.txt

pyswh==0.1.0 ```

```toml

Poetry pyproject.toml

[tool.poetry.dependencies] pyswh = "^0.1.0" ```

You can now use pyswh:

```python from pyswh import swh from pyswh import errors as swh_errors

try: swh.save('https://github.com/sdruskat/pyswh', False, 'SWH-API-AUTH-TOKEN') except swh_errors.SwhSaveError as sse: raise sse ```

Refer to the complete documentation to learn more about using pyswh.

Set up for development

Requirements: Python >= 3.10.0.

  1. Install Poetry.

  2. Clone the repository:

bash git clone git@github.com:sdruskat/pyswh.git

  1. Create a virtual environment in .venv: bash python3.10 -m venv .venv

  2. Activate the Poetry shell and install project:

bash poetry shell poetry install

Testing

pyswh uses pytest for testing. To run all tests, do:

bash poetry shell poetry run pytest test/

Building documentation locally

Initialize the Poetry virtual environment with poetry shell, go into the docs/ folder and run make html.

Licensing

See LICENSE.md

Owner

  • Name: Stephan Druskat
  • Login: sdruskat
  • Kind: user
  • Location: Berlin
  • Company: German Aerospace Center (DLR)

Software Engineering PhD candidate @DLR-SC, Research Software Engineer (https://hexatomic.github.io)

Citation (CITATION.cff) 

' SPDX-FileCopyrightText: 2022 Stephan Druskat <pyswh@sdruskat.net>
'
' SPDX-License-Identifier: CC0-1.0

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: pyswh
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Stephan
    family-names: Druskat
    email: pyswh@sdruskat.net
    affiliation: German Aerospace Center (DLR)
    orcid: 'https://orcid.org/0000-0003-4925-7248'
repository-code: 'https://github.com/sdruskat/pyswh'
url: 'https://pyswh.readthedocs.io'
repository-artifact: 'https://pypi.org/project/pyswh/'
abstract: >-
  pyswh aims to wrap interactions with the Software
  Heritage REST API into a comfortable Python API.
keywords:
  - Software Heritage
  - archive
  - API
  - Python
  - wrapper
  - library
license: 
  - MIT
  - CC-BY-4.0
  - CC0-1.,0
version: 0.1.0
date-released: '2022-10-13'

GitHub Events

Total
Last Year

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 103
  • Total Committers: 2
  • Avg Commits per committer: 51.5
  • Development Distribution Score (DDS): 0.019
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Stephan Druskat s****t@d****e 101
dependabot[bot] 4****] 2
Committer Domains (Top 20 + Academic)
dlr.de: 1

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 1
  • Total pull requests: 10
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 1.3
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 4
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • sdruskat (1)
Pull Request Authors
  • sdruskat (6)
  • dependabot[bot] (3)
Top Labels
Issue Labels
enhancement (1)
Pull Request Labels
dependencies (3)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 8 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 1
  • Total maintainers: 1
pypi.org: pyswh

A Python wrapper for the Software Heritage API

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 8 Last month
Rankings
Dependent packages count: 6.6%
Forks count: 30.5%
Dependent repos count: 30.6%
Average: 33.1%
Stargazers count: 39.1%
Downloads: 58.5%
Maintainers (1)
sdruskat
Last synced: 8 months ago