ansys-edb-core 0.3.0.dev7__tar.gz → 0.3.0.dev9__tar.gz

ansys_edb_core-0.3.0.dev9/.flake8

@@ -0,0 +1,7 @@
+[flake8]
+exclude = venv, __init__.py, doc/_build, .venv
+select = W191, W291, W293, W391, E115, E117, E122, E124, E125, E225, E231, E301, E303, E501, F401, F403
+count = True
+max-complexity = 10
+max-line-length = 120
+statistics = True

ansys_edb_core-0.3.0.dev9/.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# Global owners
+* @drewm102
+* @ansahershen
+* @chenchienjacklin

ansys_edb_core-0.3.0.dev9/.github/dependabot.yml

@@ -0,0 +1,37 @@
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"
+    cooldown:
+      default-days: 7
+      include:
+        - "*"  # Include all dependencies in cooldown
+      exclude:
+        - "ansys-sphinx-theme"
+    assignees:
+      - "pyansys-ci-bot"
+    labels:
+      - "maintenance"
+      - "dependencies"
+    commit-message:
+      prefix: "BUILD(pip)"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    cooldown:
+      default-days: 7
+      include:
+        - "*"  # Include all dependencies in cooldown
+      exclude:
+        - "ansys/actions"
+    assignees:
+      - "pyansys-ci-bot"
+    labels:
+      - "maintenance"
+      - "dependencies"
+    commit-message:
+      prefix: "BUILD(actions)"

ansys_edb_core-0.3.0.dev9/.github/workflows/ci_cd.yml

