Election-Tech-Initiative / electionguard-python

A python module implementing the ElectionGuard specification. This implementation can be used to conduct End-to-End Verifiable Elections as well as privacy-enhanced risk-limiting audits.
https://www.electionguard.vote/
MIT License
162 stars 96 forks source link

pypi / pip metadata is missing #105

Closed danwallach closed 4 years ago

danwallach commented 4 years ago

First, congrats on hitting the big "1.0.0" release. Now that you're on pypi.org, you don't have a project description.

https://pypi.org/project/electionguard/

It does correctly link to the homepage and such, but you want a local description there as well.

keithrfung commented 4 years ago

We're aware. That is being manually edited to allow a bit of formatting.

keithrfung commented 4 years ago

Since we already have a card for this, I'll add the details here:

from setuptools import setup

# read the contents of your README file
from os import path
this_directory = path.abspath(path.dirname(__file__))
with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
    long_description = f.read()

setup(
    name='an_example_package',
    # other arguments omitted
    long_description=long_description,
    long_description_content_type='text/markdown'
)