Skip to content

Commit 23d2c6e

Browse files
committed
Update README and a few docs
* install command updated with #egg param * fixed package references in index.rst
1 parent d234abf commit 23d2c6e

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ pip install epidatpy
1313
latest version
1414

1515
```sh
16-
pip install -e "git+https://github.com/cmu-delphi/epidatpy.git"
16+
pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy"
1717
```
1818

1919
old name version
2020

2121
```sh
22-
pip install -e "git+https://github.com/cmu-delphi/epidatpy.git@delphi_epidata-before-rename"
22+
pip install -e "git+https://github.com/cmu-delphi/epidatpy.git@delphi_epidata-before-rename#egg=delphi_epidata"
2323
```
2424

2525
## Usage
@@ -67,7 +67,7 @@ The release consists of multiple steps which can be all done via the GitHub webs
6767
[mit-url]: https://opensource.org/licenses/MIT
6868
[github-actions-image]: https://github.com/cmu-delphi/epidatpy/workflows/ci/badge.svg
6969
[github-actions-url]: https://github.com/cmu-delphi/epidatpy/actions
70-
[pypi-image]: https://img.shields.io/pypi/v/delphi-epidata
71-
[pypi-url]: https://pypi.python.org/pypi/delphi-epidata/
72-
[docs-image]: https://readthedocs.org/projects/delphi-epidata/badge/?version=latest
73-
[docs-url]: https://delphi-epidata.readthedocs.io/en/latest/?badge=latest
70+
[pypi-image]: https://img.shields.io/pypi/v/epidatpy
71+
[pypi-url]: https://pypi.python.org/pypi/epidatpy/
72+
[docs-image]: https://readthedocs.org/projects/epidatpy/badge/?version=latest
73+
[docs-url]: https://epidatpy.readthedocs.io/en/latest/?badge=latest

docs/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ the `Delphi group <https://delphi.cmu.edu>`_ at `Carnegie Mellon University
77
<https://www.cmu.edu>`_.
88

99
The package source code and bug tracker can be found `on GitHub
10-
<https://github.com/cmu-delphi/delphi-epidata-py>`_.
10+
<https://github.com/cmu-delphi/epidatpy>`_.
1111

1212

1313
.. note :: **You should consider subscribing** to the `API mailing list
@@ -29,12 +29,12 @@ Installation
2929
------------
3030

3131
This package is available on PyPI as `covidcast
32-
<https://pypi.org/project/delphi-epidata/>`_, and can be installed using ``pip`` or
32+
<https://pypi.org/project/epidatpy/>`_, and can be installed using ``pip`` or
3333
your favorite Python package manager:
3434

3535
.. code-block:: sh
3636
37-
pip install delphi-epidata
37+
pip install epidatpy
3838
3939
The package requires `pandas <https://pandas.pydata.org/>`_ and `requests
4040
<https://requests.readthedocs.io/en/master/>`_; these should be installed

0 commit comments

Comments
 (0)