yutipy 0.1.1__tar.gz → 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.

Potentially problematic release.


This version of yutipy might be problematic. Click here for more details.

Files changed (63) hide show
  1. {yutipy-0.1.1 → yutipy-1.0.0}/.gitattributes +2 -2
  2. {yutipy-0.1.1 → yutipy-1.0.0}/.github/FUNDING.yml +1 -1
  3. {yutipy-0.1.1 → yutipy-1.0.0}/.github/workflows/pytest-unit-testing.yml +43 -43
  4. yutipy-1.0.0/.github/workflows/release.yml +119 -0
  5. {yutipy-0.1.1 → yutipy-1.0.0}/.gitignore +160 -160
  6. {yutipy-0.1.1 → yutipy-1.0.0}/.readthedocs.yaml +26 -26
  7. {yutipy-0.1.1 → yutipy-1.0.0}/LICENSE +21 -21
  8. {yutipy-0.1.1 → yutipy-1.0.0}/PKG-INFO +140 -140
  9. {yutipy-0.1.1 → yutipy-1.0.0}/README.md +83 -83
  10. {yutipy-0.1.1 → yutipy-1.0.0}/docs/api_reference.rst +116 -116
  11. {yutipy-0.1.1 → yutipy-1.0.0}/docs/conf.py +71 -71
  12. yutipy-1.0.0/docs/faq.rst +73 -0
  13. yutipy-1.0.0/docs/index.rst +59 -0
  14. {yutipy-0.1.1 → yutipy-1.0.0}/docs/installation.rst +10 -10
  15. {yutipy-0.1.1 → yutipy-1.0.0}/docs/make.bat +35 -35
  16. {yutipy-0.1.1 → yutipy-1.0.0}/docs/requirements.txt +4 -4
  17. {yutipy-0.1.1 → yutipy-1.0.0}/docs/usage_examples.rst +83 -83
  18. {yutipy-0.1.1 → yutipy-1.0.0}/pyproject.toml +55 -55
  19. {yutipy-0.1.1 → yutipy-1.0.0}/requirements-dev.txt +1 -1
  20. {yutipy-0.1.1 → yutipy-1.0.0}/requirements.txt +4 -4
  21. {yutipy-0.1.1 → yutipy-1.0.0}/setup.cfg +4 -4
  22. {yutipy-0.1.1 → yutipy-1.0.0}/tests/__init__.py +1 -1
  23. {yutipy-0.1.1 → yutipy-1.0.0}/tests/test_models.py +35 -35
  24. {yutipy-0.1.1 → yutipy-1.0.0}/yutipy/models.py +55 -55
  25. {yutipy-0.1.1 → yutipy-1.0.0}/yutipy/spotify.py +24 -23
  26. {yutipy-0.1.1 → yutipy-1.0.0}/yutipy.egg-info/PKG-INFO +140 -140
  27. {yutipy-0.1.1 → yutipy-1.0.0}/yutipy.egg-info/SOURCES.txt +3 -17
  28. yutipy-0.1.1/docs/index.rst +0 -27
  29. yutipy-0.1.1/tests/__pycache__/__init__.cpython-312.pyc +0 -0
  30. yutipy-0.1.1/tests/__pycache__/test_deezer.cpython-312-pytest-8.3.4.pyc +0 -0
  31. yutipy-0.1.1/tests/__pycache__/test_itunes.cpython-312-pytest-8.3.4.pyc +0 -0
  32. yutipy-0.1.1/tests/__pycache__/test_models.cpython-312-pytest-8.3.4.pyc +0 -0
  33. yutipy-0.1.1/tests/__pycache__/test_musicyt.cpython-312-pytest-8.3.4.pyc +0 -0
  34. yutipy-0.1.1/tests/__pycache__/test_spotify.cpython-312-pytest-8.3.4.pyc +0 -0
  35. yutipy-0.1.1/tests/__pycache__/test_utils.cpython-312-pytest-8.3.4.pyc +0 -0
  36. yutipy-0.1.1/yutipy/__pycache__/__init__.cpython-312.pyc +0 -0
  37. yutipy-0.1.1/yutipy/__pycache__/deezer.cpython-312.pyc +0 -0
  38. yutipy-0.1.1/yutipy/__pycache__/exceptions.cpython-312.pyc +0 -0
  39. yutipy-0.1.1/yutipy/__pycache__/itunes.cpython-312.pyc +0 -0
  40. yutipy-0.1.1/yutipy/__pycache__/models.cpython-312.pyc +0 -0
  41. yutipy-0.1.1/yutipy/__pycache__/musicyt.cpython-312.pyc +0 -0
  42. yutipy-0.1.1/yutipy/__pycache__/spotify.cpython-312.pyc +0 -0
  43. yutipy-0.1.1/yutipy/utils/__pycache__/__init__.cpython-312.pyc +0 -0
  44. yutipy-0.1.1/yutipy/utils/__pycache__/cheap_utils.cpython-312.pyc +0 -0
  45. {yutipy-0.1.1 → yutipy-1.0.0}/MANIFEST.in +0 -0
  46. {yutipy-0.1.1 → yutipy-1.0.0}/docs/Makefile +0 -0
  47. {yutipy-0.1.1 → yutipy-1.0.0}/docs/_static/yutipy_header.png +0 -0
  48. {yutipy-0.1.1 → yutipy-1.0.0}/docs/_static/yutipy_logo.png +0 -0
  49. {yutipy-0.1.1 → yutipy-1.0.0}/tests/test_deezer.py +0 -0
  50. {yutipy-0.1.1 → yutipy-1.0.0}/tests/test_itunes.py +0 -0
  51. {yutipy-0.1.1 → yutipy-1.0.0}/tests/test_musicyt.py +0 -0
  52. {yutipy-0.1.1 → yutipy-1.0.0}/tests/test_spotify.py +0 -0
  53. {yutipy-0.1.1 → yutipy-1.0.0}/tests/test_utils.py +0 -0
  54. {yutipy-0.1.1 → yutipy-1.0.0}/yutipy/__init__.py +0 -0
  55. {yutipy-0.1.1 → yutipy-1.0.0}/yutipy/deezer.py +0 -0
  56. {yutipy-0.1.1 → yutipy-1.0.0}/yutipy/exceptions.py +0 -0
  57. {yutipy-0.1.1 → yutipy-1.0.0}/yutipy/itunes.py +0 -0
  58. {yutipy-0.1.1 → yutipy-1.0.0}/yutipy/musicyt.py +0 -0
  59. {yutipy-0.1.1 → yutipy-1.0.0}/yutipy/utils/__init__.py +0 -0
  60. {yutipy-0.1.1 → yutipy-1.0.0}/yutipy/utils/cheap_utils.py +0 -0
  61. {yutipy-0.1.1 → yutipy-1.0.0}/yutipy.egg-info/dependency_links.txt +0 -0
  62. {yutipy-0.1.1 → yutipy-1.0.0}/yutipy.egg-info/requires.txt +0 -0
  63. {yutipy-0.1.1 → yutipy-1.0.0}/yutipy.egg-info/top_level.txt +0 -0
@@ -1,2 +1,2 @@
1
- # Auto detect text files and perform LF normalization
2
- * text=auto
1
+ # Auto detect text files and perform LF normalization
2
+ * text=auto
@@ -1 +1 @@
1
- ko_fi: cheapnightbot
1
+ ko_fi: cheapnightbot
@@ -1,43 +1,43 @@
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: Pytest
5
-
6
- on:
7
- push:
8
- branches: [ "main" ]
9
- pull_request:
10
- branches: [ "main" ]
11
-
12
- permissions:
13
- contents: read
14
-
15
- jobs:
16
- build:
17
-
18
- runs-on: ubuntu-latest
19
- strategy:
20
- fail-fast: false
21
- matrix:
22
- python-version: ["3.9", "3.10", "3.11"]
23
-
24
- steps:
25
- - uses: actions/checkout@v4
26
- - name: Set up Python ${{ matrix.python-version }}
27
- uses: actions/setup-python@v3
28
- with:
29
- python-version: ${{ matrix.python-version }}
30
- - name: Install dependencies
31
- run: |
32
- python -m pip install --upgrade pip
33
- python -m pip install flake8 pytest
34
- if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
35
- - name: Lint with flake8
36
- run: |
37
- # stop the build if there are Python syntax errors or undefined names
38
- flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
39
- # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
40
- flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
41
- - name: Test with pytest
42
- run: |
43
- pytest
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: Pytest
5
+
6
+ on:
7
+ push:
8
+ branches: [ "main" ]
9
+ pull_request:
10
+ branches: [ "main" ]
11
+
12
+ permissions:
13
+ contents: read
14
+
15
+ jobs:
16
+ build:
17
+
18
+ runs-on: ubuntu-latest
19
+ strategy:
20
+ fail-fast: false
21
+ matrix:
22
+ python-version: ["3.9", "3.10", "3.11"]
23
+
24
+ steps:
25
+ - uses: actions/checkout@v4
26
+ - name: Set up Python ${{ matrix.python-version }}
27
+ uses: actions/setup-python@v3
28
+ with:
29
+ python-version: ${{ matrix.python-version }}
30
+ - name: Install dependencies
31
+ run: |
32
+ python -m pip install --upgrade pip
33
+ python -m pip install flake8 pytest
34
+ if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
35
+ - name: Lint with flake8
36
+ run: |
37
+ # stop the build if there are Python syntax errors or undefined names
38
+ flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
39
+ # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
40
+ flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
41
+ - name: Test with pytest
42
+ run: |
43
+ pytest
@@ -0,0 +1,119 @@
1
+ name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
2
+
3
+ on: push
4
+
5
+ jobs:
6
+ build:
7
+ name: Build distribution 📦
8
+ runs-on: ubuntu-latest
9
+ permissions:
10
+ contents: read
11
+ id-token: write
12
+
13
+ steps:
14
+ - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
15
+ with:
16
+ persist-credentials: false
17
+ - name: Set up Python
18
+ uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5.1.0
19
+ with:
20
+ python-version: "3.x"
21
+ - name: Install pypa/build
22
+ run: >-
23
+ python3 -m
24
+ pip install
25
+ build setuptools
26
+ --user
27
+ - name: Build a binary wheel and a source tarball
28
+ run: python3 -m build
29
+ - name: Store the distribution packages
30
+ uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
31
+ with:
32
+ name: python-package-distributions
33
+ path: dist/
34
+ publish-to-pypi:
35
+ name: >-
36
+ Publish Python 🐍 distribution 📦 to PyPI
37
+ if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes
38
+ needs:
39
+ - build
40
+ runs-on: ubuntu-latest
41
+ environment:
42
+ name: pypi-release
43
+ url: https://pypi.org/project/yutipy
44
+ permissions:
45
+ id-token: write # IMPORTANT: mandatory for trusted publishing
46
+ steps:
47
+ - name: Download all the dists
48
+ uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
49
+ with:
50
+ name: python-package-distributions
51
+ path: dist/
52
+ - name: Publish distribution 📦 to PyPI
53
+ uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # v1.12.4
54
+ github-release:
55
+ name: >-
56
+ Sign the Python 🐍 distribution 📦 with Sigstore
57
+ and upload them to GitHub Release
58
+ needs:
59
+ - publish-to-pypi
60
+ runs-on: ubuntu-latest
61
+
62
+ permissions:
63
+ contents: write # IMPORTANT: mandatory for making GitHub Releases
64
+ id-token: write # IMPORTANT: mandatory for sigstore
65
+
66
+ steps:
67
+ - name: Download all the dists
68
+ uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
69
+ with:
70
+ name: python-package-distributions
71
+ path: dist/
72
+ - name: Sign the dists with Sigstore
73
+ uses: sigstore/gh-action-sigstore-python@f514d46b907ebcd5bedc05145c03b69c1edd8b46 # v3.0.0
74
+ with:
75
+ inputs: >-
76
+ ./dist/*.tar.gz
77
+ ./dist/*.whl
78
+ - name: Create GitHub Release
79
+ env:
80
+ GITHUB_TOKEN: ${{ github.token }}
81
+ run: >-
82
+ gh release create
83
+ "$GITHUB_REF_NAME"
84
+ --repo "$GITHUB_REPOSITORY"
85
+ --notes ""
86
+ --generate-notes
87
+ - name: Upload artifact signatures to GitHub Release
88
+ env:
89
+ GITHUB_TOKEN: ${{ github.token }}
90
+ # Upload to GitHub Release using the `gh` CLI.
91
+ # `dist/` contains the built packages, and the
92
+ # sigstore-produced signatures and certificates.
93
+ run: >-
94
+ gh release upload
95
+ "$GITHUB_REF_NAME" dist/**
96
+ --repo "$GITHUB_REPOSITORY"
97
+ publish-to-testpypi:
98
+ name: Publish Python 🐍 distribution 📦 to TestPyPI
99
+ needs:
100
+ - build
101
+ runs-on: ubuntu-latest
102
+
103
+ environment:
104
+ name: testpypi-release
105
+ url: https://test.pypi.org/project/yutipy
106
+
107
+ permissions:
108
+ id-token: write # IMPORTANT: mandatory for trusted publishing
109
+
110
+ steps:
111
+ - name: Download all the dists
112
+ uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
113
+ with:
114
+ name: python-package-distributions
115
+ path: dist/
116
+ - name: Publish distribution 📦 to TestPyPI
117
+ uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # v1.12.4
118
+ with:
119
+ repository-url: https://test.pypi.org/legacy/
@@ -1,160 +1,160 @@
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
- # poetry
98
- # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99
- # This is especially recommended for binary packages to ensure reproducibility, and is more
100
- # commonly ignored for libraries.
101
- # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102
- #poetry.lock
103
-
104
- # pdm
105
- # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106
- #pdm.lock
107
- # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108
- # in version control.
109
- # https://pdm.fming.dev/#use-with-ide
110
- .pdm.toml
111
-
112
- # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113
- __pypackages__/
114
-
115
- # Celery stuff
116
- celerybeat-schedule
117
- celerybeat.pid
118
-
119
- # SageMath parsed files
120
- *.sage.py
121
-
122
- # Environments
123
- .env
124
- .venv
125
- env/
126
- venv/
127
- ENV/
128
- env.bak/
129
- venv.bak/
130
-
131
- # Spyder project settings
132
- .spyderproject
133
- .spyproject
134
-
135
- # Rope project settings
136
- .ropeproject
137
-
138
- # mkdocs documentation
139
- /site
140
-
141
- # mypy
142
- .mypy_cache/
143
- .dmypy.json
144
- dmypy.json
145
-
146
- # Pyre type checker
147
- .pyre/
148
-
149
- # pytype static type analyzer
150
- .pytype/
151
-
152
- # Cython debug symbols
153
- cython_debug/
154
-
155
- # PyCharm
156
- # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157
- # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
158
- # and can be added to the global gitignore or merged into this file. For a more nuclear
159
- # option (not recommended) you can uncomment the following to ignore the entire idea folder.
160
- #.idea/
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
+ # poetry
98
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102
+ #poetry.lock
103
+
104
+ # pdm
105
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106
+ #pdm.lock
107
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108
+ # in version control.
109
+ # https://pdm.fming.dev/#use-with-ide
110
+ .pdm.toml
111
+
112
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113
+ __pypackages__/
114
+
115
+ # Celery stuff
116
+ celerybeat-schedule
117
+ celerybeat.pid
118
+
119
+ # SageMath parsed files
120
+ *.sage.py
121
+
122
+ # Environments
123
+ .env
124
+ .venv
125
+ env/
126
+ venv/
127
+ ENV/
128
+ env.bak/
129
+ venv.bak/
130
+
131
+ # Spyder project settings
132
+ .spyderproject
133
+ .spyproject
134
+
135
+ # Rope project settings
136
+ .ropeproject
137
+
138
+ # mkdocs documentation
139
+ /site
140
+
141
+ # mypy
142
+ .mypy_cache/
143
+ .dmypy.json
144
+ dmypy.json
145
+
146
+ # Pyre type checker
147
+ .pyre/
148
+
149
+ # pytype static type analyzer
150
+ .pytype/
151
+
152
+ # Cython debug symbols
153
+ cython_debug/
154
+
155
+ # PyCharm
156
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
158
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
159
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
160
+ #.idea/
@@ -1,26 +1,26 @@
1
- # Read the Docs configuration file
2
- # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3
-
4
- # Required
5
- version: 2
6
-
7
- # Set the OS, Python version, and other tools you might need
8
- build:
9
- os: ubuntu-24.04
10
- tools:
11
- python: "3.12"
12
-
13
- # Build documentation in the "docs/" directory with Sphinx
14
- sphinx:
15
- configuration: docs/conf.py
16
- builder: html
17
- fail_on_warning: true
18
-
19
- # Optionally, but recommended,
20
- # declare the Python requirements required to build your documentation
21
- # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
22
- python:
23
- install:
24
- - method: pip
25
- path: .
26
- - requirements: docs/requirements.txt
1
+ # Read the Docs configuration file
2
+ # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3
+
4
+ # Required
5
+ version: 2
6
+
7
+ # Set the OS, Python version, and other tools you might need
8
+ build:
9
+ os: ubuntu-24.04
10
+ tools:
11
+ python: "3.12"
12
+
13
+ # Build documentation in the "docs/" directory with Sphinx
14
+ sphinx:
15
+ configuration: docs/conf.py
16
+ builder: html
17
+ fail_on_warning: true
18
+
19
+ # Optionally, but recommended,
20
+ # declare the Python requirements required to build your documentation
21
+ # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
22
+ python:
23
+ install:
24
+ - method: pip
25
+ path: .
26
+ - requirements: docs/requirements.txt
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2025 Cheap Nightbot
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.
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Cheap Nightbot
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.