dotenvmodel 0.2.0__tar.gz → 0.3.1__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 (113) hide show
  1. dotenvmodel-0.3.1/.github/CODEOWNERS +1 -0
  2. dotenvmodel-0.3.1/.github/ISSUE_TEMPLATE/bug_report.md +33 -0
  3. dotenvmodel-0.3.1/.github/ISSUE_TEMPLATE/feature_request.md +21 -0
  4. dotenvmodel-0.3.1/.github/dependabot.yml +13 -0
  5. dotenvmodel-0.3.1/.github/pull_request_template.md +23 -0
  6. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/.github/workflows/ci.yml +40 -20
  7. dotenvmodel-0.3.1/.github/workflows/docs.yml +56 -0
  8. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/.github/workflows/publish.yml +7 -11
  9. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/.github/workflows/release-please.yml +3 -1
  10. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/.gitignore +10 -5
  11. dotenvmodel-0.3.1/.release-please-manifest.json +3 -0
  12. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/CHANGELOG.md +21 -7
  13. dotenvmodel-0.3.1/CODE_OF_CONDUCT.md +127 -0
  14. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/CONTRIBUTING.md +11 -11
  15. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/Makefile +2 -2
  16. dotenvmodel-0.2.0/README.md → dotenvmodel-0.3.1/PKG-INFO +69 -5
  17. dotenvmodel-0.2.0/PKG-INFO → dotenvmodel-0.3.1/README.md +41 -35
  18. dotenvmodel-0.3.1/SECURITY.md +23 -0
  19. dotenvmodel-0.3.1/docs/api-reference/coercion.md +5 -0
  20. dotenvmodel-0.3.1/docs/api-reference/config.md +5 -0
  21. dotenvmodel-0.3.1/docs/api-reference/constants.md +5 -0
  22. dotenvmodel-0.3.1/docs/api-reference/describe-formatters.md +5 -0
  23. dotenvmodel-0.3.1/docs/api-reference/describe-renderers.md +5 -0
  24. dotenvmodel-0.3.1/docs/api-reference/describe.md +5 -0
  25. dotenvmodel-0.3.1/docs/api-reference/dotenvmodel.md +31 -0
  26. dotenvmodel-0.3.1/docs/api-reference/exceptions.md +5 -0
  27. dotenvmodel-0.3.1/docs/api-reference/fields.md +5 -0
  28. dotenvmodel-0.3.1/docs/api-reference/loading.md +5 -0
  29. dotenvmodel-0.3.1/docs/api-reference/logging-config.md +5 -0
  30. dotenvmodel-0.3.1/docs/api-reference/metaclass.md +5 -0
  31. dotenvmodel-0.3.1/docs/api-reference/types.md +5 -0
  32. dotenvmodel-0.3.1/docs/api-reference/validation.md +5 -0
  33. dotenvmodel-0.3.1/docs/changelog.md +36 -0
  34. dotenvmodel-0.3.1/docs/examples/complete-app.md +354 -0
  35. dotenvmodel-0.3.1/docs/getting-started/installation.md +54 -0
  36. dotenvmodel-0.3.1/docs/getting-started/quick-start.md +186 -0
  37. dotenvmodel-0.3.1/docs/guides/configuration-docs.md +340 -0
  38. dotenvmodel-0.3.1/docs/guides/error-handling.md +277 -0
  39. dotenvmodel-0.3.1/docs/guides/fields.md +216 -0
  40. dotenvmodel-0.3.1/docs/guides/loading.md +205 -0
  41. dotenvmodel-0.3.1/docs/guides/logging.md +205 -0
  42. dotenvmodel-0.3.1/docs/guides/prefixes.md +152 -0
  43. dotenvmodel-0.3.1/docs/guides/types.md +540 -0
  44. dotenvmodel-0.3.1/docs/guides/validation.md +387 -0
  45. dotenvmodel-0.3.1/docs/index.md +133 -0
  46. dotenvmodel-0.3.1/dotenvmodel/__init__.py +82 -0
  47. dotenvmodel-0.3.1/dotenvmodel/_constants.py +3 -0
  48. dotenvmodel-0.3.1/dotenvmodel/_redaction.py +260 -0
  49. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/dotenvmodel/coercion.py +174 -33
  50. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/dotenvmodel/config.py +166 -222
  51. dotenvmodel-0.3.1/dotenvmodel/describe/__init__.py +159 -0
  52. dotenvmodel-0.3.1/dotenvmodel/describe/formatters.py +430 -0
  53. dotenvmodel-0.3.1/dotenvmodel/describe/renderers.py +309 -0
  54. dotenvmodel-0.3.1/dotenvmodel/exceptions.py +301 -0
  55. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/dotenvmodel/fields.py +167 -31
  56. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/dotenvmodel/loading.py +65 -23
  57. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/dotenvmodel/logging_config.py +43 -20
  58. dotenvmodel-0.3.1/dotenvmodel/metaclass.py +133 -0
  59. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/dotenvmodel/types.py +249 -75
  60. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/dotenvmodel/validation.py +48 -13
  61. dotenvmodel-0.3.1/mkdocs.yml +124 -0
  62. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/pyproject.toml +21 -19
  63. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_basic.py +1 -1
  64. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_coercion.py +7 -7
  65. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_describe.py +342 -26
  66. dotenvmodel-0.3.1/tests/test_edge_adoption.py +159 -0
  67. dotenvmodel-0.3.1/tests/test_edge_datetime.py +173 -0
  68. dotenvmodel-0.3.1/tests/test_edge_describe_output.py +144 -0
  69. dotenvmodel-0.3.1/tests/test_edge_enum.py +245 -0
  70. dotenvmodel-0.3.1/tests/test_edge_field_options.py +133 -0
  71. dotenvmodel-0.3.1/tests/test_edge_numbers.py +188 -0
  72. dotenvmodel-0.3.1/tests/test_edge_path_options.py +90 -0
  73. dotenvmodel-0.3.1/tests/test_edge_strings.py +172 -0
  74. dotenvmodel-0.3.1/tests/test_enum.py +531 -0
  75. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_field_constraints.py +1 -1
  76. dotenvmodel-0.3.1/tests/test_future_annotations.py +144 -0
  77. dotenvmodel-0.3.1/tests/test_secret_redaction.py +632 -0
  78. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_secretstr_security.py +18 -3
  79. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_types.py +4 -3
  80. dotenvmodel-0.3.1/uv.lock +1117 -0
  81. dotenvmodel-0.2.0/.release-please-manifest.json +0 -3
  82. dotenvmodel-0.2.0/.vscode/settings.json +0 -7
  83. dotenvmodel-0.2.0/dotenvmodel/__init__.py +0 -45
  84. dotenvmodel-0.2.0/dotenvmodel/describe.py +0 -985
  85. dotenvmodel-0.2.0/dotenvmodel/exceptions.py +0 -131
  86. dotenvmodel-0.2.0/uv.lock +0 -366
  87. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/.python-version +0 -0
  88. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/LICENSE +0 -0
  89. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/dotenvmodel/py.typed +0 -0
  90. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/examples/advanced_types.py +0 -0
  91. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/examples/basic_usage.py +0 -0
  92. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/examples/describe_documentation.py +0 -0
  93. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/examples/generate_env_example.py +0 -0
  94. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/examples/logging_example.py +0 -0
  95. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/release-please-config.json +0 -0
  96. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/__init__.py +0 -0
  97. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/conftest.py +0 -0
  98. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_collection_validators.py +0 -0
  99. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_empty_collection_items.py +0 -0
  100. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_empty_strings.py +0 -0
  101. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_errors.py +0 -0
  102. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_inheritance.py +0 -0
  103. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_json.py +0 -0
  104. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_json_and_optional.py +0 -0
  105. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_loading.py +0 -0
  106. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_logging_config.py +0 -0
  107. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_prefix.py +0 -0
  108. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_reload.py +0 -0
  109. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_union_types.py +0 -0
  110. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_url_dsn.py +0 -0
  111. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_url_password_decoding.py +0 -0
  112. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_url_unquote.py +0 -0
  113. {dotenvmodel-0.2.0 → dotenvmodel-0.3.1}/tests/test_urls.py +0 -0
