Compare commits

...

18 Commits

Author SHA1 Message Date
Jamie Hardt 742c0b91fb Update CONTRIBUTING.md
Updated agents policy
2026-05-03 12:18:23 -07:00
Jamie Hardt 8e56a1aeb2 Update python-package.yml 2026-04-03 10:41:38 -07:00
Jamie Hardt 6bc3636814 Update .readthedocs.yaml
Updating RTD build to `ubuntu-lts-latest`
2026-03-30 11:57:04 -07:00
Jamie Hardt e12ae4519e Update contribution guidelines regarding ML systems 2026-02-15 15:48:07 -08:00
Jamie Hardt 8926274c50 Update CONTRIBUTING.md
No LLM/ML contributions
2026-02-14 06:30:13 -08:00
jamie 95ba34187a Docs 2025-10-09 23:22:26 -07:00
jamie 4d2dfcd370 Docs 2025-10-09 23:21:43 -07:00
jamie 717b6a4117 Docs 2025-10-09 23:19:05 -07:00
jamie 7393afac95 Docs 2025-10-09 23:17:46 -07:00
jamie e9450cd65a Docs 2025-10-09 23:16:11 -07:00
jamie 51b1a2e8b4 Docs 2025-10-09 23:15:19 -07:00
jamie 53303232b4 Docs 2025-10-09 23:11:00 -07:00
jamie 3519a0251f Docs 2025-10-09 23:09:51 -07:00
jamie 79ec1649c4 Docs 2025-10-09 23:09:04 -07:00
jamie 7c3f4c9b5e Docs 2025-10-09 23:08:32 -07:00
jamie 2e8224cb3c Docs fix 2025-10-09 23:07:39 -07:00
jamie 8ef4186b4c Merge branch 'master' of https://github.com/iluvcapra/wavinfo 2025-10-09 23:02:32 -07:00
jamie cd5346c1cb Docs fixups 2025-10-09 23:02:15 -07:00
4 changed files with 49 additions and 20 deletions
+3 -3
View File
@@ -19,9 +19,9 @@ jobs:
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"] python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
steps: steps:
- uses: actions/checkout@v2.5.0 - uses: actions/checkout@v6.0.2
- name: Set up Python ${{ matrix.python-version }} - name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4.3.0 uses: actions/setup-python@v6.2.0
with: with:
python-version: ${{ matrix.python-version }} python-version: ${{ matrix.python-version }}
- name: Install dependencies - name: Install dependencies
@@ -30,7 +30,7 @@ jobs:
python -m pip install --group dev python -m pip install --group dev
python -m pip install . python -m pip install .
- name: Setup FFmpeg - name: Setup FFmpeg
uses: FedericoCarboni/setup-ffmpeg@v2 uses: federicocarboni/setup-ffmpeg@v3.1
- name: Test with pytest - name: Test with pytest
run: | run: |
pytest pytest
+6 -8
View File
@@ -7,13 +7,13 @@ version: 2
# Set the version of Python and other tools you might need # Set the version of Python and other tools you might need
build: build:
os: ubuntu-20.04 os: ubuntu-lts-latest
tools: tools:
python: "3.10" python: "3.13"
# You can also specify other tool versions: jobs:
# nodejs: "16" install:
# rust: "1.55" - pip install --upgrade pip
# golang: "1.17" - pip install --group 'doc'
# Build documentation in the docs/ directory with Sphinx # Build documentation in the docs/ directory with Sphinx
sphinx: sphinx:
@@ -28,5 +28,3 @@ python:
install: install:
- method: pip - method: pip
path: . path: .
extra_requirements:
- doc
+33 -1
View File
@@ -12,4 +12,36 @@ If you discover a bug or would like better support for a feature, please do the
If you're facile with Python and understand what you'd like to fix, submit a PR and I'll If you're facile with Python and understand what you'd like to fix, submit a PR and I'll
review it as soon as I can. There's a `.devcontainer` available so you can creates commits review it as soon as I can. There's a `.devcontainer` available so you can creates commits
on this project in a GitHub codespace. on this project in a GitHub codespace.
## Regarding use of Agents
`wavinfo` is an open-source project that is offered free for no commerical gain, and
is developed and maintained for educational and creative reasons.
If you use an agent or LLM to produce code for it you are missing out on the benefits
of contributing to an open-source project, particularly community, collaboration with
other developers and designers, and being able to learn and experiment without the
burden of deadlines or worrying about business cases or profits.
This project is supposed to be fun, do not let machines have fun for you.
We can't prevent you from using LLMs to contribute to this project but we ask you
abide by the following eitiquette when doing so:
* All communication with the maintainers must be written by a human in their own
voice. Never use an LLM to craft thread comments, discussion posts, issues, emails
or other correspondence with other developers or the maintainers.
* PRs must be submitted by a person. Do not allow an agent to submit its own PRs to
this project.
* Especially if you are a new contributor to this project, please submit only one PR
at a time and please restrict the subject matter of the PR to a specific unit,
module or tool. All submissions have to be reviewed and understood by the
maintainers before they can be merged.
Obviously we can't verify if you follow all of these rules but certain telltale
traits of LLM-predicted text or code will raise a flag: lack of brevity in
descriptions or code comments, large amounts of text describing your process or
steps that add little to understanding the changes you've made, use of an
obsequious tone or being excessively accomodating, immediately doing requests
without further discussion or clarifications.
+7 -8
View File
@@ -12,25 +12,24 @@
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here. # documentation root, use os.path.abspath to make it absolute, like shown here.
# #
import importlib # import importlib
import os import os
import sys import sys
sys.path.insert(0, os.path.abspath('../..')) sys.path.insert(0, os.path.abspath('../../src'))
sys.path.insert(0, os.path.abspath("../../..")) sys.path.insert(0, os.path.abspath("../../../src"))
print(sys.path) print(sys.path)
import importlib
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = u'wavinfo' project = u'wavinfo'
copyright = u'2018-2024, Jamie Hardt' copyright = u'2018-2025, Jamie Hardt'
author = u'Jamie Hardt' author = u'Jamie Hardt'
# The short X.Y version # The short X.Y version
version = "3.1" version = "4.0"
# The full version, including alpha/beta/rc tags # The full version, including alpha/beta/rc tags
release = importlib.metadata.version("wavinfo") release = "4.0.0"
# release = importlib.metadata.version("wavinfo")
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------