@@ -0,0 +1,228 @@
+name: GitHub CI
+on:
+  pull_request:
+  push:
+    tags:
+      - '*'
+    branches:
+      - release-*
+      - main
+  workflow_dispatch:
+
+env:
+  PACKAGE_NAME: 'ansys-edb-core'
+  DOCUMENTATION_CNAME: 'edb.core.docs.pyansys.com'
+  MAIN_PYTHON_VERSION: '3.10'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+
+  doc-style:
+      name: Documentation Style Check
+      runs-on: ubuntu-latest
+      steps:
+        - name: PyAnsys documentation style checks
+          uses: ansys/actions/doc-style@33399106dc8b62d83c8aad1fb2c333c8055df180 # v10.0.20
+          with:
+            token: ${{ secrets.GITHUB_TOKEN }}
+            fail-level: 'warning'
+
+  doc-build:
+    name: Documentation build
+    runs-on: ubuntu-latest
+    needs: [doc-style]
+    steps:
+      - name: Documentation build
+        uses: ansys/actions/doc-build@33399106dc8b62d83c8aad1fb2c333c8055df180 # v10.0.20
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+          use-python-cache: false
+          sphinxopts: '-j auto -w build_errors.txt -N -q'
+
+  smoke-tests:
+    name: Build and Smoke tests
+    runs-on: ${{ matrix.os }}
+    permissions:
+      attestations: write
+      contents: read
+      id-token: write
+    needs: [doc-style]
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest, ubuntu-latest]
+        python-version: ['3.10', '3.11', '3.12', '3.13']
+    steps:
+      - name: Build wheelhouse and perform smoke test
+        uses: ansys/actions/build-wheelhouse@33399106dc8b62d83c8aad1fb2c333c8055df180 # v10.0.20
+        with:
+          library-name: ${{ env.PACKAGE_NAME }}
+          operating-system: ${{ matrix.os }}
+          python-version: ${{ matrix.python-version }}
+          attest-provenance: true
+
+  tests:
+    name: Tests and coverage
+    needs: [smoke-tests]
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [windows-latest, ubuntu-latest]
+        python-version: ['3.10', '3.11', '3.12', '3.13']
+      fail-fast: false
+    steps:
+      - name: Install Git and checkout project
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - name: Setup Python
+        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade .[tests]
+          python -m pip install --upgrade tox-gh-actions
+      - name: Test with tox
+        # Only the tox environment specified in the tox.ini gh-actions is run
+        run: tox -e test -- --ignore=tests/e2e
+
+  package:
+    name: Package library (Windows)
+    # Uses ansys/actions/build-library to produce the sdist and Windows platform
+    # wheel.  The action hardcodes the artifact name to "${library-name}-artifacts"
+    # so only one job can use it per workflow run.  The Linux wheel is produced by
+    # the separate package-linux job using explicit steps with a distinct artifact
+    # name, which the release job's pattern "${PACKAGE_NAME}-artifacts*" still
+    # matches.
+    runs-on: windows-latest
+    needs: [tests, doc-build]
+    permissions:
+      attestations: write
+      contents: read
+      id-token: write
+    steps:
+      - name: Build library source and wheel artifacts
+        uses: ansys/actions/build-library@33399106dc8b62d83c8aad1fb2c333c8055df180 # v10.0.20
+        with:
+          library-name: ${{ env.PACKAGE_NAME }}
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+          attest-provenance: true
+
+  package-linux:
+    name: Package library (Linux manylinux)
+    # Produces manylinux_2_28_x86_64 platform wheels for all supported Python
+    # versions using cibuildwheel.  The sdist is already produced by the Windows
+    # package job above.  Uses a distinct artifact name to avoid the 409 Conflict
+    # that ansys/actions/build-library would cause (it hardcodes the artifact name
+    # to "${library-name}-artifacts" with no override).
+    #
+    # auditwheel repair is run with --exclude libstdc++.so.6 because rpc_executor.so
+    # relies on the .pth preload hook (ansys_edb_core_preload.py) to supply the
+    # AnsysEM-bundled libstdc++.so.6 at runtime.  That library provides GLIBCXX up
+    # to 3.4.30, which covers every symbol rpc_executor.so needs.  Letting
+    # auditwheel bundle a second copy would conflict with the preload mechanism and
+    # could cause the wrong libstdc++ to be used when libEDB_RPC_Services.so loads.
+    runs-on: ubuntu-latest
+    needs: [tests, doc-build]
+    permissions:
+      attestations: write
+      contents: read
+      id-token: write
+    steps:
+      - name: Install Git and checkout project
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - name: Build manylinux wheels with cibuildwheel
+        uses: pypa/cibuildwheel@v2.22.0
+        env:
+          # Build CPython 3.10-3.13 on Linux x86_64 only.
+          CIBW_BUILD: "cp310-* cp311-* cp312-* cp313-*"
+          CIBW_ARCHS: "x86_64"
+          # manylinux_2_28 (AlmaLinux 8, GCC 8.5) is the oldest baseline whose
+          # system libstdc++ supports the __cxx11 ABI by default (GCC 5+).
+          # Combined with the explicit _GLIBCXX_USE_CXX11_ABI=1 flag in
+          # CMakeLists.txt this guarantees std::string layout compatibility with
+          # libEDB_RPC_Services.so, which was built with GCC 12.
+          CIBW_MANYLINUX_X86_64_IMAGE: "quay.io/pypa/manylinux_2_28_x86_64"
+          # Exclude libstdc++.so.6 from the repaired wheel — see job comment above.
+          CIBW_REPAIR_WHEEL_COMMAND_LINUX: >-
+            auditwheel repair --exclude libstdc++.so.6 -w {dest_dir} {wheel}
+        with:
+          output-dir: dist
+      - name: Check build health
+        run: pip install twine && python -m twine check dist/*
+      - name: Upload distribution artifacts to GitHub artifacts
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          name: ${{ env.PACKAGE_NAME }}-artifacts-linux
+          path: dist/
+          retention-days: 7
+      - name: Generate build provenance attestation
+        uses: actions/attest-build-provenance@db473fddc028af60658334401dc6fa3ffd8669fd # v2.3.0
+        with:
+          subject-path: dist/
+
+  release:
+    name: Release project
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
+    needs: [package, package-linux]
+    runs-on: ubuntu-latest
+    # Specifying a GitHub environment is optional, but strongly encouraged
+    environment: release
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - name: Download all library artifacts (Windows sdist+wheel and Linux wheel)
+        # Collects 'ansys-edb-core-artifacts' (Windows: sdist + win_amd64 wheel)
+        # and 'ansys-edb-core-artifacts-linux' (Linux: linux_x86_64 wheel only)
+        # into a single directory for PyPI upload.
+        uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
+        with:
+          pattern: ${{ env.PACKAGE_NAME }}-artifacts*
+          merge-multiple: true
+          path: ${{ env.PACKAGE_NAME }}-artifacts
+      - name: Release to PyPI using trusted publisher
+        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # v1.13.0
+        with:
+          repository-url: "https://upload.pypi.org/legacy/"
+          print-hash: true
+          packages-dir: ${{ env.PACKAGE_NAME }}-artifacts
+          skip-existing: true
+      - name: Release to GitHub
+        uses: ansys/actions/release-github@33399106dc8b62d83c8aad1fb2c333c8055df180 # v10.0.20
+        with:
+          library-name: ${{ env.PACKAGE_NAME }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          add-artifact-attestation-notes: true
+
+  doc-deploy-dev:
+    name: "Deploy development documentation"
+    # Deploy development only when merging or pushing to the 'main' branch
+    if: github.event_name == 'push' && !contains(github.ref, 'refs/tags')
+    runs-on: ubuntu-latest
+    needs: [package, package-linux, tests, doc-build]
+    steps:
+      - uses: ansys/actions/doc-deploy-dev@33399106dc8b62d83c8aad1fb2c333c8055df180 # v10.0.20
+        with:
+          cname: ${{ env.DOCUMENTATION_CNAME }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          doc-artifact-name: documentation-html
+          bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+          bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
+
+  doc-deploy-stable:
+    name: "Deploy stable documentation"
+    # Deploy release documentation when creating a new tag
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
+    runs-on: ubuntu-latest
+    needs: release
+    steps:
+      - uses: ansys/actions/doc-deploy-stable@33399106dc8b62d83c8aad1fb2c333c8055df180 # v10.0.20
+        with:
+          cname: ${{ env.DOCUMENTATION_CNAME }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          doc-artifact-name: documentation-html
+          bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+          bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}

ansys_edb_core-0.3.0.dev9/.github/workflows/template.yml

@@ -0,0 +1,16 @@
+name: Template Validation
+
+on:
+  pull_request:
+    types: [opened, edited, synchronize]
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  pr-title:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - name: Run a PR title validation
+        run: grep -E "^(CI:|DOC:|REFACT:|FIX:|MAINT:|TEST:|FEATURE:)" <<< "${{ github.event.pull_request.title }}"

ansys_edb_core-0.3.0.dev9/.gitignore

@@ -0,0 +1,173 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+.pyd-cache/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+test-results.xml
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+doc/_build/
+doc/source/api/_autosummary
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+notebooks/results
+
+# IPython
+profile_default/
+ipython_config.py
+
+# proto stuff
+*pb2.py
+*pb2_grpc.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv*
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintainted in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+
+
+# End of https://www.toptal.com/developers/gitignore/api/python
+
+# Ansys EDB backups, etc.
+**/*.aedb/**/*+
+**/*.aedb/**/*.bak
+**/*.aedb/**/*.tmp

