Publishing to PyPI

Publish your public-facing Fern Python SDK to the PyPI registry. After following the steps on this page, you’ll have a versioned package published on PyPI.

This page assumes that you have:

An initialized fern folder, a GitHub repository for your Python SDK, and a Python generator group in generators.yml. See Generating an SDK (Python).

Configure SDK package settings

You’ll need to update your generators.yml file to configure the package name, output location, and client naming for PyPi publishing. Your generators.yml should live in your source repository (or on your local machine), not the repository that contains your Python SDK code.

Configure `output` location

In the group for your Python SDK, change the output location in from local-file-system (the default) to pypi to indicate that Fern should publish your package directly to the PyPi registry:

generators.yml

1 groups: 
2   python-sdk:
3     generators:
4       - name: fernapi/fern-python-sdk
5         version: 5.10.0
6         output:
7           location: pypi

Add a unique package name

Your package name must be unique in the PyPI repository, otherwise publishing your SDK to PyPI will fail.

generators.yml

1 groups: 
2   python-sdk:
3     generators:
4       - name: fernapi/fern-python-sdk
5         version: 5.10.0
6         output:
7           location: pypi
8           package-name: your-package-name

Configure `client-class-name`

The client-class-name option controls the name of the generated client. This is the name customers use to import your SDK (import { your-client-name } from 'your-package-name';).

generators.yml

1 groups: 
2   python-sdk:
3     generators:
4       - name: fernapi/fern-python-sdk
5         version: 5.10.0
6         output:
7           location: pypi
8           package-name: your-package-name
9         config:
10           client_class_name: YourClientName # must be PascalCase

Add PyPI metadata (optional)

You can add publishing metadata to your PyPI package to improve discoverability and provide additional information to users. This metadata appears on your package’s PyPI page and includes keywords for PyPI search and discovery, documentation-link for your package documentation, and homepage-link for your project homepage.

You can additionally add general metadata for the SDK (description, contact email, author, license, etc.) at the individual SDK level or globally for all SDKs.

generators.yml

1 groups: 
2   python-sdk:
3     generators:
4       - name: fernapi/fern-python-sdk
5         version: 5.10.0
6         output:
7           location: pypi
8           package-name: your-package-name
9           metadata: # Publishing metadata
10             keywords: ["api", "sdk", "client"]
11             documentation-link: "https://docs.yourcompany.com"
12             homepage-link: "https://yourcompany.com"
13         metadata: # General SDK metadata
14           license: MIT
15         config:
16           client_class_name: YourClientName

Generate a PyPi token

Log into PyPi

Log into PyPi or create a new account.

Navigate to Account settings

Click on your profile picture.
Select Account settings.
Scroll down to API Tokens.

Add New Token

Click on Add API Token
Name your token and set the scope to the relevant projects.
Click Create token

Save your new token – it won’t be displayed after you leave the page.

Configure PyPi publication

Add repository location

Add the path to your GitHub repository to generators.yml:

generators.yml

1 groups: 
2   python-sdk:
3     generators:
4       - name: fernapi/fern-python-sdk
5         version: 5.10.0
6         output:
7           location: pypi
8           package-name: your-package-name
9         config:
10           client_class_name: YourClientName
11         github: 
12           repository: your-org/company-python

Configure PyPi authentication token

Add token: ${PYPI_TOKEN} to generators.yml.

generators.yml

1 groups: 
2   python-sdk:
3     generators:
4       - name: fernapi/fern-python-sdk
5         version: 5.10.0
6         output:
7           location: pypi
8           package-name: your-package-name
9           token: ${PYPI_TOKEN}
10         config:
11           client_class_name: YourClientName
12         github: 
13           repository: your-org/company-python

Choose your publishing mode

Optionally set the mode to control how Fern handles SDK publishing:

mode: release (default): Fern generates code, commits to the default branch (or the branch you specify), and tags a release automatically
mode: pull-request (recommended): Fern generates code and creates a PR for you to review before release
mode: push: Fern generates code and pushes to a branch you specify for you to review before release

You can also configure other settings, like the reviewers or license. Refer to the full github (generators.yml) reference for more information.

generators.yml