@@ -0,0 +1 @@
1
+ * @rich-evans
@@ -0,0 +1,33 @@
1
+ ---
2
+ name: Bug Report
3
+ about: Report a bug or unexpected behavior
4
+ labels: bug
5
+ ---
6
+
7
+ ## Description
8
+
9
+ A clear description of what the bug is.
10
+
11
+ ## Reproduction
12
+
13
+ ```python
14
+ # Minimal code to reproduce the issue
15
+ ```
16
+
17
+ ## Expected Behavior
18
+
19
+ What you expected to happen.
20
+
21
+ ## Actual Behavior
22
+
23
+ What actually happened (include full error output).
24
+
25
+ ## Environment
26
+
27
+ - dotenvmodel version:
28
+ - Python version:
29
+ - OS:
30
+
31
+ ## Additional Context
32
+
33
+ Any other context (logs, .env file contents with secrets redacted, etc.).
@@ -0,0 +1,21 @@
1
+ ---
2
+ name: Feature Request
3
+ about: Suggest a new feature or enhancement
4
+ labels: enhancement
5
+ ---
6
+
7
+ ## Problem
8
+
9
+ What problem does this feature solve? What's the current limitation?
10
+
11
+ ## Proposed Solution
12
+
13
+ Describe the feature or change you'd like to see.
14
+
15
+ ## Alternatives Considered
16
+
17
+ Any alternative approaches you've considered.
18
+
19
+ ## Additional Context
20
+
21
+ Any other context, examples, or references.
@@ -0,0 +1,13 @@
1
+ version: 2
2
+ updates:
3
+ - package-ecosystem: pip
4
+ directory: /
5
+ schedule:
6
+ interval: weekly
7
+ open-pull-requests-limit: 5
8
+
9
+ - package-ecosystem: github-actions
10
+ directory: /
11
+ schedule:
12
+ interval: weekly
13
+ open-pull-requests-limit: 5
@@ -0,0 +1,23 @@
1
+ ## Summary
2
+
3
+ Brief description of what this PR does and why.
4
+
5
+ ## Changes
6
+
7
+ - Change 1
8
+ - Change 2
9
+
10
+ ## Testing
11
+
12
+ Describe how you tested these changes (commands run, tests added, etc.).
13
+
14
+ ```bash
15
+ uv run pytest
16
+ uv run pyright dotenvmodel
17
+ uv run ruff check .
18
+ uv run ruff format --check .
19
+ ```
20
+
21
+ ## Related Issues
22
+
23
+ Fixes #123
@@ -6,14 +6,21 @@ on:
6
6
  pull_request:
