Skip to content

Commit e50b3d3

Browse files
committed
Version 1.5.0 - See changelog for updates.
1 parent dc32c5a commit e50b3d3

File tree

12 files changed

+471
-31
lines changed

12 files changed

+471
-31
lines changed
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: Bug Report
2+
description: Report a bug in bac-py
3+
labels: ["bug"]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
description: A clear description of the bug.
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
id: reproduce
15+
attributes:
16+
label: Steps to Reproduce
17+
description: Minimal code or steps to reproduce the issue.
18+
render: python
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: expected
24+
attributes:
25+
label: Expected Behavior
26+
description: What you expected to happen.
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: actual
32+
attributes:
33+
label: Actual Behavior
34+
description: What actually happened. Include tracebacks if applicable.
35+
validations:
36+
required: true
37+
38+
- type: input
39+
id: version
40+
attributes:
41+
label: bac-py Version
42+
description: "Output of: python -c \"import bac_py; print(bac_py.__version__)\""
43+
placeholder: "1.4.9"
44+
validations:
45+
required: true
46+
47+
- type: input
48+
id: python-version
49+
attributes:
50+
label: Python Version
51+
description: "Output of: python --version"
52+
placeholder: "3.13.0"
53+
validations:
54+
required: true
55+
56+
- type: input
57+
id: os
58+
attributes:
59+
label: Operating System
60+
placeholder: "macOS 15, Ubuntu 24.04, Windows 11, etc."
61+
validations:
62+
required: false
63+
64+
- type: textarea
65+
id: context
66+
attributes:
67+
label: Additional Context
68+
description: Any other relevant information (transport type, network setup, etc.).
69+
validations:
70+
required: false
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement
3+
labels: ["enhancement"]
4+
body:
5+
- type: textarea
6+
id: problem
7+
attributes:
8+
label: Problem or Use Case
9+
description: What problem does this solve, or what use case does it enable?
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
id: solution
15+
attributes:
16+
label: Proposed Solution
17+
description: How you envision this working. Include API sketches if applicable.
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: alternatives
23+
attributes:
24+
label: Alternatives Considered
25+
description: Any alternative approaches you've considered.
26+
validations:
27+
required: false
28+
29+
- type: textarea
30+
id: context
31+
attributes:
32+
label: Additional Context
33+
description: Any other relevant information, links, or references (e.g., BACnet spec clauses).
34+
validations:
35+
required: false

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## Summary
2+
3+
<!-- Brief description of what this PR does and why. -->
4+
5+
## Changes
6+
7+
<!-- Bullet list of changes. -->
8+
9+
-
10+
11+
## Test Plan
12+
13+
<!-- How was this tested? -->
14+
15+
- [ ] `make check` passes (lint + typecheck + test + docs)
16+
- [ ] Tests added/updated for new functionality
17+
- [ ] Documentation updated (if applicable)
18+
- [ ] `CHANGELOG.md` updated

.github/workflows/release.yml

Lines changed: 62 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ jobs:
1616
runs-on: ubuntu-latest
1717
permissions:
1818
contents: write
19-
id-token: write
19+
outputs:
20+
new_release: ${{ steps.check_tag.outputs.exists == 'false' }}
2021
steps:
2122
- uses: actions/checkout@v4
2223
with:
@@ -76,29 +77,63 @@ jobs:
7677
draft: false
7778
prerelease: false
7879

79-
# ──────────────────────────────────────────────────────────
80-
# PyPI Publish (disabled until repo is public)
81-
#
82-
# Prerequisites before enabling:
83-
# 1. Create a PyPI project at https://pypi.org/manage/projects/
84-
# 2. Add GitHub as a trusted publisher:
85-
# PyPI → Project → Settings → Publishing → Add Publisher
86-
# - Owner: jscott3201
87-
# - Repository: bac-py
88-
# - Workflow: release.yml
89-
# - Environment: (leave blank)
90-
# 3. Uncomment the step below
91-
# 4. Ensure `hatchling` build-backend is configured in pyproject.toml (already done)
92-
#
93-
# - name: Build package
94-
# if: steps.check_tag.outputs.exists == 'false'
95-
# run: |
96-
# pip install build
97-
# python -m build
98-
#
99-
# - name: Publish to PyPI
100-
# if: steps.check_tag.outputs.exists == 'false'
101-
# uses: pypa/gh-action-pypi-publish@release/v1
102-
# with:
103-
# print-hash: true
104-
# ──────────────────────────────────────────────────────────
80+
build:
81+
needs: release
82+
if: needs.release.outputs.new_release == 'true'
83+
runs-on: ubuntu-latest
84+
steps:
85+
- uses: actions/checkout@v4
86+
with:
87+
ref: ${{ github.event.workflow_run.head_sha }}
88+
89+
- uses: actions/setup-python@v5
90+
with:
91+
python-version: "3.13"
92+
93+
- name: Build package
94+
run: |
95+
pip install build
96+
python -m build
97+
98+
- name: Upload distributions
99+
uses: actions/upload-artifact@v4
100+
with:
101+
name: python-package-distributions
102+
path: dist/
103+
104+
# ──────────────────────────────────────────────────────────
105+
# PyPI Publish
106+
#
107+
# Prerequisites (one-time setup):
108+
# 1. Go to https://pypi.org/manage/account/publishing/
109+
# 2. Add a pending publisher:
110+
# - Package name: bac-py
111+
# - Owner: jscott3201
112+
# - Repository: bac-py
113+
# - Workflow: release.yml
114+
# - Environment: pypi
115+
# 3. In GitHub repo Settings → Environments, create a "pypi"
116+
# environment. Optionally enable required reviewers for
117+
# manual approval before each publish.
118+
# ──────────────────────────────────────────────────────────
119+
120+
publish:
121+
needs: build
122+
runs-on: ubuntu-latest
123+
environment:
124+
name: pypi
125+
url: https://pypi.org/p/bac-py
126+
permissions:
127+
id-token: write
128+
attestations: write
129+
steps:
130+
- name: Download distributions
131+
uses: actions/download-artifact@v4
132+
with:
133+
name: python-package-distributions
134+
path: dist/
135+
136+
- name: Publish to PyPI
137+
uses: pypa/gh-action-pypi-publish@release/v1
138+
with:
139+
print-hash: true

CHANGELOG.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,41 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
## [1.5.0] - 2026-02-15
11+
12+
### Added
13+
14+
- **CONTRIBUTING.md**: Contributing guidelines covering development setup, code
15+
standards, quality gates, and pull request process.
16+
- **SECURITY.md**: Security policy with vulnerability reporting instructions,
17+
supported versions, and security considerations for BACnet deployments.
18+
- **CODE_OF_CONDUCT.md**: Contributor Covenant 3.0 Code of Conduct.
19+
- **GitHub issue templates**: Structured bug report and feature request forms
20+
(`.github/ISSUE_TEMPLATE/bug_report.yml`, `feature_request.yml`).
21+
- **GitHub PR template**: Pull request template with quality gate checklist
22+
(`.github/PULL_REQUEST_TEMPLATE.md`).
23+
- **README badges**: Added PyPI version, Python version, license, and CI status
24+
badges. Added Contributing section linking to CONTRIBUTING.md and SECURITY.md.
25+
- **Changelog project URL**: Added `Changelog` link to `[project.urls]` in
26+
`pyproject.toml` for display on PyPI.
27+
28+
### Changed
29+
30+
- **Release workflow**: Restructured `.github/workflows/release.yml` into three
31+
separate jobs (release, build, publish) per the official Python packaging guide.
32+
The publish job uses a dedicated `pypi` GitHub Environment with `id-token: write`
33+
and `attestations: write` permissions for trusted publishing with PEP 740
34+
attestations. Build artifacts pass between jobs via `actions/upload-artifact`.
35+
- **sdist exclusions**: Configured `[tool.hatch.build.targets.sdist]` to exclude
36+
`docker/`, `scripts/`, `docs/`, `.github/`, `Makefile`, `ruff.toml`, `uv.lock`,
37+
and `.python-version` from source distributions. Reduces sdist from 397 to 314
38+
files. Wheel contents unchanged (only `bac_py/` package).
39+
40+
### Fixed
41+
42+
- **README test count**: Reconciled inconsistent test counts ("6,380+" vs
43+
"6,300+") in the Testing section.
44+
1045
## [1.4.9] - 2026-02-14
1146

1247
### Added

CODE_OF_CONDUCT.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
2+
# Contributor Covenant 3.0 Code of Conduct
3+
4+
## Our Pledge
5+
6+
We pledge to make our community welcoming, safe, and equitable for all.
7+
8+
We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
9+
10+
## Encouraged Behaviors
11+
12+
While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
13+
14+
With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
15+
16+
1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
17+
2. Engaging **kindly and honestly** with others.
18+
3. Respecting **different viewpoints** and experiences.
19+
4. **Taking responsibility** for our actions and contributions.
20+
5. Gracefully giving and accepting **constructive feedback**.
21+
6. Committing to **repairing harm** when it occurs.
22+
7. Behaving in other ways that promote and sustain the **well-being of our community**.
23+
24+
25+
## Restricted Behaviors
26+
27+
We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
28+
29+
1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
30+
2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
31+
3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
32+
4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
33+
5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
34+
6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
35+
7. Behaving in other ways that **threaten the well-being** of our community.
36+
37+
### Other Restrictions
38+
39+
1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
40+
2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
41+
3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
42+
4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
43+
44+
45+
## Reporting an Issue
46+
47+
Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
48+
49+
When an incident does occur, it is important to report it promptly. To report a possible violation, email **jscott3201@gmail.com**.
50+
51+
Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
52+
53+
54+
## Addressing and Repairing Harm
55+
56+
If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
57+
58+
1) Warning
59+
1) Event: A violation involving a single incident or series of incidents.
60+
2) Consequence: A private, written warning from the Community Moderators.
61+
3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
62+
2) Temporarily Limited Activities
63+
1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
64+
2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
65+
3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
66+
3) Temporary Suspension
67+
1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
68+
2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
69+
3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
70+
4) Permanent Ban
71+
1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
72+
2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
73+
3) Repair: There is no possible repair in cases of this severity.
74+
75+
This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
76+
77+
78+
## Scope
79+
80+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
81+
82+
83+
## Attribution
84+
85+
This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
86+
87+
Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)
88+
89+
For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion).
90+

0 commit comments

Comments
 (0)