1 groups: 
2   python-sdk:
3 	generators:
4 	  - name: fernapi/fern-python-sdk
5 		version: 5.10.0
6 		output:
7 		  location: npm
8 		  package-name: name-of-your-package
9 		  token: ${PYPI_TOKEN}
10 		config:
11 		  namespaceExport: YourClientName
12 		github: 
13 		  repository: your-org/your-repository
14 		  mode: push
15 		  branch: your-branch-name # Required for mode: push

Publish your SDK

Decide how you want to publish your SDK to PyPi. You can use GitHub workflows for automated releases or publish directly via the CLI.

Release via a GitHub workflow (recommended)

Set up a release workflow via GitHub Actions so you can trigger new SDK releases directly from your source repository.

Set up authentication

Open your Fern repository in GitHub. Click on the Settings tab in your repository. Then, under the Security section, open Secrets and variables > Actions.

You can also use the url https://github.com/<your-repo>/settings/secrets/actions.

Add secret for your PyPi Token

Select New repository secret.
Name your secret PYPI_TOKEN.
Add the corresponding token you generated above.
Click Add secret.

Add secret for your Fern Token

Select New repository secret.
Name your secret FERN_TOKEN.
Add your Fern token. If you don’t already have one, generate one by running fern token. By default, the fern_token is generated for the organization listed in fern.config.json.
Click Add secret.

Set up a new workflow

Set up a CI workflow that you can manually trigger from the GitHub UI. In your repository, navigate to Actions. Select New workflow, then Set up workflow yourself. Add a workflow that’s similar to this:

.github/workflows/publish.yml

1 name: Publish Python SDK
2 
3 on:
4   workflow_dispatch:
5     inputs:
6       version:
7         description: "The version of the Python SDK that you would like to release"
8         required: true
9         type: string
10 
11 jobs:
12   release:
13     runs-on: ubuntu-latest
14     steps:
15       - name: Checkout repo
16         uses: actions/checkout@v4
17 
18       - name: Install Fern CLI
19         run: npm install -g fern-api
20 
21       - name: Release Python SDK
22         env:
23           FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
24           PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
25         run: |
26           fern generate --group python-sdk --version ${{ inputs.version }} --log-level debug

Regenerate and release your SDK

Navigate to the Actions tab, select the workflow you just created, specify a version number, and click Run workflow. This regenerates your SDK.

The rest of the release process depends on your chosen mode:

Release mode (default): If you didn’t specify a mode or set mode: release, no further action is required. Fern automatically tags the new release with your specified version number and initiates the publishing workflow in your SDK repository.
Pull request or push mode: If you set mode: pull-request or mode: push, Fern creates a pull request or pushes to a branch respectively. Review and merge the PR (pull-request) or branch (push), then tag a new release to initiate the publishing workflow in your SDK repository.

Once the workflow completes, you can view your new release by logging into PyPi and navigating to Your projects.

Release via CLI and environment variables

Set PyPI environment variable

Set the PYPI_TOKEN environment variable on your local machine:

$ export PYPI_TOKEN=your-actual-pypi-token

Regenerate and release your SDK

Regenerate your SDK, specifying the version:

$ fern generate --group python-sdk --version <version>

The rest of the release process depends on your chosen mode:

Release mode (default): If you didn’t specify a mode or set mode: release, no further action is required. Fern automatically tags the new release with your specified version number and initiates the publishing workflow in your SDK repository.
Pull request or push mode: If you set mode: pull-request or mode: push, Fern creates a pull request or pushes to a branch respectively. Review and merge the PR (pull-request) or branch (push), then tag a new release to initiate the publishing workflow in your SDK repository.

Once the workflow completes, you can view your new release by logging into PyPi and navigating to Your projects.

Publish your public-facing Fern Python SDK to the PyPI registry. After following the steps on this page, you’ll have a versioned package published on PyPI.

This page assumes that you have:

An initialized fern folder, a GitHub repository for your Python SDK, and a Python generator group in generators.yml. See Generating an SDK (Python).

Configure SDK package settings

Configure `output` location

In the group for your Python SDK, change the output location in from local-file-system (the default) to pypi to indicate that Fern should publish your package directly to the PyPi registry:

generators.yml

1 groups: 
2   python-sdk:
3     generators:
4       - name: fernapi/fern-python-sdk
5         version: 5.10.0
6         output:
7           location: pypi

Add a unique package name