7
7
  branches: [main]
8
8
 
9
+ concurrency:
10
+ group: ci-${{ github.ref }}
11
+ cancel-in-progress: true
12
+
13
+ permissions:
14
+ contents: read
15
+
9
16
  jobs:
10
17
  lint:
11
18
  runs-on: ubuntu-latest
12
19
  steps:
13
- - uses: actions/checkout@v4
20
+ - uses: actions/checkout@v7
14
21
 
15
22
  - name: Install uv
16
- uses: astral-sh/setup-uv@v4
23
+ uses: astral-sh/setup-uv@v7
17
24
  with:
18
25
  enable-cache: true
19
26
 
@@ -21,7 +28,7 @@ jobs:
21
28
  run: uv python install 3.12
22
29
 
23
30
  - name: Install dependencies
24
- run: uv sync --all-extras
31
+ run: uv sync --group dev
25
32
 
26
33
  - name: Lint with ruff
27
34
  run: uv run ruff check .
@@ -32,10 +39,10 @@ jobs:
32
39
  typecheck:
33
40
  runs-on: ubuntu-latest
34
41
  steps:
35
- - uses: actions/checkout@v4
42
+ - uses: actions/checkout@v7
36
43
 
37
44
  - name: Install uv
38
- uses: astral-sh/setup-uv@v4
45
+ uses: astral-sh/setup-uv@v7
39
46
  with:
40
47
  enable-cache: true
41
48
 
@@ -43,22 +50,22 @@ jobs:
43
50
  run: uv python install 3.12
44
51
 
45
52
  - name: Install dependencies
46
- run: uv sync --all-extras
53
+ run: uv sync --group dev
47
54
 
48
- - name: Type check with ty
49
- run: uv run ty check dotenvmodel
55
+ - name: Type check with pyright
56
+ run: uv run pyright dotenvmodel
50
57
 
51
58
  test:
52
59
  runs-on: ubuntu-latest
53
60
  strategy:
54
61
  matrix:
55
- python-version: ["3.12", "3.13"]
62
+ python-version: ["3.12", "3.13", "3.14", "3.15"]
56
63
 
57
64
  steps:
58
- - uses: actions/checkout@v4
65
+ - uses: actions/checkout@v7
59
66
 
60
67
  - name: Install uv
61
- uses: astral-sh/setup-uv@v4
68
+ uses: astral-sh/setup-uv@v7
62
69
  with:
63
70
  enable-cache: true
64
71
 
@@ -66,25 +73,38 @@ jobs:
66
73
  run: uv python install ${{ matrix.python-version }}
67
74
 
68
75
  - name: Install dependencies
69
- run: uv sync --all-extras
76
+ run: uv sync --group dev
70
77
 
71
78
  - name: Run tests
72
79
  run: uv run pytest tests/
73
80
 
74
- - name: Upload coverage
75
- uses: codecov/codecov-action@v3
76
- if: matrix.python-version == '3.12'
81
+ security:
82
+ runs-on: ubuntu-latest
83
+ steps:
84
+ - uses: actions/checkout@v7
85
+
86
+ - name: Install uv
87
+ uses: astral-sh/setup-uv@v7
77
88
  with:
78
- file: ./coverage.xml
89
+ enable-cache: true
90
+
91
+ - name: Set up Python
92
+ run: uv python install 3.12
93
+
94
+ - name: Install dependencies
95
+ run: uv sync --group dev
96
+
97
+ - name: Run pip-audit
98
+ run: uv run pip-audit
79
99
 
80
100
  build:
81
101
  runs-on: ubuntu-latest
82
- needs: [lint, typecheck, test]
102
+ needs: [lint, typecheck, test, security]
83
103
  steps:
84
- - uses: actions/checkout@v4
104
+ - uses: actions/checkout@v7
85
105
 
86
106
  - name: Install uv
87
- uses: astral-sh/setup-uv@v4
107
+ uses: astral-sh/setup-uv@v7
88
108
  with:
89
109
  enable-cache: true
90
110
 
@@ -113,7 +133,7 @@ jobs:
113
133
  cd /tmp && $GITHUB_WORKSPACE/test-src-env/bin/python -c "import dotenvmodel; print(dotenvmodel.__version__)"
114
134
 
115
135
  - name: Upload build artifacts
116
- uses: actions/upload-artifact@v4
136
+ uses: actions/upload-artifact@v7
117
137
  with:
118
138
  name: dist
119
139
  path: dist/
