Skip to content
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

add conda install and related links and tell users that they can copy… #122

Merged
merged 3 commits into from
Jan 26, 2022
Merged

add conda install and related links and tell users that they can copy… #122

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e04cfdf
add conda install and related links and tell users that they can copy…
akamhy Jan 26, 2022
8dff6f3
add maintainers
akamhy Jan 26, 2022
1250d10
update install command for conda and replace the link to conda-forge.…
akamhy Jan 26, 2022
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
20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,31 @@ These three APIs can be accessed via the waybackpy either by importing it in a s

### 🏗 Installation

Using [pip](https://en.wikipedia.org/wiki/Pip_(package_manager)), from [PyPI](https://pypi.org/) (recommended):
**Using [pip](https://en.wikipedia.org/wiki/Pip_(package_manager)), from [PyPI](https://pypi.org/) (recommended)**:

```bash
pip install waybackpy
```

Install directly from [this git repository](https://github.com/akamhy/waybackpy) (NOT recommended):

**Using [conda](https://en.wikipedia.org/wiki/Conda_(package_manager)), from [conda-forge](https://conda-forge.org/) (recommended)**:
Copy link
Contributor

Choose a reason for hiding this comment

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

wouldn't it be worth pointing to: https://anaconda.org/conda-forge/waybackpy instead of conda-forge.org?


See also [waybackpy feedstock](https://github.com/conda-forge/waybackpy-feedstock), maintainers are [@rafaelrdealmeida](https://github.com/rafaelrdealmeida/),
[@labriunesp](https://github.com/labriunesp/)
and [@akamhy](https://github.com/akamhy/).

```bash
conda install waybackpy
Copy link
Contributor

Choose a reason for hiding this comment

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

This works, but I believe it would be worth making it explicit to use the conda-forge channel

conda install -c conda-forge waybackpy

for details see:

```
Copy link
Owner Author

Choose a reason for hiding this comment

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

@rafaelrdealmeida does it look okay to you?

Copy link
Contributor

Choose a reason for hiding this comment

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

excellent! I made two comments. See if they make sense



**Install directly from [this git repository](https://github.com/akamhy/waybackpy) (NOT recommended)**:

```bash
pip install git+https://github.com/akamhy/waybackpy.git
```


### 🐳 Docker Image
Docker Hub : <https://hub.docker.com/r/secsi/waybackpy>

Expand Down Expand Up @@ -112,11 +125,10 @@ https://web.archive.org/web/20171206002737/http://pypi.org:80/

#### As a CLI tool

Demo video:
Demo video on [asciinema.org](https://asciinema.org), you can copy the text from video:

[![asciicast](https://asciinema.org/a/464367.svg)](https://asciinema.org/a/464367)


> CLI documentation is at <https://github.com/akamhy/waybackpy/wiki/CLI-docs>.

### 🛡 License
Expand Down