Skip to content

Commit

Permalink
Rename PyPi package to nyaa-cli (Closes #3)
Browse files Browse the repository at this point in the history
  • Loading branch information
johnvictorfs committed Nov 17, 2019
1 parent 7dae039 commit 2ca861b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# nyaacli
# Nyaa-cli

A CLI for downloading Anime from https://nyaa.si making use of their RSS Feed and [python-libtorrent](https://github.com/arvidn/libtorrent/blob/RC_1_2/docs/python_binding.rst)

Expand All @@ -14,7 +14,7 @@ A CLI for downloading Anime from https://nyaa.si making use of their RSS Feed an

## Installing

- `python3 -m pip install nyaacli --user`
- `python3 -m pip install nyaa-cli --user`
- *Note:* python-libtorrent will still need to be downloaded separately as shown below

- This Program depends on python3-libtorrent, which can be installed using Apt with `sudo apt install python3-libtorrent` or can be built from source here: [python-libtorrent](https://github.com/arvidn/libtorrent/blob/RC_1_2/docs/python_binding.rst)
Expand All @@ -23,12 +23,12 @@ A CLI for downloading Anime from https://nyaa.si making use of their RSS Feed an

## Usage

- **Help:** `nyaa-cli --help`
- **Help:** `nyaa --help` | `nyaa-cli --help`

- `nyaa-cli "Anime Name" <Episode Number (Optional)> -o <Output Folder (Default: ~/Videos/Anime)>`
- `nyaa "Anime Name" <Episode Number (Optional)> -o <Output Folder (Default: ~/Videos/Anime)>`
- **Example:**
```bash
# Downloading Episode 14 of 'Steins;gate' to '~/Anime/Steins;Gate' folder
nyaa-cli "Steins;Gate" 14 -o ~/Anime/Steins\;Gate
nyaa "Steins;Gate" 14 -o ~/Anime/Steins\;Gate
```
- Then select the entry you want to Download
5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "nyaacli"
version = "0.1.1"
name = "nyaa-cli"
version = "0.1.2"
description = "A CLI for downloading Anime from https://nyaa.si"
authors = ["John Victor <johnvictorfs@gmail.com>"]
license = "MIT"
Expand All @@ -23,6 +23,7 @@ flake8 = "^3.7"

[tool.poetry.scripts]
nyaa-cli = 'nyaacli.cli:main'
nyaa = 'nyaacli.cli:main'

[build-system]
requires = ["poetry>=0.12"]
Expand Down

0 comments on commit 2ca861b

Please sign in to comment.