@@ -0,0 +1,56 @@
1
+ name: Deploy Docs
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ paths:
7
+ - "docs/**"
8
+ - "dotenvmodel/**"
9
+ - "mkdocs.yml"
10
+ - ".github/workflows/docs.yml"
11
+ workflow_dispatch:
12
+
13
+ permissions:
14
+ contents: read
15
+ pages: write
16
+ id-token: write
17
+
18
+ concurrency:
19
+ group: "pages"
20
+ cancel-in-progress: false
21
+
22
+ jobs:
23
+ build:
24
+ runs-on: ubuntu-latest
25
+ steps:
26
+ - uses: actions/checkout@v7
27
+
28
+ - name: Install uv
29
+ uses: astral-sh/setup-uv@v7
30
+ with:
31
+ enable-cache: true
32
+
33
+ - name: Set up Python
34
+ run: uv python install 3.12
35
+
36
+ - name: Install dependencies
37
+ run: uv sync --group dev
38
+
39
+ - name: Build MkDocs site
40
+ run: uv run mkdocs build --strict
41
+
42
+ - name: Upload artifact
43
+ uses: actions/upload-pages-artifact@v5
44
+ with:
45
+ path: site
46
+
47
+ deploy:
48
+ needs: build
49
+ runs-on: ubuntu-latest
50
+ environment:
51
+ name: github-pages
52
+ url: ${{ steps.deployment.outputs.page_url }}
53
+ steps:
54
+ - name: Deploy to GitHub Pages
55
+ id: deployment
56
+ uses: actions/deploy-pages@v5
@@ -13,19 +13,20 @@ on:
13
13
  types: [published]
14
14
  workflow_dispatch:
15
15
 
16
+ permissions:
17
+ id-token: write
18
+ contents: read
19
+
16
20
  jobs:
17
21
  publish:
18
22
  runs-on: ubuntu-latest
19
23
  if: inputs.release_created || github.event_name == 'release' || github.event_name == 'workflow_dispatch'
20
- permissions:
21
- id-token: write
22
- contents: read
23
24
 
24
25
  steps:
25
- - uses: actions/checkout@v4
26
+ - uses: actions/checkout@v7
26
27
 
27
28
  - name: Install uv
28
- uses: astral-sh/setup-uv@v4
29
+ uses: astral-sh/setup-uv@v7
29
30
  with:
30
31
  version: "latest"
31
32
 
@@ -42,9 +43,4 @@ jobs:
42
43
  run: uv build
43
44
 
44
45
  - name: Publish to PyPI
