octp-python 0.2.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. octp_python-0.2.0/.github/ISSUE_TEMPLATE/bug_report.md +33 -0
  2. octp_python-0.2.0/.github/ISSUE_TEMPLATE/feature_request.md +25 -0
  3. octp_python-0.2.0/.github/ISSUE_TEMPLATE/spec-question.md +26 -0
  4. octp_python-0.2.0/.github/workflows/release.yml +34 -0
  5. octp_python-0.2.0/.github/workflows/test.yml +35 -0
  6. octp_python-0.2.0/.gitignore +216 -0
  7. octp_python-0.2.0/.octp-envelope.json +42 -0
  8. octp_python-0.2.0/.octp.toml +30 -0
  9. octp_python-0.2.0/CHANGELOG.md +115 -0
  10. octp_python-0.2.0/CODE_OF_CONDUCT.md +85 -0
  11. octp_python-0.2.0/CONTRIBUTING.md +68 -0
  12. octp_python-0.2.0/LICENSE +21 -0
  13. octp_python-0.2.0/PKG-INFO +319 -0
  14. octp_python-0.2.0/README.md +266 -0
  15. octp_python-0.2.0/docs/ci-integration.md +395 -0
  16. octp_python-0.2.0/docs/configuration.md +362 -0
  17. octp_python-0.2.0/docs/installation.md +133 -0
  18. octp_python-0.2.0/docs/profiles.md +327 -0
  19. octp_python-0.2.0/docs/quickstart.md +264 -0
  20. octp_python-0.2.0/docs/troubleshooting.md +410 -0
  21. octp_python-0.2.0/pyproject.toml +68 -0
  22. octp_python-0.2.0/scripts/deploy.sh +116 -0
  23. octp_python-0.2.0/src/octp/__init__.py +9 -0
  24. octp_python-0.2.0/src/octp/cli/__init__.py +0 -0
  25. octp_python-0.2.0/src/octp/cli/init.py +54 -0
  26. octp_python-0.2.0/src/octp/cli/main.py +19 -0
  27. octp_python-0.2.0/src/octp/cli/sign.py +133 -0
  28. octp_python-0.2.0/src/octp/cli/verify.py +61 -0
  29. octp_python-0.2.0/src/octp/core/__init__.py +0 -0
  30. octp_python-0.2.0/src/octp/core/builder.py +103 -0
  31. octp_python-0.2.0/src/octp/core/envelope.py +90 -0
  32. octp_python-0.2.0/src/octp/core/validator.py +28 -0
  33. octp_python-0.2.0/src/octp/git/__init__.py +0 -0
  34. octp_python-0.2.0/src/octp/git/reader.py +64 -0
  35. octp_python-0.2.0/src/octp/identity/__init__.py +0 -0
  36. octp_python-0.2.0/src/octp/identity/keymanager.py +75 -0
  37. octp_python-0.2.0/src/octp/identity/resolver.py +41 -0
  38. octp_python-0.2.0/src/octp/integrity/__init__.py +0 -0
  39. octp_python-0.2.0/src/octp/integrity/hasher.py +14 -0
  40. octp_python-0.2.0/src/octp/output/__init__.py +0 -0
  41. octp_python-0.2.0/src/octp/output/formatter.py +83 -0
  42. octp_python-0.2.0/src/octp/output/writer.py +15 -0
  43. octp_python-0.2.0/src/octp/provenance/__init__.py +0 -0
  44. octp_python-0.2.0/src/octp/provenance/collector.py +119 -0
  45. octp_python-0.2.0/src/octp/provenance/models.py +8 -0
  46. octp_python-0.2.0/src/octp/verification/__init__.py +0 -0
  47. octp_python-0.2.0/src/octp/verification/bandit_runner.py +38 -0
  48. octp_python-0.2.0/src/octp/verification/base.py +33 -0
  49. octp_python-0.2.0/src/octp/verification/deps_runner.py +38 -0
  50. octp_python-0.2.0/src/octp/verification/detect_secrets_runner.py +51 -0
  51. octp_python-0.2.0/src/octp/verification/mypy_runner.py +44 -0
  52. octp_python-0.2.0/src/octp/verification/pytest_runner.py +68 -0
  53. octp_python-0.2.0/src/octp/verification/registry.py +130 -0
  54. octp_python-0.2.0/src/octp/verification/ruff_runner.py +44 -0
  55. octp_python-0.2.0/src/octp/verification/safety_runner.py +39 -0
  56. octp_python-0.2.0/src/octp/verification/semgrep_runner.py +46 -0
  57. octp_python-0.2.0/tests/conftest.py +16 -0
  58. octp_python-0.2.0/tests/fixtures/minimal_envelope.json +24 -0
  59. octp_python-0.2.0/tests/fixtures/tampered_envelope.json +24 -0
  60. octp_python-0.2.0/tests/fixtures/valid_envelope.json +41 -0
  61. octp_python-0.2.0/tests/test_envelope.py +27 -0
  62. octp_python-0.2.0/tests/test_integrity.py +18 -0
  63. octp_python-0.2.0/tests/test_performance.py +37 -0
  64. octp_python-0.2.0/tests/test_runners.py +134 -0
@@ -0,0 +1,33 @@
1
+ ---
2
+ name: Bug report
3
+ about: Create a report to help us improve
4
+ title: ''
5
+ labels: ''
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ ---
11
+ name: Bug Report
12
+ about: Something is broken
13
+ labels: type: bug, status: needs-triage
14
+ ---
15
+
16
+ **What happened?**
17
+
18
+
19
+ **What did you expect to happen?**
20
+
21
+
22
+ **How to reproduce**
23
+ Steps:
24
+ 1.
25
+ 2.
26
+ 3.
27
+
28
+ **Environment**
29
+ - OS:
30
+ - Python version:
31
+ - octp version:
32
+
33
+ **Additional context**
@@ -0,0 +1,25 @@
1
+ ---
2
+ name: Feature request
3
+ about: Suggest an idea for this project
4
+ title: ''
5
+ labels: ''
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ ---
11
+ name: Feature Request
12
+ about: An idea for improving the tool
13
+ labels: type: tooling, status: needs-triage
14
+ ---
15
+
16
+ **What problem does this solve?**
17
+ Describe the problem, not the solution.
18
+
19
+ **Who experiences this problem?**
20
+
21
+
22
+ **What have you tried instead?**
23
+
24
+
25
+ **Additional context**
@@ -0,0 +1,26 @@
1
+ ---
2
+ name: Spec Question
3
+ about: Describe this issue template's purpose here.
4
+ title: ''
5
+ labels: ''
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ ---
11
+ name: Spec Question
12
+ about: Something in the specification is unclear or missing
13
+ labels: type: spec, status: needs-triage
14
+ ---
15
+
16
+ **Which section or field?**
17
+
18
+
19
+ **What is unclear or missing?**
20
+
21
+
22
+ **What do you think it should say, and why?**
23
+
24
+
25
+ **Are you willing to submit a PR with a clarification?**
26
+ Yes / No
@@ -0,0 +1,34 @@
1
+ name: Release
2
+
3
+ on:
4
+ push:
5
+ tags:
6
+ - "v*"
7
+
8
+ jobs:
9
+ release:
10
+ runs-on: ubuntu-latest
11
+ steps:
12
+ - uses: actions/checkout@v4
13
+
14
+ - name: Set up Python
15
+ uses: actions/setup-python@v5
16
+ with:
17
+ python-version: "3.11"
18
+
19
+ - name: Install build tools
20
+ run: pip install build twine
21
+
22
+ - name: Build package
23
+ run: python -m build
24
+
25
+ - name: Publish to PyPI
26
+ env:
27
+ TWINE_USERNAME: __token__
28
+ TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
29
+ run: twine upload dist/*
30
+
31
+ - name: Create GitHub Release
32
+ uses: softprops/action-gh-release@v1
33
+ with:
34
+ generate_release_notes: true
@@ -0,0 +1,35 @@
1
+ name: Tests
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+ branches: [main]
8
+
9
+ jobs:
10
+ test:
11
+ runs-on: ubuntu-latest
12
+ strategy:
13
+ matrix:
14
+ python-version: ["3.11", "3.12"]
15
+
16
+ steps:
17
+ - uses: actions/checkout@v4
18
+
19
+ - name: Set up Python ${{ matrix.python-version }}
20
+ uses: actions/setup-python@v5
21
+ with:
22
+ python-version: ${{ matrix.python-version }}
23
+
24
+ - name: Install dependencies
25
+ run: |
26
+ pip install -e ".[dev]"
27
+
28
+ - name: Lint with ruff
29
+ run: ruff check src/ tests/
30
+
31
+ - name: Type check with mypy
32
+ run: mypy src/
33
+
34
+ - name: Run tests
35
+ run: pytest
@@ -0,0 +1,216 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[codz]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py.cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ #Pipfile.lock
96
+
97
+ # UV
98
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ #uv.lock
102
+
103
+ # poetry
104
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
106
+ # commonly ignored for libraries.
107
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108
+ #poetry.lock
109
+ #poetry.toml
110
+
111
+ # pdm
112
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
113
+ # pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
114
+ # https://pdm-project.org/en/latest/usage/project/#working-with-version-control
115
+ #pdm.lock
116
+ #pdm.toml
117
+ .pdm-python
118
+ .pdm-build/
119
+
120
+ # pixi
121
+ # Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
122
+ #pixi.lock
123
+ # Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
124
+ # in the .venv directory. It is recommended not to include this directory in version control.
125
+ .pixi
126
+
127
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
128
+ __pypackages__/
129
+
130
+ # Celery stuff
131
+ celerybeat-schedule
132
+ celerybeat.pid
133
+
134
+ # SageMath parsed files
135
+ *.sage.py
136
+
137
+ # Environments
138
+ .env
139
+ .envrc
140
+ .venv
141
+ env/
142
+ venv/
143
+ ENV/
144
+ env.bak/
145
+ venv.bak/
146
+
147
+ # Spyder project settings
148
+ .spyderproject
149
+ .spyproject
150
+
151
+ # Rope project settings
152
+ .ropeproject
153
+
154
+ # mkdocs documentation
155
+ /site
156
+
157
+ # mypy
158
+ .mypy_cache/
159
+ .dmypy.json
160
+ dmypy.json
161
+
162
+ # Pyre type checker
163
+ .pyre/
164
+
165
+ # pytype static type analyzer
166
+ .pytype/
167
+
168
+ # Cython debug symbols
169
+ cython_debug/
170
+
171
+ # PyCharm
172
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
173
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
174
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
175
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
176
+ #.idea/
177
+
178
+ # Abstra
179
+ # Abstra is an AI-powered process automation framework.
180
+ # Ignore directories containing user credentials, local state, and settings.
181
+ # Learn more at https://abstra.io/docs
182
+ .abstra/
183
+
184
+ # Visual Studio Code
185
+ # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
186
+ # that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
187
+ # and can be added to the global gitignore or merged into this file. However, if you prefer,
188
+ # you could uncomment the following to ignore the entire vscode folder
189
+ # .vscode/
190
+
191
+ # Ruff stuff:
192
+ .ruff_cache/
193
+
194
+ # PyPI configuration file
195
+ .pypirc
196
+
197
+ # Cursor
198
+ # Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
199
+ # exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
200
+ # refer to https://docs.cursor.com/context/ignore-files
201
+ .cursorignore
202
+ .cursorindexingignore
203
+
204
+ # Marimo
205
+ marimo/_static/
206
+ marimo/_lsp/
207
+ __marimo__/
208
+
209
+ # Deployment tokens and secrets
210
+ pypi-token*
211
+ .twine-token
212
+ .pypi-credentials
213
+ .secrets/
214
+
215
+ # OCTP generated envelopes (optional - uncomment if you want to commit them)
216
+ # .octp-envelope.json
@@ -0,0 +1,42 @@
1
+ {
2
+ "octp_version": "0.1",
3
+ "contribution_id": "91456d79-5179-4f97-bd19-ab4cc0787350",
4
+ "timestamp": "2026-02-26T13:03:42.609792Z",
5
+ "repository": "github.com/openoctp/octp-python",
6
+ "commit_hash": "b453802d6452e8fef317aac922b8a18b8205afa0",
7
+ "provenance": {
8
+ "method": "ai_assisted_human_reviewed",
9
+ "ai_tools": [
10
+ {
11
+ "model": "claude-sonnet-4-6",
12
+ "vendor": "anthropic",
13
+ "version": "20260226",
14
+ "usage_type": "architecture_and_implementation"
15
+ },
16
+ {
17
+ "model": "kimi-k2.5",
18
+ "vendor": "moonshot",
19
+ "version": "20260226",
20
+ "usage_type": "implementation_and_scaffolding"
21
+ }
22
+ ],
23
+ "human_review_level": "substantial_modification",
24
+ "human_review_duration_minutes": null,
25
+ "developer_id": "email:yussuf.x56@gmail.com"
26
+ },
27
+ "verification": {
28
+ "tests_passed": null,
29
+ "test_suite_hash": null,
30
+ "static_analysis": "skipped",
31
+ "static_analysis_tool": null,
32
+ "dependency_check": "skipped",
33
+ "novel_dependencies_introduced": false
34
+ },
35
+ "integrity": {
36
+ "payload_hash": "4138707972978f30b70fe52e01d605479c3d4d053ed103f71722d214aa1ba4f7",
37
+ "developer_signature": "MEYCIQCzaz3W8R+ciczTU4W+uRY3k2LpZAFRQMe3nE5ebu4jKQIhAID8FpM+sUGw1XOgVt42ABBUi5ajMjJUJSXVW5ByVyoq",
38
+ "signature_algorithm": "ES256",
39
+ "signed_at": "2026-02-26T13:03:42.621699Z"
40
+ },
41
+ "optional_context": null
42
+ }
@@ -0,0 +1,30 @@
1
+ [policy]
2
+ require_envelope = true
3
+ minimum_review_level = "moderate_review"
4
+ block_on_failed_tests = true
5
+ allow_unreviewed_ai = false
6
+
7
+ [runners]
8
+ default_profile = "ci"
9
+ test_runner = "pytest"
10
+ linting = "ruff"
11
+ type_checking = "mypy"
12
+ static_analysis = "semgrep"
13
+ security_scan = "bandit"
14
+ dependency_check = "pip-audit"
15
+ secret_detection = "detect-secrets"
16
+
17
+ [identity]
18
+ require_signed_envelope = true
19
+ key_registry = "github"
20
+
21
+ # OCTP is built with AI assistance. Every commit declares this honestly.
22
+ # This project eats its own cooking — we use the trust envelope we built.
23
+ [provenance]
24
+ # Default for this repo: AI-assisted with substantial human review
25
+ # Contributors: Update these fields when running `octp sign` interactively
26
+ expected_method = "ai_assisted_human_reviewed"
27
+ ai_tools = [
28
+ { model = "claude-sonnet-4-6", vendor = "anthropic", usage = "architecture_and_design" },
29
+ { model = "kimi-k2.5", vendor = "moonshot", usage = "implementation_and_scaffolding" }
30
+ ]
@@ -0,0 +1,115 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ Format based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [Unreleased]
9
+
10
+ ## [0.2.0] — 2026-02-26
11
+
12
+ ### Added
13
+
14
+ - **Runner Profiles** — Four optimized profiles for different workflows:
15
+ - `fast`: 3-8 seconds, essential checks only (ruff, bandit, detect-secrets)
16
+ - `ci`: 30-60 seconds, balanced coverage (pytest, ruff, bandit, pip-audit, detect-secrets)
17
+ - `security`: 30-60 seconds, security-focused (bandit, pip-audit, detect-secrets, semgrep)
18
+ - `full`: 2-4 minutes, comprehensive (all 7 runners)
19
+ - Select via `--profile` flag or `default_profile` in config
20
+
21
+ - **Parallel Execution** — Runners now execute in parallel using ThreadPoolExecutor
22
+ - 40-60% faster execution on multi-core machines
23
+ - Graceful handling of runner crashes
24
+
25
+ - **New Runners**:
26
+ - `ruff_runner`: Python linting (Rust-based, very fast)
27
+ - `mypy_runner`: Type checking for typed codebases
28
+ - `detect_secrets_runner`: Secret and credential detection
29
+
30
+ - **Non-Interactive Mode** — Automatic detection of non-TTY environments
31
+ - Uses sensible defaults (AI-assisted, substantial review)
32
+ - Shows warning when falling back to defaults
33
+ - Supports `--yes` flag to suppress warnings
34
+ - Honest AI disclosure with both Claude and Kimi listed
35
+
36
+ - **Honest AI Disclosure** — Default provenance for OCTP project:
37
+ - Method: `ai_assisted_human_reviewed`
38
+ - AI tools: Claude (Anthropic) and Kimi (Moonshot)
39
+ - Review level: `substantial_modification`
40
+ - Demonstrates the tool's own use case
41
+
42
+ - **Comprehensive Test Suite** — 20 tests covering:
43
+ - Envelope parsing and validation
44
+ - Integrity/hashing
45
+ - Runner profiles and parallel execution
46
+ - Performance benchmarks
47
+
48
+ - **Documentation** — Complete documentation suite:
49
+ - `installation.md`: Platform-specific install guides
50
+ - `quickstart.md`: 5-minute getting started
51
+ - `profiles.md`: Detailed profile comparison
52
+ - `configuration.md`: `.octp.toml` reference
53
+ - `ci-integration.md`: GitHub Actions, GitLab CI, etc.
54
+ - `troubleshooting.md`: Common issues and solutions
55
+
56
+ ### Changed
57
+
58
+ - **Improved Test Display** — Tests now show:
59
+ - ✓ passed — Tests ran and passed
60
+ - ✗ failed — Tests ran and failed
61
+ - ○ skipped — Tests not run (appropriate profile)
62
+
63
+ - **Better Error Handling** — Graceful degradation:
64
+ - Handles missing verification tools
65
+ - Handles network timeouts (pip-audit, safety)
66
+ - Handles interactive prompt failures
67
+ - Continues with available tools
68
+
69
+ - **Code Quality** — Full ruff and mypy compliance
70
+ - All code passes linting
71
+ - Type annotations throughout
72
+ - Clean test fixtures
73
+
74
+ ### Fixed
75
+
76
+ - **Non-Interactive Crashes** — Tool no longer crashes when prompts fail
77
+ - **Template Text in READMEs** — Removed placeholder text
78
+ - **Runner Base Class** — Fixed abstract method declaration
79
+ - **Import Ordering** — Fixed all ruff I001 errors
80
+ - **Detect-Secrets Exception** — Changed bare except to specific JSONDecodeError
81
+
82
+ ### Removed
83
+
84
+ - **Safety Runner** — Removed as duplicate of pip-audit
85
+ - Both check for known CVEs in dependencies
86
+ - pip-audit is faster and more reliable
87
+ - Safety remains in codebase but not in profiles
88
+
89
+ ## [0.1.0] — 2026-02-26
90
+
91
+ ### Added
92
+
93
+ - Initial release of the OCTP reference implementation
94
+ - Core envelope generation with `octp sign`
95
+ - Envelope verification with `octp verify`
96
+ - Repository initialization with `octp init`
97
+ - Pydantic envelope model implementing OCTP spec v0.1
98
+ - ES256 cryptographic signing via the cryptography library
99
+ - Automatic keypair generation and management
100
+ - Git integration via GitPython
101
+ - Verification runners:
102
+ - pytest_runner: Test execution
103
+ - semgrep_runner: Static analysis
104
+ - bandit_runner: Security scanning
105
+ - deps_runner: Dependency vulnerability check (pip-audit)
106
+ - Rich terminal output with human-readable trust summary
107
+ - `.octp.toml` project configuration
108
+ - JSON Schema for envelope validation
109
+ - Example envelopes (minimal and full)
110
+ - RFC process and governance structure
111
+ - CONTRIBUTING.md and CODE_OF_CONDUCT.md
112
+
113
+ [Unreleased]: https://github.com/openoctp/octp-python/compare/v0.2.0...HEAD
114
+ [0.2.0]: https://github.com/openoctp/octp-python/compare/v0.1.0...v0.2.0
115
+ [0.1.0]: https://github.com/openoctp/octp-python/releases/tag/v0.1.0
@@ -0,0 +1,85 @@
1
+
2
+ # Contributor Covenant Code of Conduct
3
+
4
+ ## Our Pledge
5
+
6
+ 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.
7
+
8
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
9
+
10
+ ## Our Standards
11
+
12
+ Examples of behavior that contributes to a positive environment for our community include:
13
+
14
+ * Demonstrating empathy and kindness toward other people
15
+ * Being respectful of differing opinions, viewpoints, and experiences
16
+ * Giving and gracefully accepting constructive feedback
17
+ * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
18
+ * Focusing on what is best not just for us as individuals, but for the overall community
19
+
20
+ Examples of unacceptable behavior include:
21
+
22
+ * The use of sexualized language or imagery, and sexual attention or advances of any kind
23
+ * Trolling, insulting or derogatory comments, and personal or political attacks
24
+ * Public or private harassment
25
+ * Publishing others' private information, such as a physical or email address, without their explicit permission
26
+ * Other conduct which could reasonably be considered inappropriate in a professional setting
27
+
28
+ ## Enforcement Responsibilities
29
+
30
+ 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.
31
+
32
+ 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.
33
+
34
+ ## Scope
35
+
36
+ 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.
37
+
38
+ ## Enforcement
39
+
40
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
41
+
42
+ All community leaders are obligated to respect the privacy and security of the reporter of any incident.
43
+
44
+ ## Enforcement Guidelines
45
+
46
+ Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
47
+
48
+ ### 1. Correction
49
+
50
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
51
+
52
+ **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.
53
+
54
+ ### 2. Warning
55
+
56
+ **Community Impact**: A violation through a single incident or series of actions.
57
+
58
+ **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.
59
+
60
+ ### 3. Temporary Ban
61
+
62
+ **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
63
+
64
+ **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.
65
+
66
+ ### 4. Permanent Ban
67
+
68
+ **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.
69
+
70
+ **Consequence**: A permanent ban from any sort of public interaction within the community.
71
+
72
+ ## Attribution
73
+
74
+ 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].
75
+
76
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
77
+
78
+ 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].
79
+
80
+ [homepage]: https://www.contributor-covenant.org
81
+ [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
82
+ [Mozilla CoC]: https://github.com/mozilla/diversity
83
+ [FAQ]: https://www.contributor-covenant.org/faq
84
+ [translations]: https://www.contributor-covenant.org/translations
85
+