1  ---
 2  title: Getting started with Insiders
 3  ---
 4  
 5  # Getting started with Insiders
 6  
 7  *griffe-pydantic Insiders* is a compatible drop-in replacement for *griffe-pydantic*, and can be installed similarly using `pip` or `git`. Note that in order to access the Insiders repository, you need to [become an eligible sponsor][] of @pawamoy on GitHub.
 8  
 9  ## Installation
10  
11  ### with the `insiders` tool
12  
13  [`insiders`][insiders-tool] is a tool that helps you keep up-to-date versions of Insiders projects in the PyPI index of your choice (self-hosted, Google registry, Artifactory, etc.).
14  
15  **We kindly ask that you do not upload the distributions to public registries, as it is against our [Terms of use][].**
16  
17  ### with pip (ssh/https)
18  
19  *griffe-pydantic Insiders* can be installed with `pip` [using SSH][install-pip-ssh]:
20  
21  ```bash
22  pip install git+ssh://git@github.com/pawamoy-insiders/griffe-pydantic.git
23  ```
24  
25  Or using HTTPS:
26  
27  ```bash
28  pip install git+https://${GH_TOKEN}@github.com/pawamoy-insiders/griffe-pydantic.git
29  ```
30  
31  >? NOTE: **How to get a GitHub personal access token?** The `GH_TOKEN` environment variable is a GitHub token. It can be obtained by creating a [personal access token][github-pat] for your GitHub account. It will give you access to the Insiders repository, programmatically, from the command line or GitHub Actions workflows:
32  >
33  > 1.  Go to https://github.com/settings/tokens
34  > 2.  Click on [Generate a new token][github-pat-new]
35  > 3.  Enter a name and select the [`repo`][scopes] scope
36  > 4.  Generate the token and store it in a safe place
37  >
38  > Note that the personal access token must be kept secret at all times, as it allows the owner to access your private repositories.
39  
40  ### with Git
41  
42  Of course, you can use *griffe-pydantic Insiders* directly using Git:
43  
44  ```
45  git clone git@github.com:pawamoy-insiders/griffe-pydantic
46  ```
47  
48  When cloning with Git, the package must be installed:
49  
50  ```
51  pip install -e griffe-pydantic
52  ```
53  
54  ## Upgrading
55  
56  When upgrading Insiders, you should always check the version of *griffe-pydantic* which makes up the first part of the version qualifier. For example, a version like `8.x.x.4.x.x` means that Insiders `4.x.x` is currently based on `8.x.x`.
57  
58  If the major version increased, it's a good idea to consult the [changelog][] and go through the steps to ensure your configuration is up to date and all necessary changes have been made.
59  
60  [become an eligible sponsor]: ./index.md#how-to-become-a-sponsor
61  [changelog]: ./changelog.md
62  [github-pat]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
63  [github-pat-new]: https://github.com/settings/tokens/new
64  [insiders-tool]: https://pawamoy.github.io/insiders-project/
65  [install-pip-ssh]: https://docs.github.com/en/authentication/connecting-to-github-with-ssh
66  [scopes]: https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes
67  [terms of use]: ./index.md#terms