45
- env:
46
- TWINE_USERNAME: __token__
47
- TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
48
- run: |
49
- uv tool install twine
50
- uv tool run twine upload dist/*
46
+ run: uv publish
@@ -18,11 +18,13 @@ jobs:
18
18
  release_created: ${{ steps.release.outputs.release_created }}
19
19
  tag_name: ${{ steps.release.outputs.tag_name }}
20
20
  steps:
21
- - uses: googleapis/release-please-action@v4
21
+ - uses: googleapis/release-please-action@v5
22
22
  id: release
23
23
  with:
24
24
  release-type: python
25
25
  package-name: dotenvmodel
26
+ config-file: release-please-config.json
27
+ manifest-file: .release-please-manifest.json
26
28
  token: ${{ secrets.GITHUB_TOKEN }}
27
29
 
28
30
  publish:
@@ -154,6 +154,9 @@ venv.bak/
154
154
  # mkdocs documentation
155
155
  /site
156
156
 
157
+ # Superpowers specs (internal planning docs)
158
+ docs/superpowers/
159
+
157
160
  # mypy
158
161
  .mypy_cache/
159
162
  .dmypy.json
@@ -182,11 +185,13 @@ cython_debug/
182
185
  .abstra/
183
186
 
184
187
  # 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/
188
+ .vscode/
189
+
190
+ # Claude Code
191
+ .claude/
192
+
193
+ # Serena
194
+ .serena/
190
195
 
191
196
  # Ruff stuff:
192
197
  .ruff_cache/
@@ -0,0 +1,3 @@
1
+ {
2
+ ".": "0.3.1"
3
+ }
@@ -5,27 +5,41 @@ All notable changes to this project will be documented in this file.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
- ## [0.2.0](https://github.com/AZX-PBC/dotenvmodel/compare/v0.1.1...v0.2.0) (2025-12-05)
8
+ ## [0.3.1](https://github.com/AZX-PBC-OSS/dotenvmodel/compare/v0.3.0...v0.3.1) (2026-07-13)
9
+
10
+
11
+ ### Bug Fixes
12
+
13
+ * redact credentials in DSN repr, errors, docs, and secret exception chains ([#29](https://github.com/AZX-PBC-OSS/dotenvmodel/issues/29)) ([cfdd218](https://github.com/AZX-PBC-OSS/dotenvmodel/commit/cfdd218ff157d41f7af06c1beaf4c539080fa2dd))
14
+
15
+ ## [0.3.0](https://github.com/AZX-PBC-OSS/dotenvmodel/compare/v0.2.0...v0.3.0) (2026-07-09)
16
+
17
+
18
+ ### Features
19
+
20
+ * release readiness for public open-source release ([#20](https://github.com/AZX-PBC-OSS/dotenvmodel/issues/20)) ([43937d0](https://github.com/AZX-PBC-OSS/dotenvmodel/commit/43937d06faeb5b687b545daefc4166aa17612a18))
21
+
22
+ ## [0.2.0](https://github.com/AZX-PBC-OSS/dotenvmodel/compare/v0.1.1...v0.2.0) (2025-12-05)
9
23
 
10
24
 
11
25
  ### Features
12
26
 
13
- * add describe functionality for configuration classes and related tests ([#6](https://github.com/AZX-PBC/dotenvmodel/issues/6)) ([49767ea](https://github.com/AZX-PBC/dotenvmodel/commit/49767ea34e8216706a0071072cb92452890451f3))
27
+ * add describe functionality for configuration classes and related tests ([#6](https://github.com/AZX-PBC-OSS/dotenvmodel/issues/6)) ([49767ea](https://github.com/AZX-PBC-OSS/dotenvmodel/commit/49767ea34e8216706a0071072cb92452890451f3))
14
28
 
15
- ## [0.1.1](https://github.com/AZX-PBC/dotenvmodel/compare/v0.1.0...v0.1.1) (2025-12-05)
29
+ ## [0.1.1](https://github.com/AZX-PBC-OSS/dotenvmodel/compare/v0.1.0...v0.1.1) (2025-12-05)
16
30
 
17
31
 
18
32
  ### Bug Fixes
19
33
 
20
- * update PyPI publishing workflow configuration ([f854abb](https://github.com/AZX-PBC/dotenvmodel/commit/f854abb08272c51e1a872d4062230f8b2e7d5c21))
21
- * update PyPI publishing workflow configuration ([8c3ed30](https://github.com/AZX-PBC/dotenvmodel/commit/8c3ed301b7aa3fffcffb2343a0f194cce639832a))
34
+ * update PyPI publishing workflow configuration ([f854abb](https://github.com/AZX-PBC-OSS/dotenvmodel/commit/f854abb08272c51e1a872d4062230f8b2e7d5c21))
35
+ * update PyPI publishing workflow configuration ([8c3ed30](https://github.com/AZX-PBC-OSS/dotenvmodel/commit/8c3ed301b7aa3fffcffb2343a0f194cce639832a))
22
36
 
23
37
  ## 0.1.0 (2025-12-05)
24
38
 
25
39
 
26
40
  ### Features
27
41
 
28
- * v0.1.0 - Complete type-safe environment configuration library ([#1](https://github.com/AZX-PBC/dotenvmodel/issues/1)) ([7e9b2a9](https://github.com/AZX-PBC/dotenvmodel/commit/7e9b2a9cf01db778b0855df40745eac1d2134de5))
42
+ * v0.1.0 - Complete type-safe environment configuration library ([#1](https://github.com/AZX-PBC-OSS/dotenvmodel/issues/1)) ([7e9b2a9](https://github.com/AZX-PBC-OSS/dotenvmodel/commit/7e9b2a9cf01db778b0855df40745eac1d2134de5))
29
43
 
30
44
  ## [0.1.0] - 2025-12-05
31
45
 
@@ -103,4 +117,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
103
117
 
104
118
  - No known security issues
105
119
 
106
- [0.1.0]: https://github.com/azxio/dotenvmodel/releases/tag/v0.1.0
120
+ [0.1.0]: https://github.com/AZX-PBC-OSS/dotenvmodel/releases/tag/v0.1.0
@@ -0,0 +1,127 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, caste, color, religion, or sexual
10
+ identity and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ * Demonstrating empathy and kindness toward other people
21
+ * Being respectful of differing opinions, viewpoints, and experiences
22
+ * Giving and gracefully accepting constructive feedback
23
+ * Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ * Focusing on what is best not just for us as individuals, but for the overall
26
+ community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ * The use of sexualized language or imagery, and sexual attention or advances
31
+ of any kind
32
+ * Trolling, insulting or derogatory comments, and personal or political attacks
33
+ * Public or private harassment
34
+ * Publishing others' private information, such as a physical or email address,
35
+ without their explicit permission
36
+ * Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official e-mail address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at
63
+ **conduct@azx.io**.
64
+ All complaints will be reviewed and investigated promptly and fairly.
65
+
66
+ All community leaders are obligated to respect the privacy and security of the
67
+ reporter of any incident.
68
+
69
+ ## Enforcement Guidelines
70
+
71
+ Community leaders will follow these Community Impact Guidelines in determining
72
+ the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ ### 1. Correction
75
+
76
+ **Community Impact:** Use of inappropriate language or other behavior deemed
77
+ unprofessional or unwelcome in the community.
78
+
79
+ **Consequence:** A private, written warning from community leaders, providing
80
+ clarity around the nature of the violation and an explanation of why the
81
+ behavior was inappropriate. A public apology may be requested.
82
+
83
+ ### 2. Warning
84
+
85
+ **Community Impact:** A violation through a single incident or series of
86
+ actions.
87
+
88
+ **Consequence:** A warning with consequences for continued behavior. No
89
+ interaction with the people involved, including unsolicited interaction with
90
+ those enforcing the Code of Conduct, for a specified period of time. This
91
+ includes avoiding interactions in community spaces as well as external channels
92
+ like social media. Violating these terms may lead to a temporary or permanent
93
+ ban.
94
+
95
+ ### 3. Temporary Ban
96
+
97
+ **Community Impact:** A serious violation of community standards, including
98
+ sustained inappropriate behavior.
99
+
100
+ **Consequence:** A temporary ban from any sort of interaction or public
101
+ communication with the community for a specified period of time. No public or
102
+ private interaction with the people involved, including unsolicited interaction
103
+ with those enforcing the Code of Conduct, is allowed during this period.
104
+ Violating these terms may lead to a permanent ban.
105
+
106
+ ### 4. Permanent Ban
107
+
108
+ **Community Impact:** Demonstrating a pattern of violation of community
109
+ standards, including sustained inappropriate behavior, harassment of an
110
+ individual, or aggression toward or disparagement of classes of individuals.
111
+
112
+ **Consequence:** A permanent ban from any sort of public interaction within the
113
+ community.
114
+
115
+ ## Attribution
116
+
117
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+ version 2.1, available at
119
+ [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
120
+
121
+ Community Impact Guidelines were inspired by
122
+ [Mozilla's code of conduct enforcement ladder](https://www.mozilla.org/en-US/about/governance/policies/participation/).
123
+
124
+ [homepage]: https://www.contributor-covenant.org
125
+
126
+ For answers to common questions about this code of conduct, see
127
+ [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq).
@@ -13,7 +13,7 @@ Thank you for your interest in contributing to dotenvmodel! We appreciate your t
13
13
 
14
14
  1. **Clone the repository:**
15
15
  ```bash
16
- git clone https://github.com/azxio/dotenvmodel.git
16
+ git clone https://github.com/AZX-PBC-OSS/dotenvmodel.git
17
17
  cd dotenvmodel
18
18
  ```
19
19
 
@@ -24,7 +24,7 @@ Thank you for your interest in contributing to dotenvmodel! We appreciate your t
24
24
  uv sync --dev
25
25
  ```
26
26
 
27
- This will create a virtual environment and install all necessary dependencies including pytest, mypy, ruff, and other development tools.
27
+ This will create a virtual environment and install all necessary dependencies including pytest, pyright, ruff, and other development tools.
28
28
 
29
29
  ## Running Tests
30
30
 
@@ -76,14 +76,14 @@ The project is configured with the following pytest settings (in `pyproject.toml
76
76
 
77
77
  ### Type Checking
78
78
 
79
- The project uses `ty` (a wrapper around pyright) for type checking:
79
+ The project uses `pyright` for type checking:
80
80
 
81
81
  ```bash
82
82
  # Run type checking
83
- uv run ty check
83
+ uv run pyright dotenvmodel
84
84
 
85
85
  # Type check specific file
86
- uv run ty check dotenvmodel/core.py
86
+ uv run pyright dotenvmodel/core.py
87
87
  ```
88
88
 
89
89
  ### Linting and Formatting
@@ -113,7 +113,7 @@ Before submitting a PR, run all quality checks:
113
113
  uv run pytest
114
114
 
115
115
  # Run type checking
116
- uv run ty check
116
+ uv run pyright dotenvmodel
117
117
 
118
118
  # Run linting
119
119
  uv run ruff check dotenvmodel
@@ -160,7 +160,7 @@ uv run ruff format --check dotenvmodel
160
160
  uv run pytest
161
161
 
162
162
  # Check types
163
- uv run ty check
163
+ uv run pyright dotenvmodel
164
164
 
165
165
  # Check linting
166
166
  uv run ruff check dotenvmodel
@@ -180,7 +180,7 @@ uv run ruff format --check dotenvmodel
180
180
 
181
181
  2. **Ensure type checking passes:**
182
182
  ```bash
183
- uv run ty check
183
+ uv run pyright dotenvmodel
184
184
  ```
185
185
 
186
186
  3. **Ensure code is properly formatted:**
@@ -368,9 +368,9 @@ raise ValueError("Invalid format")
368
368
 
369
369
  ## Getting Help
370
370
 
371
- - **Questions?** Open a [GitHub Discussion](https://github.com/azxio/dotenvmodel/discussions)
372
- - **Bug Reports?** Open an [Issue](https://github.com/azxio/dotenvmodel/issues)
373
- - **Feature Requests?** Open an [Issue](https://github.com/azxio/dotenvmodel/issues) with the `enhancement` label
371
+ - **Questions?** Open a [GitHub Discussion](https://github.com/AZX-PBC-OSS/dotenvmodel/discussions)
372
+ - **Bug Reports?** Open an [Issue](https://github.com/AZX-PBC-OSS/dotenvmodel/issues)
373
+ - **Feature Requests?** Open an [Issue](https://github.com/AZX-PBC-OSS/dotenvmodel/issues) with the `enhancement` label
374
374
 
375
375
  ## License
376
376
 
@@ -6,7 +6,7 @@ help:
6
6
  @echo " make test - Run tests with coverage"
7
7
  @echo " make lint - Run ruff linter"
8
8
  @echo " make format - Format code with ruff"
9
- @echo " make type-check - Run mypy type checker"
9
+ @echo " make type-check - Run pyright type checker"
10
10
  @echo " make clean - Clean build artifacts"
11
11
  @echo " make build - Build package"
12
12
  @echo " make publish - Publish to PyPI"
@@ -25,7 +25,7 @@ format:
25
25
  uv run ruff check --fix .
26
26
 
27
27
  type-check:
28
- uv run ty check dotenvmodel
28
+ uv run pyright dotenvmodel
29
29
 
30
30
  clean:
31
31
  rm -rf build/