multiformats / multiformats/py-multibase

Add `version.json` to match go-multibase

Open Beginner friendly
#46 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
25
Forks
9
PR merge metrics
No merged PRs in 30d

Description

go-multibase has a version.json file that tracks the library version. py-multibase should have one for consistency across the multiformats ecosystem.

Problem

go-multibase includes:

{
  "version": "v0.6.0"
}

This file is used by ecosystem tooling to track version compatibility across implementations. py-multibase does not have this file — version info exists only in pyproject.toml and __init__.py.

Proposed Solution
  1. Create version.json at the repository root:

    {
      "version": "v2.0.0"
    }
    
  2. Add it to the bump-my-version configuration in pyproject.toml:

    [[tool.bumpversion.files]]
    filename = "version.json"
    search = '"version": "v{current_version}"'
    replace = '"version": "v{new_version}"'
    
Related

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing version settings in pyproject.toml and compare the repository-root version.json format with the linked go-multibase example. Add version.json with the current v2.0.0 value and configure bump-my-version to update it; done means both files are present and future version bumps include version.json.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, release
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
88/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.