Your package name must be unique in the PyPI repository, otherwise publishing your SDK to PyPI will fail.

generators.yml

1 groups: 
2   python-sdk:
3     generators:
4       - name: fernapi/fern-python-sdk
5         version: 5.10.0
6         output:
7           location: pypi
8           package-name: your-package-name

Configure `client-class-name`

The client-class-name option controls the name of the generated client. This is the name customers use to import your SDK (import { your-client-name } from 'your-package-name';).

generators.yml

1 groups: 
2   python-sdk:
3     generators:
4       - name: fernapi/fern-python-sdk
5         version: 5.10.0
6         output:
7           location: pypi
8           package-name: your-package-name
9         config:
10           client_class_name: YourClientName # must be PascalCase

Add PyPI metadata (optional)

You can additionally add general metadata for the SDK (description, contact email, author, license, etc.) at the individual SDK level or globally for all SDKs.

generators.yml

1 groups: 
2   python-sdk:
3     generators:
4       - name: fernapi/fern-python-sdk
5         version: 5.10.0
6         output:
7           location: pypi
8           package-name: your-package-name
9           metadata: # Publishing metadata
10             keywords: ["api", "sdk", "client"]
11             documentation-link: "https://docs.yourcompany.com"
12             homepage-link: "https://yourcompany.com"
13         metadata: # General SDK metadata
14           license: MIT
15         config:
16           client_class_name: YourClientName

Generate a PyPi token

Log into PyPi

Log into PyPi or create a new account.

Navigate to Account settings

Click on your profile picture.
Select Account settings.
Scroll down to API Tokens.

Add New Token

Click on Add API Token
Name your token and set the scope to the relevant projects.
Click Create token

Save your new token – it won’t be displayed after you leave the page.

Configure PyPi publication

Add repository location

Add the path to your GitHub repository to generators.yml:

generators.yml

1 groups: 
2   python-sdk:
3     generators:
4       - name: fernapi/fern-python-sdk
5         version: 5.10.0
6         output:
7           location: pypi
8           package-name: your-package-name
9         config:
10           client_class_name: YourClientName
11         github: 
12           repository: your-org/company-python

Configure PyPi authentication token

Add token: ${PYPI_TOKEN} to generators.yml.

generators.yml

1 groups: 
2   python-sdk:
3     generators:
4       - name: fernapi/fern-python-sdk
5         version: 5.10.0
6         output:
7           location: pypi
8           package-name: your-package-name
9           token: ${PYPI_TOKEN}
10         config:
11           client_class_name: YourClientName
12         github: 
13           repository: your-org/company-python

Choose your publishing mode

Optionally set the mode to control how Fern handles SDK publishing:

mode: release (default): Fern generates code, commits to the default branch (or the branch you specify), and tags a release automatically
mode: pull-request (recommended): Fern generates code and creates a PR for you to review before release
mode: push: Fern generates code and pushes to a branch you specify for you to review before release

You can also configure other settings, like the reviewers or license. Refer to the full github (generators.yml) reference for more information.

generators.yml

1 groups: 
2   python-sdk:
3 	generators:
4 	  - name: fernapi/fern-python-sdk
5 		version: 5.10.0
6 		output:
7 		  location: npm
8 		  package-name: name-of-your-package
9 		  token: ${PYPI_TOKEN}
10 		config:
11 		  namespaceExport: YourClientName
12 		github: 
13 		  repository: your-org/your-repository
14 		  mode: push
15 		  branch: your-branch-name # Required for mode: push

Publish your SDK

Decide how you want to publish your SDK to PyPi. You can use GitHub workflows for automated releases or publish directly via the CLI.

Release via a GitHub workflow (recommended)

Set up a release workflow via GitHub Actions so you can trigger new SDK releases directly from your source repository.

Set up authentication

Open your Fern repository in GitHub. Click on the Settings tab in your repository. Then, under the Security section, open Secrets and variables > Actions.

You can also use the url https://github.com/<your-repo>/settings/secrets/actions.

Add secret for your PyPi Token

Select New repository secret.
Name your secret PYPI_TOKEN.
Add the corresponding token you generated above.
Click Add secret.

Add secret for your Fern Token

Select New repository secret.
Name your secret FERN_TOKEN.
Add your Fern token. If you don’t already have one, generate one by running fern token. By default, the fern_token is generated for the organization listed in fern.config.json.
Click Add secret.

