bigchaindb / bigchaindb/bigchaindb-driver

Problem: broken project description on pypi

Open
#445 0 comments 0 reactions 0 assignees View on GitHub
community easy
Dominant language
Python
Stars
106
Forks
99
PR merge metrics
No merged PRs in 30d

Description

Solution: replace README + CHANGELOG combi with description

Add a nice description in `setup.py` for `long description`.
Remove the README and CHANGELOG for the `long description`

[example for a nice description](https://pypi.org/project/BigchainDB/)

This should be done before the next release!

Contributor guide

Open the contributing guide

Research direction

Start in setup.py and inspect how the current README and CHANGELOG are combined for the PyPI long description. Compare the rendered result with the linked BigchainDB example; done means setup.py uses the intended description and no longer uses the README/CHANGELOG combination before the next release.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, release
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.