Installation¶

Installing AniLinkPy is straightforward. The recommended approach is to use a project manager like Poetry or Hatch, as these tools provide a clean, isolated environment for your project. Alternatively, you can use pipx, which automatically sandboxes your pip installations into separate environments. If you prefer to use pip, you can install AniLinkPy directly as well.

PoetryHatchpipxPip

In pyproject.toml:

[tool.poetry.dependencies]
AniLinkPy = "*" # (1)!

The * will install the latest version of AniLinkPy. You can also specify a version number to install a specific version.
Specifying a Version
```
[tool.poetry.dependencies]
AniLinkPy = "1.0.0"
```

In pyproject.toml:

dependencies = [
    "AniLinkPy" # (1)!
]

To install a specific version of AniLinkPy, you can specify the version number in the dependencies list:
Specifying a Version
```
dependencies = [
    "AniLinkPy==1.0.0"
]
```

Run the following command in your terminal:

pipx install AniLinkPy # (1)!

To install a specific version of AniLinkPy, you can specify the version number with the package name:
Specifying a Version
```
pipx install AniLinkPy==1.0.0
```

Run the following command in your terminal:

pip install AniLinkPy # (1)!

To install a specific version of AniLinkPy:
Specifying a Version
```
pip install AniLinkPy==1.0.0
```

Initialization¶

To start using AniLink, you need to import it and initialize it with an optional authentication token. You can get an authentication token from the respective platform (e.g. AniList).

Importing & Initializing AniLink

from AniLinkPy import AniLink

auth_token = 'your-auth-token' # (1)!
aniLink = AniLink(auth_token)

Please replace 'your-auth-token' with your actual authentication token.

You can also initialize AniLink without an authentication token

aniLink = AniLink()