wyolo 1.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- wyolo-1.0.0/.github/workflows/pylint.yml +40 -0
- wyolo-1.0.0/.github/workflows/python-package.yml +49 -0
- wyolo-1.0.0/.gitignore +171 -0
- wyolo-1.0.0/.pre-commit-config.yaml +24 -0
- wyolo-1.0.0/CHANGELOG.md +16 -0
- wyolo-1.0.0/CITATION.cff +9 -0
- wyolo-1.0.0/CODE_OF_CONDUCT.md +45 -0
- wyolo-1.0.0/CONTRIBUTING.md +49 -0
- wyolo-1.0.0/LICENSE +21 -0
- wyolo-1.0.0/MANIFEST.in +2 -0
- wyolo-1.0.0/Makefile +21 -0
- wyolo-1.0.0/PKG-INFO +264 -0
- wyolo-1.0.0/README.md +185 -0
- wyolo-1.0.0/README_template.md +27 -0
- wyolo-1.0.0/__init__.py +0 -0
- wyolo-1.0.0/docs/api.md +11 -0
- wyolo-1.0.0/docs/index.md +1 -0
- wyolo-1.0.0/docs/installation.md +26 -0
- wyolo-1.0.0/docs/mlops.md +19 -0
- wyolo-1.0.0/docs/quickstart.md +35 -0
- wyolo-1.0.0/docs/source/api.md +29 -0
- wyolo-1.0.0/docs/source/conf.py +45 -0
- wyolo-1.0.0/docs/source/faq.md +7 -0
- wyolo-1.0.0/docs/source/getting_started.md +27 -0
- wyolo-1.0.0/docs/source/index.md +23 -0
- wyolo-1.0.0/docs/source/mlops.md +3 -0
- wyolo-1.0.0/examples/01_basic_training.py +45 -0
- wyolo-1.0.0/examples/02_mlflow_integration.py +53 -0
- wyolo-1.0.0/examples/cli_usage.sh +13 -0
- wyolo-1.0.0/examples/config_template.yaml +42 -0
- wyolo-1.0.0/examples/train.py +0 -0
- wyolo-1.0.0/examples_readme.py +109 -0
- wyolo-1.0.0/index.html +650 -0
- wyolo-1.0.0/installer.sh +1 -0
- wyolo-1.0.0/mkdocs.yml +33 -0
- wyolo-1.0.0/publish.sh +6 -0
- wyolo-1.0.0/pyproject.toml +158 -0
- wyolo-1.0.0/requirements.txt +3 -0
- wyolo-1.0.0/setup.cfg +2 -0
- wyolo-1.0.0/setup.py +38 -0
- wyolo-1.0.0/src/__init__.py +0 -0
- wyolo-1.0.0/src/wyolo/Dockerfile +67 -0
- wyolo-1.0.0/src/wyolo/__init__.py +10 -0
- wyolo-1.0.0/src/wyolo/app/.dvc/config +12 -0
- wyolo-1.0.0/src/wyolo/app/.vscode/launch.json +16 -0
- wyolo-1.0.0/src/wyolo/app/main.py +97 -0
- wyolo-1.0.0/src/wyolo/app/states/__init__.py +18 -0
- wyolo-1.0.0/src/wyolo/app/states/check/__init__.py +9 -0
- wyolo-1.0.0/src/wyolo/app/states/check/check_dataset.py +50 -0
- wyolo-1.0.0/src/wyolo/app/states/check/check_gpu.py +39 -0
- wyolo-1.0.0/src/wyolo/app/states/check/check_minio.py +49 -0
- wyolo-1.0.0/src/wyolo/app/states/error_process/__init__.py +1 -0
- wyolo-1.0.0/src/wyolo/app/states/error_process/error_capture.py +25 -0
- wyolo-1.0.0/src/wyolo/app/states/load_yaml/load_yaml.py +22 -0
- wyolo-1.0.0/src/wyolo/app/states/train/train.py +59 -0
- wyolo-1.0.0/src/wyolo/app/states/utils/__init__.py +0 -0
- wyolo-1.0.0/src/wyolo/app/states/utils/util.py +193 -0
- wyolo-1.0.0/src/wyolo/app/wyolo/__init__.py +9 -0
- wyolo-1.0.0/src/wyolo/app/wyolo/py.typed +1 -0
- wyolo-1.0.0/src/wyolo/app/wyolo/trainer/cte/elemental.py +8 -0
- wyolo-1.0.0/src/wyolo/app/wyolo/trainer/dto/model_wrapper.py +13 -0
- wyolo-1.0.0/src/wyolo/app/wyolo/trainer/gpu_utils.py +150 -0
- wyolo-1.0.0/src/wyolo/app/wyolo/trainer/trainer_wrapper.py +446 -0
- wyolo-1.0.0/src/wyolo/app/wyolo/trainer/utils/mlflow_setup.py +226 -0
- wyolo-1.0.0/src/wyolo/core/gpu_utils.py +64 -0
- wyolo-1.0.0/src/wyolo/core/mlflow_manager.py +344 -0
- wyolo-1.0.0/src/wyolo/core/register_model.py +64 -0
- wyolo-1.0.0/src/wyolo/core/trainer_wrapper.py +513 -0
- wyolo-1.0.0/src/wyolo/core/trainer_wrapper_backup.py +535 -0
- wyolo-1.0.0/src/wyolo/core/utils.py +153 -0
- wyolo-1.0.0/src/wyolo/core/yolo_train.py +118 -0
- wyolo-1.0.0/src/wyolo/docker/mount-cifs.sh +83 -0
- wyolo-1.0.0/src/wyolo/docker/requirements.txt +42 -0
- wyolo-1.0.0/src/wyolo/docker/train_service.sh +53 -0
- wyolo-1.0.0/src/wyolo/py.typed +1 -0
- wyolo-1.0.0/src/wyolo/trainer/cte/elemental.py +8 -0
- wyolo-1.0.0/src/wyolo/trainer/dto/model_wrapper.py +13 -0
- wyolo-1.0.0/src/wyolo/trainer/gpu_utils.py +46 -0
- wyolo-1.0.0/src/wyolo/trainer/trainer_wrapper.py +305 -0
- wyolo-1.0.0/src/wyolo/trainer/utils/mlflow_setup.py +126 -0
- wyolo-1.0.0/tests/test_basic.py +11 -0
- wyolo-1.0.0/tests/test_mlflow.py +31 -0
- wyolo-1.0.0/tests/test_trainer.py +57 -0
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
name: Pylint
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
on:
|
|
5
|
+
push:
|
|
6
|
+
branches:
|
|
7
|
+
- 001-DEVELOPMENT
|
|
8
|
+
- 002-TEST
|
|
9
|
+
- 003-PRODUCTION
|
|
10
|
+
workflow_dispatch:
|
|
11
|
+
|
|
12
|
+
jobs:
|
|
13
|
+
build:
|
|
14
|
+
runs-on: ubuntu-latest
|
|
15
|
+
strategy:
|
|
16
|
+
matrix:
|
|
17
|
+
python-version: ["3.8", "3.9", "3.10", "3.11"]
|
|
18
|
+
steps:
|
|
19
|
+
- uses: actions/checkout@v4
|
|
20
|
+
- name: Set up Python ${{ matrix.python-version }}
|
|
21
|
+
uses: actions/setup-python@v3
|
|
22
|
+
with:
|
|
23
|
+
python-version: ${{ matrix.python-version }}
|
|
24
|
+
- name: Install dependencies
|
|
25
|
+
run: |
|
|
26
|
+
python -m pip install --upgrade pip
|
|
27
|
+
pip install pylint
|
|
28
|
+
grep -Ev '^(mediapipe|scikit-learn|pandas|pysmb)' requirements.txt > filtered-requirements.txt
|
|
29
|
+
pip install -r filtered-requirements.txt
|
|
30
|
+
pip install scikit-learn pandas pysmb
|
|
31
|
+
pip install -e src/
|
|
32
|
+
pip install -e pipeline/
|
|
33
|
+
- name: Analysing the code with pylint
|
|
34
|
+
run: |
|
|
35
|
+
pylint --output-format=colorized --disable=C0114,R0914,W0603,E1101 $(git ls-files '*.py') > pylint-report.txt
|
|
36
|
+
continue-on-error: true
|
|
37
|
+
- name: Print Pylint Report
|
|
38
|
+
run: |
|
|
39
|
+
echo "=== Pylint Report ==="
|
|
40
|
+
cat pylint-report.txt
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
|
|
2
|
+
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
|
|
3
|
+
|
|
4
|
+
name: Python package
|
|
5
|
+
|
|
6
|
+
on:
|
|
7
|
+
push:
|
|
8
|
+
branches:
|
|
9
|
+
- 001-DEVELOPMENT
|
|
10
|
+
- 002-TEST
|
|
11
|
+
- 003-PRODUCTION
|
|
12
|
+
pull_request:
|
|
13
|
+
branches:
|
|
14
|
+
- 001-DEVELOPMENT
|
|
15
|
+
- 002-TEST
|
|
16
|
+
- 003-PRODUCTION
|
|
17
|
+
workflow_dispatch:
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
jobs:
|
|
22
|
+
build:
|
|
23
|
+
|
|
24
|
+
runs-on: ubuntu-latest
|
|
25
|
+
strategy:
|
|
26
|
+
fail-fast: false
|
|
27
|
+
matrix:
|
|
28
|
+
python-version: ["3.9", "3.10", "3.11"]
|
|
29
|
+
|
|
30
|
+
steps:
|
|
31
|
+
- uses: actions/checkout@v4
|
|
32
|
+
- name: Set up Python ${{ matrix.python-version }}
|
|
33
|
+
uses: actions/setup-python@v3
|
|
34
|
+
with:
|
|
35
|
+
python-version: ${{ matrix.python-version }}
|
|
36
|
+
- name: Install dependencies
|
|
37
|
+
run: |
|
|
38
|
+
python -m pip install --upgrade pip
|
|
39
|
+
python -m pip install flake8 pytest
|
|
40
|
+
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
|
|
41
|
+
- name: Lint with flake8
|
|
42
|
+
run: |
|
|
43
|
+
# stop the build if there are Python syntax errors or undefined names
|
|
44
|
+
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
|
|
45
|
+
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
|
|
46
|
+
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
|
|
47
|
+
- name: Test with pytest
|
|
48
|
+
run: |
|
|
49
|
+
pytest
|
wyolo-1.0.0/.gitignore
ADDED
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
share/python-wheels/
|
|
24
|
+
*.egg-info/
|
|
25
|
+
.installed.cfg
|
|
26
|
+
*.egg
|
|
27
|
+
MANIFEST
|
|
28
|
+
|
|
29
|
+
# PyInstaller
|
|
30
|
+
# Usually these files are written by a python script from a template
|
|
31
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
32
|
+
*.manifest
|
|
33
|
+
*.spec
|
|
34
|
+
|
|
35
|
+
# Installer logs
|
|
36
|
+
pip-log.txt
|
|
37
|
+
pip-delete-this-directory.txt
|
|
38
|
+
|
|
39
|
+
# Unit test / coverage reports
|
|
40
|
+
htmlcov/
|
|
41
|
+
.tox/
|
|
42
|
+
.nox/
|
|
43
|
+
.coverage
|
|
44
|
+
.coverage.*
|
|
45
|
+
.cache
|
|
46
|
+
nosetests.xml
|
|
47
|
+
coverage.xml
|
|
48
|
+
*.cover
|
|
49
|
+
*.py,cover
|
|
50
|
+
.hypothesis/
|
|
51
|
+
.pytest_cache/
|
|
52
|
+
cover/
|
|
53
|
+
|
|
54
|
+
# Translations
|
|
55
|
+
*.mo
|
|
56
|
+
*.pot
|
|
57
|
+
|
|
58
|
+
# Django stuff:
|
|
59
|
+
*.log
|
|
60
|
+
local_settings.py
|
|
61
|
+
db.sqlite3
|
|
62
|
+
db.sqlite3-journal
|
|
63
|
+
|
|
64
|
+
# Flask stuff:
|
|
65
|
+
instance/
|
|
66
|
+
.webassets-cache
|
|
67
|
+
|
|
68
|
+
# Scrapy stuff:
|
|
69
|
+
.scrapy
|
|
70
|
+
|
|
71
|
+
# Sphinx documentation
|
|
72
|
+
docs/_build/
|
|
73
|
+
|
|
74
|
+
# PyBuilder
|
|
75
|
+
.pybuilder/
|
|
76
|
+
target/
|
|
77
|
+
|
|
78
|
+
# Jupyter Notebook
|
|
79
|
+
.ipynb_checkpoints
|
|
80
|
+
|
|
81
|
+
# IPython
|
|
82
|
+
profile_default/
|
|
83
|
+
ipython_config.py
|
|
84
|
+
|
|
85
|
+
# pyenv
|
|
86
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
87
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
88
|
+
# .python-version
|
|
89
|
+
|
|
90
|
+
# pipenv
|
|
91
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
92
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
93
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
94
|
+
# install all needed dependencies.
|
|
95
|
+
#Pipfile.lock
|
|
96
|
+
|
|
97
|
+
# UV
|
|
98
|
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
|
99
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
100
|
+
# commonly ignored for libraries.
|
|
101
|
+
#uv.lock
|
|
102
|
+
|
|
103
|
+
# poetry
|
|
104
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
105
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
106
|
+
# commonly ignored for libraries.
|
|
107
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
108
|
+
#poetry.lock
|
|
109
|
+
|
|
110
|
+
# pdm
|
|
111
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
112
|
+
#pdm.lock
|
|
113
|
+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
|
|
114
|
+
# in version control.
|
|
115
|
+
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
|
|
116
|
+
.pdm.toml
|
|
117
|
+
.pdm-python
|
|
118
|
+
.pdm-build/
|
|
119
|
+
|
|
120
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
121
|
+
__pypackages__/
|
|
122
|
+
|
|
123
|
+
# Celery stuff
|
|
124
|
+
celerybeat-schedule
|
|
125
|
+
celerybeat.pid
|
|
126
|
+
|
|
127
|
+
# SageMath parsed files
|
|
128
|
+
*.sage.py
|
|
129
|
+
|
|
130
|
+
# Environments
|
|
131
|
+
.env
|
|
132
|
+
.venv
|
|
133
|
+
env/
|
|
134
|
+
venv/
|
|
135
|
+
ENV/
|
|
136
|
+
env.bak/
|
|
137
|
+
venv.bak/
|
|
138
|
+
|
|
139
|
+
# Spyder project settings
|
|
140
|
+
.spyderproject
|
|
141
|
+
.spyproject
|
|
142
|
+
|
|
143
|
+
# Rope project settings
|
|
144
|
+
.ropeproject
|
|
145
|
+
|
|
146
|
+
# mkdocs documentation
|
|
147
|
+
/site
|
|
148
|
+
|
|
149
|
+
# mypy
|
|
150
|
+
.mypy_cache/
|
|
151
|
+
.dmypy.json
|
|
152
|
+
dmypy.json
|
|
153
|
+
|
|
154
|
+
# Pyre type checker
|
|
155
|
+
.pyre/
|
|
156
|
+
|
|
157
|
+
# pytype static type analyzer
|
|
158
|
+
.pytype/
|
|
159
|
+
|
|
160
|
+
# Cython debug symbols
|
|
161
|
+
cython_debug/
|
|
162
|
+
|
|
163
|
+
# PyCharm
|
|
164
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
165
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
166
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
167
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
168
|
+
#.idea/
|
|
169
|
+
|
|
170
|
+
# PyPI configuration file
|
|
171
|
+
.pypirc
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
repos:
|
|
2
|
+
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
3
|
+
rev: v4.4.0
|
|
4
|
+
hooks:
|
|
5
|
+
- id: check-yaml
|
|
6
|
+
- id: end-of-file-fixer
|
|
7
|
+
- id: trailing-whitespace
|
|
8
|
+
- id: check-added-large-files
|
|
9
|
+
|
|
10
|
+
- repo: https://github.com/psf/black
|
|
11
|
+
rev: 23.3.0
|
|
12
|
+
hooks:
|
|
13
|
+
- id: black
|
|
14
|
+
|
|
15
|
+
- repo: https://github.com/pycqa/isort
|
|
16
|
+
rev: 5.12.0
|
|
17
|
+
hooks:
|
|
18
|
+
- id: isort
|
|
19
|
+
|
|
20
|
+
- repo: https://github.com/pycqa/flake8
|
|
21
|
+
rev: 6.0.0
|
|
22
|
+
hooks:
|
|
23
|
+
- id: flake8
|
|
24
|
+
args: ['--max-line-length=88', '--extend-ignore=E203']
|
wyolo-1.0.0/CHANGELOG.md
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
6
|
+
|
|
7
|
+
## [1.0.0] - 2026-05-11
|
|
8
|
+
|
|
9
|
+
### Added
|
|
10
|
+
- Initial professional release.
|
|
11
|
+
- Comprehensive MLOps integration with MLflow and MinIO.
|
|
12
|
+
- Support for YOLOv8 and RT-DETR.
|
|
13
|
+
- CLI for automated training.
|
|
14
|
+
- DVC integration for dataset versioning.
|
|
15
|
+
- State-machine based worker implementation.
|
|
16
|
+
- Professional documentation and GitHub Actions workflows.
|
wyolo-1.0.0/CITATION.cff
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
cff-version: 1.2.0
|
|
2
|
+
message: "If you use this software, please cite it as below."
|
|
3
|
+
authors:
|
|
4
|
+
- family-names: "WISROVI"
|
|
5
|
+
given-names: "William Steve Rodriguez Villamizar"
|
|
6
|
+
title: " Libreria python para hacer data augmentation en audios y/o extraer caracteristicas a audios"
|
|
7
|
+
version: 0.22.10
|
|
8
|
+
date-released: 2022-10-12
|
|
9
|
+
url: "https://github.com/wisrovi/ProcessAudio"
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
|
6
|
+
|
|
7
|
+
## Our Standards
|
|
8
|
+
|
|
9
|
+
Examples of behavior that contributes to creating a positive environment include:
|
|
10
|
+
|
|
11
|
+
* Using welcoming and inclusive language
|
|
12
|
+
* Being respectful of differing viewpoints and experiences
|
|
13
|
+
* Gracefully accepting constructive criticism
|
|
14
|
+
* Focusing on what is best for the community
|
|
15
|
+
* Showing empathy towards other community members
|
|
16
|
+
|
|
17
|
+
Examples of unacceptable behavior by participants include:
|
|
18
|
+
|
|
19
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
|
|
20
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
|
21
|
+
* Public or private harassment
|
|
22
|
+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
|
|
23
|
+
* Other conduct which could reasonably be considered inappropriate in a professional setting
|
|
24
|
+
|
|
25
|
+
## Our Responsibilities
|
|
26
|
+
|
|
27
|
+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
|
|
28
|
+
|
|
29
|
+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
|
|
30
|
+
|
|
31
|
+
## Scope
|
|
32
|
+
|
|
33
|
+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
|
|
34
|
+
|
|
35
|
+
## Enforcement
|
|
36
|
+
|
|
37
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at wisrovi.rodriguez@gmail.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
|
|
38
|
+
|
|
39
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
|
|
40
|
+
|
|
41
|
+
## Attribution
|
|
42
|
+
|
|
43
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4)
|
|
44
|
+
|
|
45
|
+
[homepage]: http://contributor-covenant.org
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Contributing to wyolo
|
|
2
|
+
|
|
3
|
+
First off, thank you for considering contributing to `wyolo`! It's people like you who make it a great tool for the community.
|
|
4
|
+
|
|
5
|
+
## ๐ Development Setup
|
|
6
|
+
|
|
7
|
+
1. **Clone the repository:**
|
|
8
|
+
```bash
|
|
9
|
+
git clone https://github.com/wisrovi/wyoloservice2_worker.git
|
|
10
|
+
cd wyoloservice2_worker
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
2. **Install dependencies:**
|
|
14
|
+
We recommend using a virtual environment:
|
|
15
|
+
```bash
|
|
16
|
+
python -m venv venv
|
|
17
|
+
source venv/bin/activate # Linux/macOS
|
|
18
|
+
pip install -e ".[dev]"
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
3. **Install pre-commit hooks:**
|
|
22
|
+
```bash
|
|
23
|
+
pre-commit install
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## ๐งช Running Tests
|
|
27
|
+
|
|
28
|
+
We use `pytest` for testing. To run the tests with coverage:
|
|
29
|
+
```bash
|
|
30
|
+
pytest --cov=src/wyolo
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## ๐ Coding Standards
|
|
34
|
+
|
|
35
|
+
- Follow [PEP 8](https://www.python.org/dev/peps/pep-0008/).
|
|
36
|
+
- Use `black` for formatting.
|
|
37
|
+
- Ensure all new features are covered by tests.
|
|
38
|
+
- Update documentation if you change any public APIs.
|
|
39
|
+
|
|
40
|
+
## ๐ Pull Request Process
|
|
41
|
+
|
|
42
|
+
1. Create a new branch for your feature or bugfix.
|
|
43
|
+
2. Commit your changes with clear, descriptive messages.
|
|
44
|
+
3. Push to your fork and submit a pull request.
|
|
45
|
+
4. Ensure CI passes.
|
|
46
|
+
|
|
47
|
+
## โ๏ธ Code of Conduct
|
|
48
|
+
|
|
49
|
+
Please be respectful and professional in all interactions. See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details.
|
wyolo-1.0.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 William Steve Rodriguez Villamizar
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
wyolo-1.0.0/MANIFEST.in
ADDED
wyolo-1.0.0/Makefile
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
.PHONY: install test lint html serve clean
|
|
2
|
+
|
|
3
|
+
install:
|
|
4
|
+
pip install -e ".[dev]"
|
|
5
|
+
|
|
6
|
+
test:
|
|
7
|
+
pytest --cov=src/wyolo tests/
|
|
8
|
+
|
|
9
|
+
lint:
|
|
10
|
+
pylint src/wyolo || true
|
|
11
|
+
bandit -r src/wyolo
|
|
12
|
+
|
|
13
|
+
html:
|
|
14
|
+
sphinx-build -b html docs/source/ docs/build/html
|
|
15
|
+
|
|
16
|
+
serve: html
|
|
17
|
+
python3 -m http.server 8000 --directory docs/build/html
|
|
18
|
+
|
|
19
|
+
clean:
|
|
20
|
+
rm -rf docs/build/
|
|
21
|
+
find . -type d -name "__pycache__" -exec rm -rf {} +
|