Skip to content

Commit

Permalink
Replace README with explicit LONG_DESCRIPTION
Browse files Browse the repository at this point in the history
twine tool for PyPI is incredibly picky about LONG_DESCRIPTION.
The [Python Packaging Reference Guide](https://packaging.python.org/guides/making-a-pypi-friendly-readme/)
says to slurp in the README, and cautions not to use [sphinx extensions](https://github.com/pypa/twine/issues/470),
but the twine tool doesn't even tolerate section headings.
  • Loading branch information
guyer committed Jun 27, 2019
1 parent d92e715 commit 8dcd2f1
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,21 @@

ez_setup.use_setuptools()

try:
FILE = open("README.rst", "r")
LONG_DESCRIPTION = "\n" + FILE.read() + "\n"
FILE.close()
except IOError as _:
LONG_DESCRIPTION = ""
LONG_DESCRIPTION = """
FiPy is an object oriented, partial differential equation (PDE) solver,
written in Python, based on a standard finite volume (FV) approach. This
combination provides a tool that is extensible, powerful and freely
available. A significant advantage to Python is the existing suite of
tools for array calculations, sparse matrices and data rendering.
The FiPy framework includes terms for transient diffusion, convection and
standard sources, enabling the solution of arbitrary combinations of
coupled elliptic, hyperbolic and parabolic PDEs. Currently implemented
models include phase field treatments of polycrystalline, dendritic, and
electrochemical phase transformations, as well as drug eluting stents,
reactive wetting, photovoltaics and a level set treatment of the
electrodeposition process.
"""

try:
FILE = open("LICENSE.rst", "r")
Expand Down

0 comments on commit 8dcd2f1

Please sign in to comment.