CONTRIBUTING.md

Contributing

Disclaimer

This is a community-developed, unofficial implementation and is not provided, supported, or endorsed by FileHold Systems ULC or Keymark.

Development

• uv sync: Create virtual environment and install dependencies.
• uv run webdav-server-for-filehold: Run the server.
• uv build: Build the package.
• uv sync --upgrade: Upgrade dependencies.

Testing

Unit Tests

To run the unit tests, use the following command:

uv run pytest tests/unit

End-to-End (E2E) Tests

E2E tests require a running instance of FileHold and a valid user account.

$env:FILEHOLD_PASSWORD="your_password"
uv run pytest tests/e2e

Environment Variables:

• FILEHOLD_URL: URL to the FileHold instance (default: http://localhost/FH/FileHold/).
• FILEHOLD_USERNAME: Username (default: sysadm).
• FILEHOLD_PASSWORD: Password (REQUIRED).

Coverage

To run tests with coverage reporting:

uv run pytest --cov=webdav_server_for_filehold --cov-report=term-missing

Code Style

This project uses ruff for code style.

uv run ruff check .
uv run ruff format --check .

To automatically fix standard style issues:

uv run ruff format .
uv run ruff check --fix .