Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes
- Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior:

- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported via [GitHub Issues](https://github.com/karamouche/noisekit/issues). All complaints will be reviewed and investigated promptly and fairly.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.
9 changes: 9 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Security Policy

## Reporting a Vulnerability

Please **do not** open a public GitHub issue for security vulnerabilities.

Instead, report them privately via [GitHub Security Advisories](https://github.com/karamouche/noisekit/security/advisories/new).

Include a description of the issue, steps to reproduce, and potential impact.
63 changes: 44 additions & 19 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,36 +7,61 @@ name = "noisekit"
version = "0.1.0"
description = "Generate degraded speech datasets for noise-robust ASR benchmarking"
readme = "README.md"
license = {text = "MIT"}
license = { text = "MIT" }
requires-python = ">=3.10"
authors = [{ name = "Hugo Imbert" }]
keywords = [
"speech",
"audio",
"asr",
"dataset",
"noise",
"degradation",
"benchmark",
]
classifiers = [
"Development Status :: 4 - Beta",
"Intended Audience :: Science/Research",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
"Topic :: Multimedia :: Sound/Audio :: Speech",
]
dependencies = [
"audiomentations>=0.38",
"pesq>=0.0.4",
"datasets>=2.20",
"huggingface_hub>=0.24",
"typer>=0.12",
"rich>=13.7",
"soundfile>=0.12",
"numpy>=1.26",
"scipy>=1.13",
"pyroomacoustics>=0.7",
"pyyaml>=6.0",
"librosa>=0.10",
"lameenc>=1.4",
"torch>=2.12.0",
"torchmetrics>=1.7.0",
"audiomentations>=0.38",
"pesq>=0.0.4",
"datasets>=2.20",
"huggingface_hub>=0.24",
"typer>=0.12",
"rich>=13.7",
"soundfile>=0.12",
"numpy>=1.26",
"scipy>=1.13",
"pyroomacoustics>=0.7",
"pyyaml>=6.0",
"librosa>=0.10",
"lameenc>=1.4",
"torch>=2.12.0",
"torchmetrics>=1.7.0",
]

[project.urls]
Homepage = "https://github.com/karamouche/noisekit"
Repository = "https://github.com/karamouche/noisekit"
"Bug Tracker" = "https://github.com/karamouche/noisekit/issues"

[project.scripts]
noisekit = "noisekit.cli:app"

[tool.hatch.build.targets.wheel]
packages = ["noisekit"]

[dependency-groups]
dev = [
"pytest>=8.0",
]
dev = ["pytest>=8.0"]

[tool.ruff]
target-version = "py310"
Expand Down