hclivess/bismuth
Grade a repo

0

/ 100

GradeC

Good shape overall. A few tweaks would push it into the top tier.

Top 41% of 5,156 graded repos

The first Python blockchain protocol and platform

Documentation70
Engineering67
Health100
Python180GPL-3.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

11 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    README12pt

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

  3. 3
    README12pt

    Add CI/build status badges from shields.io or your CI provider to signal project health.

  4. 4
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

70

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

README12pt70

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under GPL-3.0.

Engineering

67

Linting and formatting5pt0

No linter or formatter config found.

→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

Reproducibility6pt70

Lockfile present (requirements.txt). Installs are reproducible.

Tests18pt80

Test files detected (attic/rewards_test.py).

CI/CD14pt100

CI is configured (.travis.yml).

Project health

100

Dependency manifest6pt100

Dependency manifest found (requirements.txt).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 64
    Forks
  • 1
    Releaseslatest 2mo ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 180
    Watchers

Responsiveness

  • 62d 3h
    Median issue response
  • 5h
    Median PR merge time
  • 2
    Open issues
Repository files138 root entries
  • attic
    Good: Test files detected (attic/rewards_test.py).
  • auto-install
  • contracts
  • doc
  • gpuminer
  • graphics
  • libs
  • plugins
  • polysign
  • scripts
  • static
  • tests
  • tools
  • web
  • _FILES_DESCRIPTION.md
  • _lmdb_demo.py
  • _mkbootstrap.sh
  • _MOST_USEFUL_FILES.md
  • .gitignore
    Good: .gitignore present.
  • .travis.yml
    Good: CI is configured (.travis.yml).
  • aliases.py
  • aliasesv2.py
  • amounts.py
  • announce_archive.txt
  • api_sync_worker.py
  • api_sync.py
  • apihandler_address.py
  • apihandler_blocks.py
  • apihandler_tx.py
  • apihandler.py
  • application_directories.py
  • balance_cache.py
  • balance_index.py
  • balance_nogui.py
  • balances.py
  • bip39_english.txt
  • bip39.py
  • bismuth_riscv.py
  • bismuth_serialize.py
  • bismuth-supply.md
  • block_format.py
  • block_store.py
  • bulletproof.py
  • chain_ops.py
  • check_tx.md
  • check_tx.py
  • cmd_addpeers.py
  • cmd_hn_last_block_ts.py
  • cmd_hn_reg_round.py
  • commands.py
  • compile_nuitka.cmd
  • config.txt.example
  • connectionmanager.py
  • connections.py
  • db_hashes.py
  • db_helpers.py
  • db_migrations.py
  • dbhandler_queries.py
  • dbhandler_write.py
  • dbhandler.py
  • difficulty_lwma.py
  • difficulty.py
  • digest_tx.py
  • digest.py
  • essentials.py
  • fee_dynamics.py
  • fork.py
  • genesis.py
  • hd_wallet.py
  • hmac_drbg.py
  • hyperlane.py
  • install_node.sh
  • ledger_explorer.py
  • ledger_queries.py
  • legacy_sync_probe.py
  • LICENSE
    Good: Licensed under GPL-3.0.
  • license.txt
  • log.py
  • mandatory_message.json
  • mempool_queries.py
  • mempool_sql.py
  • mempool.py
  • migrate_amounts.py
  • miner.py
  • mining_heavy3.py
  • mining.py
  • multisig_wallet.py
  • node_init.py
  • node_stop.py
  • node.py
  • options.py
  • peers_access.py
  • peers_consensus.py
  • peers_pool.py
  • peers_reg.txt
  • peers_reputation.py
  • peers_storage.py
  • peers_test.txt
  • peers.txt
  • peershandler.py
  • plugin_base.py
  • plugins.py
  • process_search.py
  • pytest.ini
  • quantizer.py
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • regnet.py
  • RELEASE_NOTES.md
  • replay_verify.py
  • requirements-node.txt
  • requirements.txt
    Good: Lockfile present (requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (requirements.txt).
  • rest_api.py
  • rest_client.py
  • rest_stats.py
  • reward_chain.py
  • ringct.py
  • rpc_bitcoin.py
  • rpc_ethereum.py
  • rpcconnections.py
  • send_csv.py
  • send_nogui_noconf.py
  • setup.iss
  • shieldedv1.py
  • simplecrypt.py
  • staking.py
  • storage_backend.py
  • suggested_peers_test.txt
  • suggested_peers.txt
  • token_index.py
  • tokensv2.py
  • transport.py
  • txid_index.py
  • validation_exceptions.py
  • vm_engine.py
  • vm_state.py
  • wallet_helpers.py
  • wallet_keys.py
  • worker.py
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/hclivess/bismuth)](https://www.repo-grade.com/report/hclivess/bismuth)

More graded Python repos