From 263309ab0d93896e67dfb9bd253de45982419ee2 Mon Sep 17 00:00:00 2001 From: Tanner Prestegard Date: Wed, 11 Sep 2019 11:45:47 -0500 Subject: [PATCH] change README from .md to .rst README.md file doesn't seem to come along for the ride when system packages are built, so we converted to .rst format, since that seems to work. --- README.md | 18 ------------------ README.rst | 24 ++++++++++++++++++++++++ setup.py | 9 +++++---- 3 files changed, 29 insertions(+), 22 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index 257a7de..0000000 --- a/README.md +++ /dev/null @@ -1,18 +0,0 @@ -# ligo-gracedb -The Gravitational-wave Candidate Event Database (GraceDB) is a web service designed for aggregating and communicating information about candidate events from gravitational-wave searches and associated follow-ups. -`ligo-gracedb` provides a Python-based client tool for facilitating interactions with the GraceDB API. - - -## Documentation -For more information, see the [full documentation](https://gw.readthedocs.io/ligo-gracedb/). - - -## Quick install -```python -pip install ligo-gracedb -``` - -## Contributing -Please fork this [repository](https://git.ligo.org/lscsoft/gracedb-client) and submit a merge request if you wish to contribute to this package. - -See the [contributing documentation](https://gw.readthedocs.io/projects/ligo-gracedb/en/latest/contributing.html) for more details. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..0ef68d6 --- /dev/null +++ b/README.rst @@ -0,0 +1,24 @@ +============ +ligo-gracedb +============ +The Gravitational-wave Candidate Event Database (GraceDB) is a web service designed for aggregating and communicating information about candidate events from gravitational-wave searches and associated follow-ups. +``ligo-gracedb`` provides a Python-based client tool for facilitating interactions with the GraceDB API. + + +Documentation +------------- +For more information, see the `full documentation `__. + + +Quick install +------------- +.. code:: python + + pip install ligo-gracedb + + +Contributing +------------ +Please fork this `repository `__ and submit a merge request if you wish to contribute to this package. + +See the `contributing documentation `__ for more details. diff --git a/setup.py b/setup.py index 1cd4012..10f1f9d 100644 --- a/setup.py +++ b/setup.py @@ -34,9 +34,10 @@ def parse_version(path): # Get readme file for long_description -readme_file = os.path.join(os.path.dirname(__file__), 'README.md') -with open(readme_file, 'r') as f: - long_description = f.read() +readme_file = os.path.join(os.path.dirname(__file__), 'README.rst') +with open(readme_file, 'rb') as f: + long_description = f.read().decode().strip() + # Required packages for tests tests_require = [] @@ -89,7 +90,7 @@ setup( author_email="tanner.prestegard@ligo.org, alexander.pace@ligo.org", description="A Python package for accessing the GraceDB API.", long_description=long_description, - long_description_content_type='text/markdown', + long_description_content_type='text/x-rst', url="https://git.ligo.org/lscsoft/gracedb-client", license='GPL-3.0-or-later', namespace_packages=['ligo'], -- GitLab