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.
parent e5d85121
# ligo-gracedb
The <b>Gra</b>vitational-wave <b>C</b>andidate <b>E</b>vent <b>D</b>ata<b>b</b>ase (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.
============
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
-------------
.. code:: 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.
......@@ -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'],
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment