wriftai 0.13.0__tar.gz

wriftai-0.13.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,64 @@
+name: Bug report
+description: Report an issue or bug with this library
+labels: ['bug']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: checkboxes
+    id: non_api
+    attributes:
+      label: Confirm this is an issue with the Python library and not an underlying WriftAI API
+      description: Issues with the underlying WriftAI API should be reported on our [Discord Server](https://discord.gg/wp4F6c8vFh)
+      options:
+        - label: This is an issue with the Python library
+          required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is, and any additional context.
+      placeholder: Tell us what you see!
+    validations:
+      required: true
+  - type: textarea
+    id: repro-steps
+    attributes:
+      label: To Reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1. Fetch a '...'
+        2. Update the '....'
+        3. See error
+    validations:
+      required: true
+  - type: textarea
+    id: code-snippets
+    attributes:
+      label: Code snippets
+      description: If applicable, add code snippets to help explain your problem.
+      render: Python
+    validations:
+      required: false
+  - type: input
+    id: os
+    attributes:
+      label: OS
+      placeholder: macOS
+    validations:
+      required: true
+  - type: input
+    id: language-version
+    attributes:
+      label: Python version
+      placeholder: Python v3.11.4
+    validations:
+      required: true
+  - type: input
+    id: lib-version
+    attributes:
+      label: Library version
+      placeholder: wriftai v1.0.1
+    validations:
+      required: true

wriftai-0.13.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: WriftAI support
+    url: https://wrift.ai/forms/help
+    about: |
+      Please only file issues here that you believe represent actual bugs
+      or feature requests for the WriftAI Python library. If you're having general trouble
+      with WriftAI, please visit our help center to get support.

wriftai-0.13.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,28 @@
+name: Feature request
+description: Suggest an idea for this library
+labels: ['feature-request']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request!
+  - type: checkboxes
+    id: non_api
+    attributes:
+      label: Confirm this is a feature request for the Python library and not the underlying WriftAI API.
+      description: Feature requests for the underlying WriftAI API should be reported on our [Discord Server](https://discord.gg/8JVeSdnJE4)
+      options:
+        - label: This is a feature request for the Python library
+          required: true
+  - type: textarea
+    id: feature
+    attributes:
+      label: Describe the feature or improvement you're requesting
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Add any other context about the feature request here.

wriftai-0.13.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,22 @@
+## Overview
+
+<!-- Explanation of what has been done and why -->
+
+## Summary of Changes
+
+<!-- Bullet points highlighting key features and or significant changes
+        introduced by this PR. -->
+
+-
+-
+-
+
+## Testing
+
+<!-- Details of how the changes were tested and any relevant results-->
+
+## Issue
+
+<!-- Reference to the related issues or tickets -->
+
+#<issue_number>

wriftai-0.13.0/.github/actions/setup-python-env/action.yml

@@ -0,0 +1,30 @@
+name: "Setup Python Environment"
+description: "Set up Python environment for the given Python version"
+
+inputs:
+  python-version:
+    description: "Python version to use"
+    required: true
+    default: "3.13"
+  uv-version:
+    description: "uv version to use"
+    required: true
+    default: "0.6.14"
+
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
+      with:
+        version: ${{ inputs.uv-version }}
+        enable-cache: 'true'
+        cache-suffix: ${{ matrix.python-version }}
+
+    - name: Install Python dependencies
+      run: uv sync --frozen
+      shell: bash

wriftai-0.13.0/.github/labels.yml

@@ -0,0 +1,59 @@
+- name: enhancement
+  description: 'New feature or request'
+  color: '84b6eb'
+
+- name: bug
+  description: 'Something isn’t working'
+  color: 'd73a4a'
+
+- name: documentation
+  description: 'Improvements or additions to documentation'
+  color: '0075ca'
+
+- name: refactor
+  description: 'Code change that neither fixes a bug nor adds a feature'
+  color: 'fbca04'
+
+- name: test
+  description: 'Adding or updating tests'
+  color: 'd4c5f9'
+
+- name: ci
+  description: 'Continuous Integration'
+  color: '0052cc'
+
+- name: breaking-change
+  description: 'Introduces a breaking change'
+  color: 'b60205'
+
+- name: dependencies
+  description: 'Add or update a dependency file'
+  color: '0e8a16'
+
+- name: duplicate
+  description: 'This issue or pull request already exists'
+  color: 'cfd3d7'
+
+- name: question
+  description: 'Further information is requested'
+  color: 'd876e3'
+
+- name: wontfix
+  description: 'This will not be worked on'
+  color: 'ffffff'
+
+- name: removal
+  description: 'Removal or deprecation'
+  color: '9ae7ea'
+
+- name: good first issue
+  description: 'Good for newcomers'
+  color: '7057ff'
+
+- name: help wanted
+  description: 'Extra attention is needed'
+  color: '008672'
+
+- name: performance
+  description: 'Improves performance'
+  color: 'f9d0c4'

wriftai-0.13.0/.github/workflows/ci.yml

@@ -0,0 +1,93 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  quality-checks-and-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+      fail-fast: false
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+
+      - name: Set up the environment
+        uses: ./.github/actions/setup-python-env
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run quality checks
+        run: make check
+
+      - name: Run unit and integration tests
+        run: make test
+      
+      - name: Generate docs
+        if: ${{ matrix.python-version == '3.13' }}
+        run: make docs
+
+      # Ensures documentation is always up to date.
+      # The check fails if `make docs` was not run or if generated docs differ
+      # from committed files.
+      # The diff check excludes metadata (+++, ---) lines.
+      - name: Check for meaningful docs changes
+        if: ${{ matrix.python-version == '3.13' }}
+        run: |
+          if git diff -U0 docs/reference \
+            | grep -E '^[+-]' \
+            | grep -vE '^(---|\+\+\+)' \
+            | grep -q .; then
+            echo "❌ Meaningful docs changes detected"
+            exit 1
+          else
+            echo "✅ No meaningful docs changes"
+          fi   
+
+  release:
+    needs: quality-checks-and-test
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+
+    # Release job needs higher permissions than the test job
+    permissions:
+      contents: write # create tags & GitHub releases
+      pull-requests: write # open/update Release PR
+      id-token: write # OIDC for PyPI Trusted Publishing
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # full history & tags help Release Please
+
+      - name: Release Please
+        id: release
+        uses: googleapis/release-please-action@v4
+        with:
+          config-file: 'release-please-config.json'
+          manifest-file: '.release-please-manifest.json'
+
+      - name: Set up the python environment
+        if: steps.release.outputs.release_created == 'true'
+        uses: ./.github/actions/setup-python-env
+
+      - name: Build package
+        if: steps.release.outputs.release_created == 'true'
+        run: |
+          make build
+
+      # Publish to PyPI via Trusted Publishing (no API token needed)
+      - name: Publish to PyPI
+        if: steps.release.outputs.release_created == 'true'
+        run: uv publish

wriftai-0.13.0/.github/workflows/labeler.yml

@@ -0,0 +1,22 @@
+name: Labeler
+on:
+ push:
+   branches:
+     - main
+   paths:
+     - '.github/labels.yml'
+     - '.github/workflows/labeler.yml'
+jobs:
+ labeler:
+   runs-on: ubuntu-latest
+   permissions:
+     contents: read
+     issues: write
+   steps:
+     - name: Checkout
+       uses: actions/checkout@v4
+     - name: Run labeler
+       uses: crazy-max/ghaction-github-labeler@v5
+       with:
+         github-token: ${{ secrets.GITHUB_TOKEN }}
+         yaml-file: .github/labels.yml

wriftai-0.13.0/.gitignore

@@ -0,0 +1,35 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+
+# Distribution / packaging
+.Python
+build/
+dist/
+
+# Unit test / coverage reports
+htmlcov
+.coverage
+coverage.xml
+.pytest_cache/
+
+# pyenv
+.python-version
+
+# Environments
+.venv
+
+# mypy
+.mypy_cache/
+
+# Visual Studio Code
+.vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# Sphinx build cache (doctrees)
+sphinx/doctrees/
+
+# Ignore autogenerated RST files from sphinx-apidoc
+sphinx/wriftai.*.rst
+sphinx/wriftai.rst

wriftai-0.13.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.13.0"
+}

wriftai-0.13.0/CHANGELOG.md

@@ -0,0 +1,125 @@
+# Changelog
+
+## [0.13.0](https://github.com/wriftai/wriftai-python/compare/v0.12.0...v0.13.0) (2025-12-05)
+
+
+### Features
+
+* Combined model owner and name into one parameter. ([#147](https://github.com/wriftai/wriftai-python/issues/147)) ([2bc7d6a](https://github.com/wriftai/wriftai-python/commit/2bc7d6ac77825ea78499e843e7d98900db2e420f))
+
+## [0.12.0](https://github.com/wriftai/wriftai-python/compare/v0.11.0...v0.12.0) (2025-12-02)
+
+
+### Features
+
+* Added sorting direction for listing models and users. ([#145](https://github.com/wriftai/wriftai-python/issues/145)) ([5d214f6](https://github.com/wriftai/wriftai-python/commit/5d214f6e4b1f1bb3127de29c2c938ffd102bdc55))
+
+## [0.11.0](https://github.com/wriftai/wriftai-python/compare/v0.10.0...v0.11.0) (2025-11-25)
+
+
+### Features
+
+* Update README.md, fix integration test imports and change init module frontmatter in docs. ([#141](https://github.com/wriftai/wriftai-python/issues/141)) ([14899c0](https://github.com/wriftai/wriftai-python/commit/14899c0bb50809ef8ff7b849ab49b04c85c6baa3))
+
+## [0.10.0](https://github.com/wriftai/wriftai-python/compare/v0.9.0...v0.10.0) (2025-11-21)
+
+
+### Features
+
+* Added on_poll callback in WaitOptions. ([#129](https://github.com/wriftai/wriftai-python/issues/129)) ([314aad3](https://github.com/wriftai/wriftai-python/commit/314aad38dca99743e4464f98303e7c787f5e5f18))
+
+## [0.9.0](https://github.com/wriftai/wriftai-python/compare/v0.8.0...v0.9.0) (2025-11-21)
+
+
+### Features
+
+* Added slug in hardware resource. ([#134](https://github.com/wriftai/wriftai-python/issues/134)) ([1ddb577](https://github.com/wriftai/wriftai-python/commit/1ddb5770e479f1dedcd2dce27dcdaf401d246f30))
+* Replaced hardware name with identifier for models. ([#136](https://github.com/wriftai/wriftai-python/issues/136)) ([837f1f8](https://github.com/wriftai/wriftai-python/commit/837f1f8f980e80a3ba8ed5c4fd65ebca2d72f18a))
+
+## [0.8.0](https://github.com/wriftai/wriftai-python/compare/v0.7.0...v0.8.0) (2025-11-13)
+
+
+### Features
+
+* Added more sorting options for listing models and users. ([#124](https://github.com/wriftai/wriftai-python/issues/124)) ([47a6455](https://github.com/wriftai/wriftai-python/commit/47a6455dee8b57f9257d89906c71af4c42e43095))
+
+## [0.7.0](https://github.com/wriftai/wriftai-python/compare/v0.6.1...v0.7.0) (2025-11-12)
+
+
+### Features
+
+* Add automated documentation ([#110](https://github.com/wriftai/wriftai-python/issues/110)) ([51012cf](https://github.com/wriftai/wriftai-python/commit/51012cf6e8b30851a6672327dad3716f4f4d4f2f))
+
+## [0.6.1](https://github.com/wriftai/wriftai-python/compare/v0.6.0...v0.6.1) (2025-11-07)
+
+
+### Bug Fixes
+
+* Updated metadata in pyproject.toml ([#114](https://github.com/wriftai/wriftai-python/issues/114)) ([3c79429](https://github.com/wriftai/wriftai-python/commit/3c79429697d8346d40bc870eb2b9d6bcc5da19bd))
+
+## [0.6.0](https://github.com/wriftai/wriftai-python/compare/v0.5.0...v0.6.0) (2025-11-07)
+
+
+### Features
+
+* Updated wait method to take prediction id. ([#120](https://github.com/wriftai/wriftai-python/issues/120)) ([1b1461a](https://github.com/wriftai/wriftai-python/commit/1b1461a35beb9403c7abc85951aa5674005d8207))
+
+## [0.5.0](https://github.com/wriftai/wriftai-python/compare/v0.4.0...v0.5.0) (2025-10-17)
+
+
+### Features
+
+* Updated Prediction's create method to support waiting. ([#100](https://github.com/wriftai/wriftai-python/issues/100)) ([b862837](https://github.com/wriftai/wriftai-python/commit/b862837fde8aa59783725047a93a8df6f043ccbd))
+
+## [0.4.0](https://github.com/wriftai/wriftai-python/compare/v0.3.0...v0.4.0) (2025-10-16)
+
+
+### Features
+
+* renamed APIRequestor to API and made it public ([#101](https://github.com/wriftai/wriftai-python/issues/101)) ([a75167a](https://github.com/wriftai/wriftai-python/commit/a75167a9e88545d43e5711533fa7e8de814a2eea))
+
+## [0.3.0](https://github.com/wriftai/wriftai-python/compare/v0.2.0...v0.3.0) (2025-10-15)
+
+
+### Features
+
+* Removed Unpack and update version create method ([#105](https://github.com/wriftai/wriftai-python/issues/105)) ([356bc31](https://github.com/wriftai/wriftai-python/commit/356bc315f0688eefa5d4bdb98cb9fb03bc988a73))
+
+## [0.2.0](https://github.com/wriftai/wriftai-python/compare/v0.1.0...v0.2.0) (2025-10-09)
+
+
+### Features
+
+* Updated model's create method ([#98](https://github.com/wriftai/wriftai-python/issues/98)) ([c4c2a01](https://github.com/wriftai/wriftai-python/commit/c4c2a01a8ebc96ab32f4667c28f10ee32d8cc088))
+
+## 0.1.0 (2025-10-03)
+
+
+### Features
+
+* Add release step in CI and code hygiene. ([#80](https://github.com/wriftai/wriftai-python/issues/80)) ([adb5caf](https://github.com/wriftai/wriftai-python/commit/adb5caf5316d094257b792b2156327f7272f2df5))
+* Add support for listing models by username ([#61](https://github.com/wriftai/wriftai-python/issues/61)) ([bbde584](https://github.com/wriftai/wriftai-python/commit/bbde584983792155db64891def0534e5c11acb82))
+* Added Async client with lazy initialization ([#16](https://github.com/wriftai/wriftai-python/issues/16)) ([b8b6711](https://github.com/wriftai/wriftai-python/commit/b8b67112fa4cefe938960c4d39af99fcacfbb367))
+* Added Authenticated User resource ([#26](https://github.com/wriftai/wriftai-python/issues/26)) ([297ed6c](https://github.com/wriftai/wriftai-python/commit/297ed6c7ed284b9151ebe5e4e2fd0fdc0e41cb4a))
+* Added get model version using sync and async function ([#31](https://github.com/wriftai/wriftai-python/issues/31)) ([9169faf](https://github.com/wriftai/wriftai-python/commit/9169faff78019fd446a464f4f2f95493b5a4cb0e))
+* Added hardware resource with unit and integration tests ([#21](https://github.com/wriftai/wriftai-python/issues/21)) ([c71a0e0](https://github.com/wriftai/wriftai-python/commit/c71a0e0d8ca201db3b4d6db275d5b6dd7185b39d))
+* Added issue and PR templates ([#74](https://github.com/wriftai/wriftai-python/issues/74)) ([89c7581](https://github.com/wriftai/wriftai-python/commit/89c7581e0a0ff79848472648d14e4e79c928ff6f))
+* Added Model resource ([#48](https://github.com/wriftai/wriftai-python/issues/48)) ([a414d75](https://github.com/wriftai/wriftai-python/commit/a414d75de8ed0891ad345dbd75906b3eecfdf977))
+* Added model update functionality ([#68](https://github.com/wriftai/wriftai-python/issues/68)) ([8f147ba](https://github.com/wriftai/wriftai-python/commit/8f147ba63a1998a5328bc0a08c6cae8ba6259103))
+* Added support for creating model. ([#54](https://github.com/wriftai/wriftai-python/issues/54)) ([8571723](https://github.com/wriftai/wriftai-python/commit/8571723640a0eb2c4e963a83a8f8e5bd29aa2bfb))
+* Added support for deleting a model. ([#51](https://github.com/wriftai/wriftai-python/issues/51)) ([158f76a](https://github.com/wriftai/wriftai-python/commit/158f76a52ce153b71af20fa5e0c655ab06165891))
+* Added support for get prediction and integration tests ([#20](https://github.com/wriftai/wriftai-python/issues/20)) ([339f8b7](https://github.com/wriftai/wriftai-python/commit/339f8b79dad3454ccadedff07b775e866c62ae5e))
+* Added support for getting a model. ([#53](https://github.com/wriftai/wriftai-python/issues/53)) ([1b53664](https://github.com/wriftai/wriftai-python/commit/1b536642b207b720b85eb68958e3fd5ce9a00226))
+* Added support for listing model versions ([ba72342](https://github.com/wriftai/wriftai-python/commit/ba72342a66aef4d3b547443cca1d22e29d7cee27))
+* Added support for listing models of authenticated user ([#58](https://github.com/wriftai/wriftai-python/issues/58)) ([13e97ae](https://github.com/wriftai/wriftai-python/commit/13e97aef810a3c8c570823f64d92cfcf48351e4a))
+* Added support for listing models. ([#49](https://github.com/wriftai/wriftai-python/issues/49)) ([b3cb941](https://github.com/wriftai/wriftai-python/commit/b3cb94127cc12efecba997b5d06f641b8ef3ceb0))
+* Added support for listing predictions ([#35](https://github.com/wriftai/wriftai-python/issues/35)) ([89839fb](https://github.com/wriftai/wriftai-python/commit/89839fbea376219ff5755984587754d8239c44ec))
+* Added support for listing users ([#32](https://github.com/wriftai/wriftai-python/issues/32)) ([3fc836b](https://github.com/wriftai/wriftai-python/commit/3fc836bee1b92e7c2ba266c5d5f5804d82a50ae3))
+* Added support for searching models based on query. ([#63](https://github.com/wriftai/wriftai-python/issues/63)) ([5d15dfe](https://github.com/wriftai/wriftai-python/commit/5d15dfe6ddba1fee365449820d65dd2031e41111))
+* Added support for searching users based on query. ([#62](https://github.com/wriftai/wriftai-python/issues/62)) ([1a854d1](https://github.com/wriftai/wriftai-python/commit/1a854d1b99d67da50729980f0b43c34931d34ea5))
+* Added support to create prediction against latest and specific version. ([#60](https://github.com/wriftai/wriftai-python/issues/60)) ([c7eebb7](https://github.com/wriftai/wriftai-python/commit/c7eebb74038765d7afc5a79e21b40f5d36e9fbb5))
+* Added support to make pagination fields optional. ([5a8a061](https://github.com/wriftai/wriftai-python/commit/5a8a061c9c1c0846c52c6e3fe72883292f88fc99))
+* Added sync client with lazy initialization ([#8](https://github.com/wriftai/wriftai-python/issues/8)) ([3bf396c](https://github.com/wriftai/wriftai-python/commit/3bf396ce4f62301c078e86e057510230cc83af47))
+* Added User resource ([#22](https://github.com/wriftai/wriftai-python/issues/22)) ([76eded4](https://github.com/wriftai/wriftai-python/commit/76eded46a91f118cc8ad4fe51369478097c4d3aa))
+* Added wait and async_wait methods to Predictions resource ([#73](https://github.com/wriftai/wriftai-python/issues/73)) ([73468a0](https://github.com/wriftai/wriftai-python/commit/73468a0db34c95cc49fec4041cbd91a073846782))
+* Update authenticated users ([#69](https://github.com/wriftai/wriftai-python/issues/69)) ([649d1b7](https://github.com/wriftai/wriftai-python/commit/649d1b7144d90072790efb3a86a01f5f92148858))

wriftai-0.13.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[wriftai@sych.io](mailto:wriftai@sych.io).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][mozilla coc].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][faq]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[mozilla coc]: https://github.com/mozilla/diversity
+[faq]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations