https://github.com/gmierz/mozdetect
A python package containing change point detection techniques for use at Mozilla.
https://github.com/gmierz/mozdetect
Last synced: about 2 months ago
JSON representation
A python package containing change point detection techniques for use at Mozilla.
- Host: GitHub
- URL: https://github.com/gmierz/mozdetect
- Owner: gmierz
- License: mpl-2.0
- Created: 2024-09-18T21:00:43.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-11-20T01:51:20.000Z (6 months ago)
- Last Synced: 2025-02-12T16:50:28.910Z (4 months ago)
- Language: Python
- Size: 464 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mozdetect
A python package containing change point detection techniques for use at Mozilla.
# Setup, and Development
## Setup
Install `uv` first using the following:
```
python -m pip install uv
```
Install `poetry` using the following:
```
python -m pip install poetry
```
## Running
Next, run the following to build the package, and install dependencies. This step can be skipped though since `uv run` will implicitly build the package:
```
uv sync
```
Run a script that uses the built module with the following:
```
uv run my_script.py
```
## Pre-commit checks
Pre-commit linting checks must be setup like this (run within the top-level of this repo directory):
```
uv sync
uv run pre-commit install
```
## Running tests
Tests all reside in the `tests/` folder and can be run using:
```
uv run pytest
```