Skip to content

Commit

Permalink
Fix README... (#65)
Browse files Browse the repository at this point in the history
Fix README...
  • Loading branch information
ocefpaf authored Jan 28, 2020
2 parents c4b4b46 + 8913167 commit ecd4e26
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 26 deletions.
6 changes: 6 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ script:
pushd /tmp && pytest -n 2 -rxs --cov=oceans tests && popd ;
fi

- if [[ $TRAVIS_JOB_NAME == 'tarball' ]]; then
pip wheel . -w dist --no-deps ;
check-manifest --verbose ;
twine check dist/* ;
fi

- if [[ $TRAVIS_JOB_NAME == doctests ]]; then
pytest -vv oceans --doctest-modules ;
fi
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[![PyPI Package](https://img.shields.io/pypi/v/oceans.svg)](https://pypi.org/project/oceans/) [![Travis Build Status](https://travis-ci.org/pyoceans/python-oceans.svg?branch=master)](https://travis-ci.org/pyoceans/python-oceans) [![DOI](https://zenodo.org/badge/11956337.svg)](https://zenodo.org/badge/latestdoi/11956337)

# Python Oceans

Misc helper functions for ocean sciences.

Most of the functions here are Python versions of some common MatlabTM functions.
They are untested and probably buggy. Use with caution!
21 changes: 0 additions & 21 deletions README.rst

This file was deleted.

10 changes: 5 additions & 5 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,6 @@ def read(*parts):
maintainer = "Filipe Fernandes"
authors = [u"André Palóczy", "Arnaldo Russo", "Filipe Fernandes"]

LICENSE = read("LICENSE.txt")
long_description = "{}\n{}".format(read("README.rst"), read("CHANGES.txt"))

# Dependencies.
hard = ["gsw", "matplotlib", "numpy", "seawater"]
soft = {"full": ["cartopy", "iris", "netcdf4", "pandas", "scipy"]}
Expand All @@ -29,8 +26,9 @@ def read(*parts):
cmdclass=versioneer.get_cmdclass(),
packages=find_packages(),
package_data={"oceans": ["colormaps/cmap_data/*.dat"]},
license=LICENSE,
long_description=long_description,
license="BSD-3-Clause",
long_description=f'{read("README.md")}',
long_description_content_type="text/markdown",
classifiers=[
"Development Status :: 4 - Beta",
"Environment :: Console",
Expand All @@ -45,6 +43,7 @@ def read(*parts):
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
],
description="Misc functions for oceanographic data analysis",
author=authors,
Expand All @@ -56,5 +55,6 @@ def read(*parts):
keywords=["oceanography", "data analysis"],
extras_require=soft,
install_requires=hard,
python_requires='>=3.6',
tests_require=["pytest"],
)

0 comments on commit ecd4e26

Please sign in to comment.