Skip to content

Commit 387d457

Browse files
committed
Add an Agents.md and ignore the old venv
1 parent 98c8fa6 commit 387d457

File tree

3 files changed

+72
-0
lines changed

3 files changed

+72
-0
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,6 @@ coverage.xml
1212
/.eggs/
1313
.vscode
1414
/.venv/
15+
16+
# Ignore old venv location
17+
/env/

Agents.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
2+
# HL7 library for Python
3+
4+
## Project Overview
5+
6+
This is a standalone library for parsing HL7 v2.x messages, supporting the maintained versions of Python.
7+
8+
## Tech Stack
9+
10+
- **Testing**: Python unittest
11+
- **Package Manager**: uv
12+
13+
14+
## Project Structure
15+
16+
```
17+
hl7/
18+
tests/
19+
docs/
20+
```
21+
22+
## Development Guidelines
23+
24+
### Key Principles
25+
26+
## Environment Setup
27+
28+
### Installation Steps
29+
30+
```bash
31+
# Run uv sync
32+
make init
33+
```
34+
35+
## Security Considerations
36+
37+
- Avoid introducing security issues.
38+
39+
## Testing Strategy
40+
41+
We aim for a high level of test coverage, primarily through unit tests.
42+
43+
- Occasionally we will use unittest.mock for things that may be otherwise hard to. When patching, prefer to use `autospec=True`
44+
- Whenever you fix a bug, try to add a test case that documents the broken behavior is no longer happening.
45+
- Additionally, we run our sphinx documentation through doctest, not to increase coverage, but to ensure the documentation accurately matches.
46+
47+
To run the test suite (will run tox for all supported Python versions as well as the doctests):
48+
49+
```bash
50+
make tests
51+
```
52+
53+
## Programmatic Checks for OpenAI Codex
54+
55+
To run ruff linting:
56+
57+
```bash
58+
make lint
59+
```
60+
61+
## Reference Resources
62+
63+
- [HL7 Definitions](https://hl7-definition.caristix.com/v2/)
64+
65+
## Changelog
66+
67+

Makefile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ clean: clean-docs
4141
rm -rf *.egg-info .mypy_cache coverage.xml .venv
4242
find . -name "*.pyc" -type f -delete
4343
find . -type d -empty -delete
44+
# Legacy venv (remove eventually)
45+
rm -rf env
4446
.PHONY: clean-python
4547

4648

0 commit comments

Comments
 (0)