Skip to content

Add long_description to setup.py #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 13, 2019
Merged

Add long_description to setup.py #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
# Stratify

[![Build Status](https://travis-ci.org/SciTools-incubator/python-stratify.svg?branch=master)](https://travis-ci.org/SciTools-incubator/python-stratify) [![Binder](http://mybinder.org/badge.svg)](http://mybinder.org:/repo/scitools-incubator/python-stratify)
[![Build Status](https://travis-ci.org/SciTools-incubator/python-stratify.svg?branch=master)](https://travis-ci.org/SciTools-incubator/python-stratify)
[![Binder](http://mybinder.org/badge.svg)](http://mybinder.org:/repo/scitools-incubator/python-stratify)

Interpolation for restratification, particularly useful for Nd vertical interpolation of atmospheric and oceanographic datasets

## Introduction

Discover the capabilites of `stratify` with this introductory [notebook](index.ipynb).
Discover the capabilites of `stratify` with this introductory [notebook](https://nbviewer.jupyter.org/github/SciTools-incubator/SciTools-incubator.github.io/blob/python-stratify/index.ipynb).
Copy link
Member

@lbdreyer lbdreyer Sep 13, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


[![An outline of the problem space](summary.png)](index.ipynb)
![](https://SciTools-incubator.github.io/python-stratify/summary.png)

## Installation

```shell
conda install -c scitools python-stratify
conda install -c conda-forge python-stratify
```

## License
Expand Down
9 changes: 9 additions & 0 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,13 @@ def extract_version():
return version


def long_description():
fname = os.path.join(PACKAGE_DIR, 'README.md')
with open(fname, 'rb') as fi:
result = fi.read().decode('utf-8')
return result


# Python 2 is not supported by numpy as of version 1.17
# but pip will attempt to install/use newer Python 3-only numpy versions.
numpy_req = 'numpy<1.17' if sys.version_info.major < 3 else 'numpy'
Expand Down Expand Up @@ -74,6 +81,8 @@ def extract_version():
description=('Vectorized interpolators that are especially useful for '
'Nd vertical interpolation/stratification of atmospheric '
'and oceanographic datasets'),
long_description=long_description(),
long_description_content_type='text/markdown',
author='UK Met Office',
author_email='scitools-iris-dev@googlegroups.com',
url='https://github.com/SciTools-incubator/python-stratify',
Expand Down