Set up a new workflow

.github/workflows/publish.yml

1 name: Publish Python SDK
2 
3 on:
4   workflow_dispatch:
5     inputs:
6       version:
7         description: "The version of the Python SDK that you would like to release"
8         required: true
9         type: string
10 
11 jobs:
12   release:
13     runs-on: ubuntu-latest
14     steps:
15       - name: Checkout repo
16         uses: actions/checkout@v4
17 
18       - name: Install Fern CLI
19         run: npm install -g fern-api
20 
21       - name: Release Python SDK
22         env:
23           FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
24           PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
25         run: |
26           fern generate --group python-sdk --version ${{ inputs.version }} --log-level debug

Regenerate and release your SDK

Navigate to the Actions tab, select the workflow you just created, specify a version number, and click Run workflow. This regenerates your SDK.

The rest of the release process depends on your chosen mode:

Release mode (default): If you didn’t specify a mode or set mode: release, no further action is required. Fern automatically tags the new release with your specified version number and initiates the publishing workflow in your SDK repository.
Pull request or push mode: If you set mode: pull-request or mode: push, Fern creates a pull request or pushes to a branch respectively. Review and merge the PR (pull-request) or branch (push), then tag a new release to initiate the publishing workflow in your SDK repository.

Once the workflow completes, you can view your new release by logging into PyPi and navigating to Your projects.

Release via CLI and environment variables

Set PyPI environment variable

Set the PYPI_TOKEN environment variable on your local machine:

$ export PYPI_TOKEN=your-actual-pypi-token

Regenerate and release your SDK

Regenerate your SDK, specifying the version:

$ fern generate --group python-sdk --version <version>

The rest of the release process depends on your chosen mode:

Release mode (default): If you didn’t specify a mode or set mode: release, no further action is required. Fern automatically tags the new release with your specified version number and initiates the publishing workflow in your SDK repository.
Pull request or push mode: If you set mode: pull-request or mode: push, Fern creates a pull request or pushes to a branch respectively. Review and merge the PR (pull-request) or branch (push), then tag a new release to initiate the publishing workflow in your SDK repository.

Once the workflow completes, you can view your new release by logging into PyPi and navigating to Your projects.

1	groups:
2	python-sdk:
3	generators:
4	- name: fernapi/fern-python-sdk
5	version: 5.10.0
6	output:
7	location: pypi

1	name: Publish Python SDK
2
3	on:
4	workflow_dispatch:
5	inputs:
6	version:
7	description: "The version of the Python SDK that you would like to release"
8	required: true
9	type: string
10
11	jobs:
12	release:
13	runs-on: ubuntu-latest
14	steps:
15	- name: Checkout repo
16	uses: actions/checkout@v4
17
18	- name: Install Fern CLI
19	run: npm install -g fern-api
20
21	- name: Release Python SDK
22	env:
23	FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
24	PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
25	run: \|
26	fern generate --group python-sdk --version ${{ inputs.version }} --log-level debug

Configure SDK package settings

Configure output location

Add a unique package name

Configure client-class-name

Add PyPI metadata (optional)

Generate a PyPi token

Log into PyPi

Navigate to Account settings

Add New Token

Configure PyPi publication

Add repository location

Configure PyPi authentication token

Choose your publishing mode

Publish your SDK

Release via a GitHub workflow (recommended)

Set up authentication

Add secret for your PyPi Token

Add secret for your Fern Token

Set up a new workflow

Regenerate and release your SDK

Release via CLI and environment variables

Set PyPI environment variable

Regenerate and release your SDK

Configure SDK package settings

Configure output location

Add a unique package name

Configure client-class-name

Add PyPI metadata (optional)

Generate a PyPi token

Log into PyPi

Navigate to Account settings

Add New Token

Configure PyPi publication

Add repository location

Configure PyPi authentication token

Choose your publishing mode

Publish your SDK

Release via a GitHub workflow (recommended)

Set up authentication

Add secret for your PyPi Token

Add secret for your Fern Token

Set up a new workflow

Regenerate and release your SDK

Release via CLI and environment variables

Set PyPI environment variable

Regenerate and release your SDK

Configure `output` location

Configure `client-class-name`

Configure `output` location

Configure `client-class-name`