ansys_edb_core-0.3.0.dev9/.pre-commit-config.yaml

@@ -0,0 +1,68 @@
+repos:
+
+- repo: https://github.com/psf/black
+  rev: 23.9.1  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
+  hooks:
+  - id: black
+
+- repo: https://github.com/adamchainz/blacken-docs
+  rev: 1.16.0
+  hooks:
+  - id: blacken-docs
+    additional_dependencies: [black==23.9.1]
+
+- repo: https://github.com/pycqa/isort
+  rev: 5.12.0
+  hooks:
+  - id: isort
+
+- repo: https://github.com/PyCQA/flake8
+  rev: 6.1.0
+  hooks:
+  - id: flake8
+
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.2.6
+  hooks:
+  - id: codespell
+    exclude: (?x)(^notebooks)
+    args: ["--ignore-words", "doc/styles/config/vocabularies/ANSYS/accept.txt"]
+
+- repo: https://github.com/pycqa/pydocstyle
+  rev: 6.3.0
+  hooks:
+  - id: pydocstyle
+    additional_dependencies: [tomli]
+    exclude: "tests/"
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.5.0
+  hooks:
+  - id: check-merge-conflict
+  - id: debug-statements
+  - id: check-yaml
+  - id: trailing-whitespace
+    exclude: (?x)^(.*\.def)
+
+# - repo: https://github.com/ansys/pre-commit-hooks
+#   rev: v0.2.2
+#   hooks:
+#     - id: add-license-headers
+#       args: ["--loc", "./"]
+
+# FIXME: See if this local hooks could be replaced with using
+# https://github.com/kynan/nbstripout
+- repo: local
+  hooks:
+    - id: cleanipynb-helpers
+      name: cleanipynb-helpers
+      language: system
+      entry: python scripts/cleanipynb.py
+      files: notebooks/helpers/[^/]*\.ipynb$
+
+    - id: cleanipynb
+      name: cleanipynb
+      language: system
+      entry: python scripts/cleanipynb.py
+      args: [--leave-outputs]
+      files: notebooks/[^/]*\.ipynb$

ansys_edb_core-0.3.0.dev9/AUTHORS

@@ -0,0 +1,12 @@
+# This is the list of PyEDB-Core significant contributors.
+#
+# This file does not necessarily list everyone who has contributed code.
+#
+# For contributions made under a Corporate CLA, the organization is
+# added to this file.
+#
+# If you have contributed to the repository and want to be added to this file,
+# submit a request.
+#
+#
+ANSYS, Inc.

ansys_edb_core-0.3.0.dev9/CMakeLists.txt

