Skip to content

docs(developer): update third party libraries: go - #963

Merged
kevincador merged 1 commit into
trakt:masterfrom
mfederowicz:developer_update_third_party_libs
Oct 1, 2026
Merged

kevincador merged 1 commit into
trakt:masterfrom
mfederowicz:developer_update_third_party_libs

Conversation

@mfederowicz

@mfederowicz mfederowicz commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor
  • docs: Documentation only changes

Add the new Golang library to the README.
https://github.com/mfederowicz/trakt-sync

@kevincador can you look at this?

@mfederowicz mfederowicz changed the title docs: update third party libraries: go docs(developer): update third party libraries: go Sep 25, 2026
@mfederowicz
mfederowicz force-pushed the developer_update_third_party_libs branch from 91a1fae to a2d5389 Compare September 25, 2026 21:19
@kevincador kevincador self-assigned this Sep 30, 2026
@kevincador

Copy link
Copy Markdown
Contributor

Hi @mfederowicz, thanks for the PR!

Before we merge, please read our API Use Policy and confirm here that trakt-sync follows it. From a quick look it fits the "personal tool for your own data" use case, which is great.

A few things we'd like also like to be clarified:

  • Credential storage - token.json and the settings file are written with 0644. It would make sense to use 0600 (cli/token.go, cli/device.go, cfg/options.go) instead, right?
  • Verbose output - -v prints the full Authorization bearer token. Please mask it or leave it out.
  • Headers - str/headers.go defines User-Agent and trakt-api-version, but requestSetHeaders only sends Authorization and trakt-api-key. Could you send all required headers with a User-Agent that names trakt-sync and its version (for example trakt-sync/1.19.1)?
  • Intended use - please add a short note to the README that trakt-sync is for managing and exporting your own Trakt data, and that it must not be used to bulk-collect public data (lists, comments, ratings) or to feed other services. The paging options make that possible, so it's worth saying explicitly.

One more thing: this page lists libraries, and trakt-sync's client sits under internal/, so other Go projects can't import it. Would you like to expose it as a public package, or should we describe the entry as a CLI tool?

Once those are sorted and you've confirmed compliance, we'll be happy to merge.

Thanks again!

@mfederowicz

Copy link
Copy Markdown
Contributor Author

ok @kevincador i read that api use policy, and added sugested notes in Readme.md, all sugested changes are deployed few minutes ago, you can check on releases: https://github.com/mfederowicz/trakt-sync/releases

Please list trakt-sync as a CLI tool; the client stays internal for now (maybe in future we change that).

@kevincador

Copy link
Copy Markdown
Contributor

Thanks @mfederowicz, that was quick! I checked v1.20.0 and v1.21.0 and everything we asked for is in.

About the listing: since v1.21.0 moved the client into the public trakt package, it is a proper Go library now, so we'll keep it on the libraries page as it is. One small suggestion for library users: the default User-Agent is trakt-sync-go. It might be worth saying in the package docs that apps should set their own with WithUserAgent, as your README example already does.

Merging this now. Thanks again for the contribution!

@kevincador
kevincador merged commit 00327fe into trakt:master Oct 1, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants