Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .fern/replay.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# DO NOT EDIT MANUALLY - Managed by Fern Replay
version: "1.0"
generations:
- commit_sha: 1c0ed7f061d32b15b4d3fea2d5a307f57b3f4d31
tree_hash: 4b6868bf849baafbdbec5aa6de743fafad709fcf
timestamp: 2026-06-16T13:15:23.133Z
cli_version: unknown
generator_versions: {}
current_generation: 1c0ed7f061d32b15b4d3fea2d5a307f57b3f4d31
patches: []
4 changes: 3 additions & 1 deletion .fernignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ src/auth0/myorganization/token_provider.py
src/auth0/myorganization/core/client_wrapper.py

# Root auth0 __init__.pys
src/auth0/myorganization/__init__.py
src/auth0/__init__.py

# Tests
Expand All @@ -33,3 +32,6 @@ CHANGELOG.md
.github/
LICENSE
NOTICE.txt
.fern/replay.lock
.fern/replay.yml
.gitattributes
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ jobs:
- name: Configure Python
uses: actions/setup-python@v6
with:
python-version: "3.9"
python-version: "3.12"

- name: Configure dependencies
run: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:

strategy:
matrix:
python-version: ["3.9", "3.10", "3.11", "3.12"]
python-version: ["3.10", "3.11", "3.12"]

steps:
- name: Checkout code
Expand Down
125 changes: 125 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
# Contributing

Thanks for your interest in contributing to this SDK! This document provides guidelines for contributing to the project.

## Getting Started

### Prerequisites

- Python 3.9+
- pip
- poetry

### Installation

Install the project dependencies:

```bash
poetry install
```

### Building

Build the project:

```bash
poetry build
```

### Testing

Run the test suite:

```bash
poetry run pytest
```

### Linting and Formatting

Check code style:

```bash
poetry run ruff check .
poetry run ruff format .
```

### Type Checking

Run the type checker:

```bash
poetry run mypy .
```

## About Generated Code

**Important**: Most files in this SDK are automatically generated by [Fern](https://buildwithfern.com) from the API definition. Direct modifications to generated files will be overwritten the next time the SDK is generated.

### Generated Files

The following directories contain generated code:
- `src/` - API client classes and types
- Most Python files in the project

### How to Customize

If you need to customize the SDK, you have two options:

#### Option 1: Use `.fernignore`

For custom code that should persist across SDK regenerations:

1. Create a `.fernignore` file in the project root
2. Add file patterns for files you want to preserve (similar to `.gitignore` syntax)
3. Add your custom code to those files

Files listed in `.fernignore` will not be overwritten when the SDK is regenerated.

For more information, see the [Fern documentation on custom code](https://buildwithfern.com/learn/sdks/overview/custom-code).

#### Option 2: Contribute to the Generator

If you want to change how code is generated for all users of this SDK:

1. The Python SDK generator lives in the [Fern repository](https://github.com/fern-api/fern)
2. Generator code is located at `generators/python-v2/`
3. Follow the [Fern contributing guidelines](https://github.com/fern-api/fern/blob/main/CONTRIBUTING.md)
4. Submit a pull request with your changes to the generator

This approach is best for:
- Bug fixes in generated code
- New features that would benefit all users
- Improvements to code generation patterns

## Making Changes

### Workflow

1. Create a new branch for your changes
2. Make your modifications
3. Run tests to ensure nothing breaks: `poetry run pytest`
4. Run linting and formatting: `poetry run ruff check .` and `poetry run ruff format .`
5. Run type checking: `poetry run mypy .`
6. Build the project: `poetry build`
7. Commit your changes with a clear commit message
8. Push your branch and create a pull request

### Commit Messages

Write clear, descriptive commit messages that explain what changed and why.

### Code Style

This project uses automated code formatting and linting. Run `poetry run ruff format .` and `poetry run ruff check .` before committing to ensure your code meets the project's style guidelines.

## Questions or Issues?

If you have questions or run into issues:

1. Check the [Fern documentation](https://buildwithfern.com)
2. Search existing [GitHub issues](https://github.com/fern-api/fern/issues)
3. Open a new issue if your question hasn't been addressed

## License

By contributing to this project, you agree that your contributions will be licensed under the same license as the project.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

This library supports the following tooling versions:

- Python >= 3.9
- Python >= 3.10

### Installation

Expand Down
Loading
Loading