Skip to content

Commit cf952f4

Browse files
committed
final(wheel): completed
1 parent e3096c9 commit cf952f4

12 files changed

+34
-28
lines changed

.github/labeler.yml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
"documentation":
2+
- "README.md"
3+
"config":
4+
- "config.py"
5+
"*arr":
6+
- "api/arr.py"
7+
"trakt":
8+
- "api/trakt.py"
9+
"base":
10+
- "retraktarr.py"

.gitignore

+4-1
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,7 @@ share/python-wheels/
4646
*.egg-info/
4747
.installed.cfg
4848
*.egg
49-
MANIFEST
49+
MANIFEST
50+
*.pdf
51+
*.jpg
52+
*.png

MANIFEST.in

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
include VERSION
22
include README.md
33
include LICENSE
4-
recursive-include src *
4+
exclude *.conf
5+
exclude .git*

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ A [Trakt.tv](https://www.trakt.tv) account with an [API set up](#trakttv-api-app
4646
4. Click `Authorize`. Click `Yes`. You will be redirected to Google (or your URI) and in the URL bar you will see `?code=` followed by 64 alphanumeric characters. **Save this for now. This is your OAuth2 Authorization code.**
4747
5. You can now complete the OAuth2 process when you're ready using the `retraktarr` script.
4848

49+
## Installing retraktarr
50+
51+
You can either download the source yourself or install from PyPI using the `pip install retraktarr` command.
52+
4953
## Configuring retraktarr
5054

5155
`retraktarr` uses a config file, named `config.conf` to get many of its settings. However, some of these can be overridden with the arguments you pass. You can run `python3 retraktarr.py` at any time to see the available options.
@@ -59,19 +63,13 @@ If you've never run `retraktarr` before, you will need to leave your `oauth2_tok
5963
## Usage (CLI)
6064

6165
```shell
62-
usage: retraktarr.py [-h] [--oauth OAUTH] [--radarr] [--sonarr] [--all] [--mon] [--qualityprofile QUALITYPROFILE]
63-
[--tag TAG] [--cat] [--list LIST] [--wipe] [--privacy PRIVACY] [--refresh] [--timeout TIMEOUT]
64-
65-
Starr App -> Trakt.tv List Backup/Synchronization
66-
6766
options:
6867
-h, --help show this help message and exit
6968
--oauth OAUTH, -o OAUTH
70-
Update OAuth2 Bearer Token. Accepts the auth code and requires
71-
valid Trakt config settings
69+
Update OAuth2 Bearer Token. Accepts the auth code and requires valid Trakt config settings
7270
(ex: -o CODE_HERE)
73-
--radarr, -r Synchronize monitored Radarr movies with Trakt.tv
74-
--sonarr, -s Synchronize monitored Sonarr series with Trakt.tv
71+
--radarr, -r Synchronize Radarr movies with Trakt.tv
72+
--sonarr, -s Synchronize Sonarr series with Trakt.tv
7573
--all, -all, -a Synchronize both Starr apps with Trakt.tv
7674
--mon, -m Synchronize only monitored content with Trakt.tv
7775
--qualityprofile QUALITYPROFILE, -qp QUALITYPROFILE
@@ -81,10 +79,12 @@ options:
8179
--list LIST, -l LIST Specifies the Trakt.tv list name. (overrides config file settings)
8280
--wipe, -w Erases the associated list and performs a sync (requires -all or -r/s)
8381
--privacy PRIVACY, -p PRIVACY
84-
Specifies the Trakt.tv list privacy settings
85-
(private/friends/public - overrides config file settings)
82+
Specifies the Trakt.tv list privacy settings (private/friends/public - overrides config file
83+
settings)
8684
--refresh Forces a refresh_token exchange (oauth) and sets the config to a new tokens.
8785
--timeout TIMEOUT Specifies the timeout in seconds to use for POST commands to Trakt.tv
86+
--version Displays version information
87+
--config CONFIG Specifies configuration file
8888
```
8989

9090
## Troubleshooting
@@ -100,4 +100,4 @@ options:
100100

101101
[start a discussion](https://github.com/zakkarry/retraktarr/discussions/new) or [open an issue](https://github.com/zakkarry/retraktarr/issues/new)
102102

103-
[support me with a coffee](https://www.buymeacoffee.com/zak.ary)
103+
[support me with a coffee](https://tip.ary.dev)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

src/retraktarr/retraktarr.py renamed to retraktarr.py

+2-3
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,8 @@ def main():
115115
)
116116
parser.add_argument(
117117
"--version",
118-
"-v",
119118
action="store_true",
120-
help="Displays version information",
119+
help="Displays current version information",
121120
)
122121
parser.add_argument(
123122
"--config",
@@ -135,7 +134,7 @@ def main():
135134
config_path = (
136135
f'{path.expanduser("~")}{path.sep}.config{path.sep}retraktarr.conf'
137136
)
138-
137+
print(config_path)
139138
config = Configuration(config_path)
140139
if args.oauth:
141140
config.get_oauth(args)

run.py

-6
This file was deleted.

setup.py

+4-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
import os
22

3-
from distutils.core import setup
4-
from setuptools import find_packages
3+
from setuptools import setup, find_packages
54

65
"""
76
setup file for package publishing
@@ -32,7 +31,7 @@
3231
version=VERSION_NO,
3332
# Short description of your library
3433
description=("a simple Arr -> Trakt.tv list sync script"),
35-
entry_points={"console_scripts": ["retraktarr = retraktarr.retraktarr:main"]},
34+
entry_points={"console_scripts": ["retraktarr = retraktarr:main"]},
3635
# Long description of your library
3736
install_requires="requests",
3837
long_description=LONG_DESCRIPTION,
@@ -48,6 +47,6 @@
4847
# Link from which the project can be downloaded
4948
download_url="https://github.com/zakkarry/retraktarr",
5049
packages=["retraktarr", "retraktarr.api"],
51-
package_dir={"retraktarr": "src/retraktarr"},
52-
include_package_data=True,
50+
package_dir={"retraktarr": "."},
51+
exclude_package_data={"": ["*.conf"]},
5352
)

0 commit comments

Comments
 (0)