@@ -0,0 +1,77 @@
+cmake_minimum_required(VERSION 3.15)
+
+# ---------------------------------------------------------------------------
+# Optional: install a pre-built extension instead of compiling from source.
+# Set the PREBUILT_PYD environment variable (or pass -DPREBUILT_PYD=<path>)
+# to the absolute path of a previously compiled rpc_executor .pyd file.
+# bootstrap.ps1 sets this automatically when a cached build is available.
+# Using LANGUAGES NONE avoids compiler detection entirely on cache hits.
+# ---------------------------------------------------------------------------
+if(NOT DEFINED PREBUILT_PYD)
+    set(PREBUILT_PYD "$ENV{PREBUILT_PYD}")
+endif()
+# Normalise to forward slashes so CMake does not misinterpret Windows
+# backslashes as escape sequences (e.g. \a, \n) in the install() call.
+if(PREBUILT_PYD)
+    file(TO_CMAKE_PATH "${PREBUILT_PYD}" PREBUILT_PYD)
+endif()
+
+# ---------------------------------------------------------------------------
+# The .pth hook that pre-loads the AnsysEM libstdc++.so.6 before any other
+# C extension can claim the system version.  Both files are installed to the
+# platlib root (site-packages) so that Python's site.py picks up the .pth
+# file on every interpreter startup.
+# ---------------------------------------------------------------------------
+set(PRELOAD_PY  "${CMAKE_CURRENT_SOURCE_DIR}/src/ansys_edb_core_preload.py")
+set(PRELOAD_PTH "${CMAKE_CURRENT_SOURCE_DIR}/src/ansys_edb_core_preload.pth")
+
+if(PREBUILT_PYD)
+    # bootstrap.ps1 / bootstrap.sh cache hit: install the cached extension
+    # directly without compiling.  LANGUAGES NONE skips compiler detection.
+    project(rpc_executor LANGUAGES NONE)
+    message(STATUS "Cache hit: installing pre-built extension ${PREBUILT_PYD}")
+    install(FILES "${PREBUILT_PYD}" DESTINATION ansys/edb/core/)
+    install(FILES "${PRELOAD_PY}" "${PRELOAD_PTH}" DESTINATION ".")
+
+elseif(WIN32)
+    # Windows: compile the pybind11 extension with the MSVC toolchain and
+    # define RPC_EXECUTOR_PLATFORM_WINDOWS so that rpc_executor.h selects
+    # the Windows code paths (HMODULE, LoadLibraryA, SetDllDirectoryA, etc.).
+    project(rpc_executor LANGUAGES CXX)
+    find_package(Python COMPONENTS Interpreter Development.Module REQUIRED)
+    find_package(pybind11 CONFIG REQUIRED)
+
+    pybind11_add_module(rpc_executor deps/rpc_executor_bindings.cpp)
+    target_include_directories(rpc_executor PRIVATE deps/)
+    target_compile_features(rpc_executor PRIVATE cxx_std_17)
+    target_compile_definitions(rpc_executor PRIVATE RPC_EXECUTOR_PLATFORM_WINDOWS)
+
+    install(TARGETS rpc_executor DESTINATION ansys/edb/core/)
+    install(FILES "${PRELOAD_PY}" "${PRELOAD_PTH}" DESTINATION ".")
+
+else()
+    # Linux / macOS: compile with the system C++ toolchain.
+    # RPC_EXECUTOR_PLATFORM_WINDOWS is intentionally NOT defined, so
+    # rpc_executor.h uses the POSIX code paths (dlopen, dladdr, etc.).
+    project(rpc_executor LANGUAGES CXX)
+    find_package(Python COMPONENTS Interpreter Development.Module REQUIRED)
+    find_package(pybind11 CONFIG REQUIRED)
+
+    pybind11_add_module(rpc_executor deps/rpc_executor_bindings.cpp)
+    target_include_directories(rpc_executor PRIVATE deps/)
+    target_compile_features(rpc_executor PRIVATE cxx_std_17)
+    # Force the new (post-GCC-5) C++11 std::string ABI so that std::string
+    # objects cross the rpc_executor / libEDB_RPC_Services.so boundary with
+    # the same 32-byte layout.  libEDB_RPC_Services.so is built with GCC 12
+    # and uses the __cxx11 ABI; without this flag an older system GCC or a
+    # Python interpreter built with _GLIBCXX_USE_CXX11_ABI=0 would produce
+    # mismatched 8-byte (old-ABI) strings, corrupting the stack on return.
+    target_compile_definitions(rpc_executor PRIVATE _GLIBCXX_USE_CXX11_ABI=1)
+    # CMAKE_DL_LIBS is '-ldl' on Linux (needed for dlopen/dlsym) and
+    # empty on platforms where those symbols are built in (e.g. macOS).
+    target_link_libraries(rpc_executor PRIVATE ${CMAKE_DL_LIBS})
+
+    install(TARGETS rpc_executor DESTINATION ansys/edb/core/)
+    install(FILES "${PRELOAD_PY}" "${PRELOAD_PTH}" DESTINATION ".")
+
+endif()

ansys_edb_core-0.3.0.dev9/CODE_OF_CONDUCT.md

@@ -0,0 +1,65 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our
+project and our community a harassment-free experience for everyone,
+regardless of age, body size, disability, ethnicity, sex
+characteristics, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance,
+race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual
+  attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening,
+offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at
+https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq