Skip to content

Commit ec1b45e

Browse files
committed
Merge remote-tracking branch 'origin/master'
# Conflicts: # .gitignore # pyproject.toml # setup.py
2 parents b49813a + 71cfc5b commit ec1b45e

File tree

113 files changed

+14401
-224
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

113 files changed

+14401
-224
lines changed

.gitignore

Lines changed: 15 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,29 @@
1-
# API Keys and Secrets
21
token
3-
*.env
4-
.env
5-
.env.local
6-
.env.*.local
72

8-
# Python
9-
*.pyc
3+
# Python Artifacts
104
__pycache__/
115
*.py[cod]
126
*$py.class
13-
*.so
14-
.Python
157

16-
# Virtual Environments
17-
venv/
18-
.venv/
19-
env/
20-
ENV/
21-
env.bak/
22-
venv.bak/
23-
24-
# Testing
25-
htmlcov/
26-
.coverage
27-
.coverage.*
28-
.pytest_cache/
29-
.tox/
30-
.nox/
31-
coverage.xml
32-
*.cover
33-
.hypothesis/
34-
35-
# Test Audio Files (large files)
36-
tests/fixtures/audio/*.wav
37-
tests/fixtures/audio/*.mp3
38-
tests/fixtures/audio/*.flac
39-
tests/fixtures/audio/*.m4a
40-
41-
# Build and Distribution
42-
dist/
8+
# Build Artifacts
439
build/
10+
dist/
4411
*.egg-info/
45-
.eggs/
46-
wheels/
47-
*.whl
4812

49-
# Documentation Build
50-
_build/
51-
docs/_build/
52-
docs/_static/
53-
docs/_templates/
13+
# Virtual Environment
14+
.venv/
15+
venv/
16+
env/
5417

55-
# IDE and Editors
56-
.vscode/
57-
.idea/
58-
*.swp
59-
*.swo
60-
*~
61-
.DS_Store
18+
# Sphinx documentation build output
19+
_build/
6220

63-
# Project Specific Output
64-
single_masters/
65-
mixed_tracks/
66-
enhanced_tracks/
67-
cleaned_audio/
21+
# Example output directories
6822
analysis_results/
69-
album_masters/
70-
final_masters/
71-
72-
# Logs
73-
*.log
74-
75-
# mypy
76-
.mypy_cache/
77-
.dmypy.json
78-
dmypy.json
79-
80-
# Jupyter Notebook
81-
.ipynb_checkpoints
23+
cleaned_audio/
24+
enhanced_tracks/
25+
mixed_tracks/
26+
single_masters/
8227

83-
# Test scripts with API keys
28+
# Other untracked files
8429
test.sh

CONTRIBUTING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contributing to roex-python
2+
3+
First off, thank you for considering contributing to the `roex-python` package! Your help is appreciated. Following these guidelines helps maintainers and the community understand your suggestions and contributions.
4+
5+
## How Can I Contribute?
6+
7+
### Reporting Bugs
8+
9+
If you find a bug, please ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/roex-audio/roex-python/issues).
10+
11+
If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/roex-audio/roex-python/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
12+
13+
### Suggesting Enhancements
14+
15+
Suggestions for enhancements are tracked as GitHub issues.
16+
17+
Before creating enhancement suggestions, please check the [issues list](https://github.com/roex-audio/roex-python/issues) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible, including the steps that you imagine you would take if the feature you're requesting existed.
18+
19+
### Pull Requests
20+
21+
If you have code changes you'd like to contribute:
22+
23+
1. Fork the repository.
24+
2. Create a new branch (`git checkout -b feature/your-feature-name`).
25+
3. Make your changes.
26+
4. Ensure your code adheres to the project's style guidelines (e.g., using a linter like Flake8 or Black if applicable).
27+
5. Add tests for your changes if applicable.
28+
6. Commit your changes (`git commit -m 'Add some feature'`).
29+
7. Push to the branch (`git push origin feature/your-feature-name`).
30+
8. Open a [Pull Request](https://github.com/roex-audio/roex-python/pulls) with a clear title and description of your changes.
31+
32+
## Styleguides
33+
34+
Try to follow standard Python conventions (PEP 8) and maintain consistency with the existing codebase style.
35+
36+
## Questions?
37+
38+
If you have questions about contributing, feel free to open an issue and tag it as a 'question'.

Makefile

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = docs
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@echo "Building $@..."
21+
@$(SPHINXBUILD) -b $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
22+
23+
# Special handling for 'html' target to avoid subdirectory
24+
.PHONY: html
25+
html: Makefile
26+
@echo "Building html directly into $(BUILDDIR)..."
27+
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
28+
29+
.PHONY: clean
30+
clean:
31+
@echo "Cleaning $(BUILDDIR)..."
32+
@rm -rf "$(BUILDDIR)"/*

0 commit comments

Comments
 (0)