{"id":37084594,"url":"https://github.com/jwodder/gamdam","last_synced_at":"2026-01-14T10:22:50.233Z","repository":{"id":45912022,"uuid":"419810955","full_name":"jwodder/gamdam","owner":"jwodder","description":"Git-Annex Mass Downloader and Metadata-er","archived":true,"fork":false,"pushed_at":"2023-12-12T21:36:56.000Z","size":109,"stargazers_count":5,"open_issues_count":6,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-01T23:54:12.831Z","etag":null,"topics":["anyio","async","available-on-pypi","download","git-annex","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jwodder.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-10-21T17:09:26.000Z","updated_at":"2025-05-10T18:59:04.000Z","dependencies_parsed_at":"2023-10-03T04:41:11.039Z","dependency_job_id":"74f6a074-fc3d-4115-8bbc-dff2057ee0ab","html_url":"https://github.com/jwodder/gamdam","commit_stats":{"total_commits":95,"total_committers":1,"mean_commits":95.0,"dds":0.0,"last_synced_commit":"a3c949696a87d2bc0f0af9985422b6f71c0158d2"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/jwodder/gamdam","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwodder%2Fgamdam","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwodder%2Fgamdam/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwodder%2Fgamdam/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwodder%2Fgamdam/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jwodder","download_url":"https://codeload.github.com/jwodder/gamdam/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwodder%2Fgamdam/sbom","scorecard":{"id":545402,"data":{"date":"2025-08-11","repo":{"name":"github.com/jwodder/gamdam","commit":"d6e6eac5bcb00c7a6a5565d264b8fbeecc55bcff"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.1,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/28 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"project is archived","details":["Warn: Repository is archived."],"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/jwodder/gamdam/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/jwodder/gamdam/test.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/jwodder/gamdam/test.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:54","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:55","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:56","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   3 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/test.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v0.5.0 not signed: https://api.github.com/repos/jwodder/gamdam/releases/133650105","Warn: release artifact v0.4.0 not signed: https://api.github.com/repos/jwodder/gamdam/releases/81466491","Warn: release artifact v0.3.1 not signed: https://api.github.com/repos/jwodder/gamdam/releases/80794035","Warn: release artifact v0.3.0 not signed: https://api.github.com/repos/jwodder/gamdam/releases/73792283","Warn: release artifact v0.2.0 not signed: https://api.github.com/repos/jwodder/gamdam/releases/72178616","Warn: release artifact v0.5.0 does not have provenance: https://api.github.com/repos/jwodder/gamdam/releases/133650105","Warn: release artifact v0.4.0 does not have provenance: https://api.github.com/repos/jwodder/gamdam/releases/81466491","Warn: release artifact v0.3.1 does not have provenance: https://api.github.com/repos/jwodder/gamdam/releases/80794035","Warn: release artifact v0.3.0 does not have provenance: https://api.github.com/repos/jwodder/gamdam/releases/73792283","Warn: release artifact v0.2.0 does not have provenance: https://api.github.com/repos/jwodder/gamdam/releases/72178616"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 2 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-20T09:22:14.570Z","repository_id":45912022,"created_at":"2025-08-20T09:22:14.570Z","updated_at":"2025-08-20T09:22:14.570Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28417005,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T10:18:03.274Z","status":"ssl_error","status_checked_at":"2026-01-14T10:16:11.865Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["anyio","async","available-on-pypi","download","git-annex","python"],"created_at":"2026-01-14T10:22:49.528Z","updated_at":"2026-01-14T10:22:50.224Z","avatar_url":"https://github.com/jwodder.png","language":"Python","readme":".. image:: https://www.repostatus.org/badges/latest/unsupported.svg\n    :target: https://www.repostatus.org/#unsupported\n    :alt: Project Status: Unsupported – The project has reached a stable,\n          usable state but the author(s) have ceased all work on it. A new\n          maintainer may be desired.\n\n.. image:: https://github.com/jwodder/gamdam/actions/workflows/test.yml/badge.svg\n    :target: https://github.com/jwodder/gamdam/actions/workflows/test.yml\n    :alt: CI Status\n\n.. image:: https://codecov.io/gh/jwodder/gamdam/branch/master/graph/badge.svg\n    :target: https://codecov.io/gh/jwodder/gamdam\n\n.. image:: https://img.shields.io/pypi/pyversions/gamdam.svg\n    :target: https://pypi.org/project/gamdam/\n\n.. image:: https://img.shields.io/github/license/jwodder/gamdam.svg\n    :target: https://opensource.org/licenses/MIT\n    :alt: MIT License\n\n`GitHub \u003chttps://github.com/jwodder/gamdam\u003e`_\n| `PyPI \u003chttps://pypi.org/project/gamdam/\u003e`_\n| `Issues \u003chttps://github.com/jwodder/gamdam/issues\u003e`_\n| `Changelog \u003chttps://github.com/jwodder/gamdam/blob/master/CHANGELOG.md\u003e`_\n\n``gamdam`` is the Git-Annex Mass Downloader and Metadata-er.  It takes a stream\nof JSON Lines describing what to download and what metadata each file has,\ndownloads them in parallel to a git-annex_ repository, attaches the metadata\nusing git-annex's metadata facilities, and commits the results.\n\nThis program was written as an experiment/proof-of-concept for a larger program\nand is no longer maintained.  However, the author has also produced a Rust\ntranslation of this program at \u003chttps://github.com/jwodder/gamdam-rust\u003e which\nis currently being maintained.\n\n.. _git-annex: https://git-annex.branchable.com\n\n\nInstallation\n============\n``gamdam`` requires Python 3.8 or higher.  Just use `pip\n\u003chttps://pip.pypa.io\u003e`_ for Python 3 (You have pip, right?) to install\n``gamdam`` and its dependencies::\n\n    python3 -m pip install gamdam\n\n``gamdam`` also requires ``git-annex`` v10.20220222 or higher to be installed\nseparately in order to run.\n\n\nUsage\n=====\n\n::\n\n    gamdam [\u003coptions\u003e] [\u003cinput-file\u003e]\n\n``gamdam`` reads a series of JSON entries from a file (or from standard input\nif no file is specified) following the `input format`_ described below.  It\nfeeds the URLs and output paths to ``git-annex addurl``, and once each file has\nfinished downloading, it attaches any listed metadata and extra URLs using\n``git-annex metadata`` and ``git-annex registerurl``, respectively.\n\nNote that the latter step can only be performed on files tracked by git-annex;\nif you, say, have configured git-annex to not track text files, then any text\nfiles downloaded will not have any metadata or alternative URLs registered.\n\nOptions\n-------\n\n--addurl-opts OPTIONS           Extra options to pass to the ``git-annex\n                                addurl`` command.  Note that multiple options \u0026\n                                arguments need to be quoted as a single string,\n                                which must also use proper shell quoting\n                                internally; e.g., ``--addurl-opts=\"--user-agent\n                                'gamdam via git-annex'\"``.\n\n-C DIR, --chdir DIR             The directory in which to download files;\n                                defaults to the current directory.  If the\n                                directory does not exist, it will be created.\n                                If the directory does not belong to a Git or\n                                git-annex repository, it will be initialized as\n                                one.\n\n-F FILE, --failures FILE        If any files fail to download, write their\n                                input records back out to ``FILE``\n\n-J INT, --jobs INT              Number of parallel jobs for ``git-annex\n                                addurl`` to use; by default, the process is\n                                instructed to use one job per CPU core.\n\n-l LEVEL, --log-level LEVEL     Set the log level to the given value.  Possible\n                                values are \"``CRITICAL``\", \"``ERROR``\",\n                                \"``WARNING``\", \"``INFO``\", \"``DEBUG``\" (all\n                                case-insensitive) and their Python integer\n                                equivalents.  [default: ``INFO``]\n\n-m TEXT, --message TEXT         The commit message to use when saving.  This\n                                may contain a ``{downloaded}`` placeholder\n                                which will be replaced with the number of files\n                                successfully downloaded.\n\n--no-save-on-fail               Don't commit the downloaded files if any files\n                                failed to download\n\n--save, --no-save               Whether to commit the downloaded files once\n                                they've all been downloaded  [default:\n                                ``--save``]\n\n\nInput Format\n------------\n\nInput is a series of JSON objects, one per line (a.k.a. \"JSON Lines\").  Each\nobject has the following fields:\n\n``url``\n    *(required)* A URL to download\n\n``path``\n    *(required)* A relative path where the contents of the URL should be saved.\n    If an entry with a given path is encountered while another entry with the\n    same path is being downloaded, the later entry is discarded, and a warning\n    is emitted.\n\n    If a file already exists at a given path, ``git-annex`` will try to\n    register the URL as an additional location for the file, failing if the\n    resource at the URL is not the same size as the extant file.\n\n``metadata``\n    A collection of metadata in the form used by ``git-annex metadata``, i.e.,\n    a ``dict`` mapping key names to lists of string values.\n\n``extra_urls``\n    A list of alternative URLs for the resource, to be attached to the\n    downloaded file with ``git-annex registerurl``.\n\nIf a given input line is invalid, it is discarded, and an error message is\nemitted.\n\n\nLibrary Usage\n=============\n\n``gamdam`` can also be used as a Python library.  It exports the following:\n\n.. code:: python\n\n    async def download(\n        repo: pathlib.Path,\n        objects: AsyncIterator[Downloadable],\n        jobs: Optional[int] = None,\n        addurl_opts: Optional[List[str]] = None,\n        subscriber: Optional[anyio.abc.ObjectSendStream[DownloadResult]] = None,\n    ) -\u003e Report\n\nDownload the items yielded by the async iterator ``objects`` to the directory\n``repo`` (which must be part of a git-annex repository) and set their metadata.\n``jobs`` is the number of parallel jobs for the ``git-annex addurl`` process to\nuse; a value of ``None`` means to use one job per CPU core.  ``addurl_opts``\ncontains any additional arguments to append to the ``git-annex addurl``\ncommand.\n\nIf ``subscriber`` is supplied, it will be sent a ``DownloadResult`` (see below)\nfor each completed download, both successful and failed.  This can be used to\nimplement custom post-processing of downloads.\n\n.. code:: python\n\n   class Downloadable(pydantic.BaseModel):\n       path: pathlib.Path\n       url: pydantic.AnyHttpUrl\n       metadata: Optional[Dict[str, List[str]]] = None\n       extra_urls: Optional[List[pydantic.AnyHttpUrl]] = None\n\n``Downloadable`` is a pydantic_ model used to represent files to download; see\n`Input Format`_ above for the meanings of the fields.\n\n.. code:: python\n\n    class DownloadResult(pydantic.BaseModel):\n        downloadable: Downloadable\n        success: bool\n        key: Optional[str] = None\n        error_messages: Optional[List[str]] = None\n\n``DownloadResult`` is a pydantic_ model used to represent a completed download.\nIt contains the original ``Downloadable``, a flag to indicate download success,\nthe downloaded file's git-annex key (only set if the download was successful\nand the file is tracked by git-annex) and any error messages from the addurl\nprocess (only set if the download failed).\n\n.. code:: python\n\n    @dataclass\n    class Report:\n        downloaded: int\n        failed: int\n\n``Report`` is used as the return value of ``download()``; it contains the\nnumber of files successfully downloaded and the number of failed downloads.\n\n.. _pydantic: https://pydantic-docs.helpmanual.io\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwodder%2Fgamdam","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjwodder%2Fgamdam","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwodder%2Fgamdam/lists"}