repeaterbook 0.1.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.
Files changed (43) hide show
  1. repeaterbook-0.1.0/.all-contributorsrc +16 -0
  2. repeaterbook-0.1.0/.cruft.json +28 -0
  3. repeaterbook-0.1.0/.editorconfig +27 -0
  4. repeaterbook-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md +26 -0
  5. repeaterbook-0.1.0/.github/ISSUE_TEMPLATE/config.yml +4 -0
  6. repeaterbook-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md +19 -0
  7. repeaterbook-0.1.0/.github/workflows/ci.yml +40 -0
  8. repeaterbook-0.1.0/.github/workflows/codecov_action.yml +43 -0
  9. repeaterbook-0.1.0/.github/workflows/semantic-release.yml +42 -0
  10. repeaterbook-0.1.0/.gitignore +165 -0
  11. repeaterbook-0.1.0/.pre-commit-config.yaml +10 -0
  12. repeaterbook-0.1.0/.python-version +1 -0
  13. repeaterbook-0.1.0/.python-versions +4 -0
  14. repeaterbook-0.1.0/.readthedocs.yaml +23 -0
  15. repeaterbook-0.1.0/LICENSE +21 -0
  16. repeaterbook-0.1.0/PKG-INFO +174 -0
  17. repeaterbook-0.1.0/asv.conf.json +20 -0
  18. repeaterbook-0.1.0/benchmarks/__init__.py +1 -0
  19. repeaterbook-0.1.0/benchmarks/benchmarks.py +1 -0
  20. repeaterbook-0.1.0/docs/CHANGELOG.md +12 -0
  21. repeaterbook-0.1.0/docs/CODE_OF_CONDUCT.md +133 -0
  22. repeaterbook-0.1.0/docs/CONTRIBUTING.md +292 -0
  23. repeaterbook-0.1.0/docs/Makefile +20 -0
  24. repeaterbook-0.1.0/docs/README.md +143 -0
  25. repeaterbook-0.1.0/docs/__init__.py +1 -0
  26. repeaterbook-0.1.0/docs/_static/.gitignore +0 -0
  27. repeaterbook-0.1.0/docs/_templates/.gitignore +0 -0
  28. repeaterbook-0.1.0/docs/conf.py +76 -0
  29. repeaterbook-0.1.0/docs/index.rst +22 -0
  30. repeaterbook-0.1.0/docs/make.bat +35 -0
  31. repeaterbook-0.1.0/docs/reference.md +116 -0
  32. repeaterbook-0.1.0/docs/wordlist.txt +77 -0
  33. repeaterbook-0.1.0/noxfile.py +90 -0
  34. repeaterbook-0.1.0/playground/.gitignore +2 -0
  35. repeaterbook-0.1.0/pyproject.toml +173 -0
  36. repeaterbook-0.1.0/src/repeaterbook/__init__.py +1 -0
  37. repeaterbook-0.1.0/src/repeaterbook/models.py +289 -0
  38. repeaterbook-0.1.0/src/repeaterbook/py.typed +0 -0
  39. repeaterbook-0.1.0/src/repeaterbook/services.py +396 -0
  40. repeaterbook-0.1.0/src/repeaterbook/utils.py +49 -0
  41. repeaterbook-0.1.0/tests/__init__.py +1 -0
  42. repeaterbook-0.1.0/tests/test_repeaterbook.py +5 -0
  43. repeaterbook-0.1.0/uv.lock +2935 -0
@@ -0,0 +1,16 @@
1
+ {
2
+ "files": [
3
+ "docs/README.md"
4
+ ],
5
+ "imageSize": 100,
6
+ "commit": false,
7
+ "contributors": [
8
+ ],
9
+ "contributorsPerLine": 7,
10
+ "badgeTemplate": "[badge-all-contributors]: https://img.shields.io/badge/all_contributors-<%= contributors.length %>-orange.svg?style=flat-square",
11
+ "projectName": "repeaterbook",
12
+ "projectOwner": "MicaelJarniac",
13
+ "repoType": "github",
14
+ "repoHost": "https://github.com",
15
+ "skipCi": true
16
+ }
@@ -0,0 +1,28 @@
1
+ {
2
+ "template": "https://github.com/MicaelJarniac/crustypy",
3
+ "commit": "3af00654de427f00c49ac2f2281ff3522f0b7416",
4
+ "checkout": null,
5
+ "context": {
6
+ "cookiecutter": {
7
+ "full_name": "Micael Jarniac",
8
+ "email": "micael@jarniac.dev",
9
+ "github_username": "MicaelJarniac",
10
+ "year": "2025",
11
+ "project_name": "RepeaterBook",
12
+ "project_slug": "repeaterbook",
13
+ "project_distribution_name": "repeaterbook",
14
+ "project_short_description": "Python utility to work with data from RepeaterBook.",
15
+ "version": "0.0.0",
16
+ "main_branch": "main",
17
+ "shields_url": "https://img.shields.io",
18
+ "discord_invite": "Ye9yJtZQuN",
19
+ "report_method": "micael@jarniac.dev",
20
+ "__github_path": "MicaelJarniac/repeaterbook",
21
+ "__github_url": "https://github.com/MicaelJarniac/repeaterbook",
22
+ "__readthedocs_name": "repeaterbook",
23
+ "_template": "https://github.com/MicaelJarniac/crustypy",
24
+ "_commit": "3af00654de427f00c49ac2f2281ff3522f0b7416"
25
+ }
26
+ },
27
+ "directory": null
28
+ }
@@ -0,0 +1,27 @@
1
+ # EditorConfig is awesome: https://EditorConfig.org
2
+
3
+ # Top-most EditorConfig file
4
+ root = true
5
+
6
+ # Unix-style newlines with a newline ending every file
7
+ [*]
8
+ end_of_line = lf
9
+ insert_final_newline = true
10
+
11
+ [*.{py}]
12
+ charset = utf-8
13
+
14
+ [*.py]
15
+ indent_style = space
16
+ indent_size = 4
17
+
18
+ [*.md]
19
+ indent_style = space
20
+ indent_size = 2
21
+
22
+ [*.{yml, yaml}]
23
+ indent_style = space
24
+ indent_size = 2
25
+
26
+ [Makefile]
27
+ indent_style = tab
@@ -0,0 +1,26 @@
1
+ ---
2
+ name: Bug report
3
+ about: Create a report to help us improve
4
+ # title: "[BUG]"
5
+ labels: bug
6
+
7
+ ---
8
+
9
+ ### Describe the bug
10
+ A clear and concise description of what the bug is.
11
+
12
+ ### To reproduce
13
+ Steps to reproduce the behavior:
14
+ 1. Go to '...'
15
+ 2. Click on '....'
16
+ 3. Scroll down to '....'
17
+ 4. See error
18
+
19
+ ### Expected behavior
20
+ A clear and concise description of what you expected to happen.
21
+
22
+ ### Screenshots
23
+ If applicable, add screenshots to help explain your problem.
24
+
25
+ ### Additional context
26
+ Add any other context about the problem here.
@@ -0,0 +1,4 @@
1
+ contact_links:
2
+ - name: Discord
3
+ url: https://discord.gg/Ye9yJtZQuN
4
+ about: Please ask and answer questions here.
@@ -0,0 +1,19 @@
1
+ ---
2
+ name: Feature request
3
+ about: Suggest an idea for this project
4
+ # title: "[FEAT]"
5
+ labels: enhancement
6
+
7
+ ---
8
+
9
+ **Is your feature request related to a problem? Please describe.**
10
+ A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11
+
12
+ **Describe the solution you'd like**
13
+ A clear and concise description of what you want to happen.
14
+
15
+ **Describe alternatives you've considered**
16
+ A clear and concise description of any alternative solutions or features you've considered.
17
+
18
+ **Additional context**
19
+ Add any other context or screenshots about the feature request here.
@@ -0,0 +1,40 @@
1
+ name: CI
2
+
3
+ on:
4
+ pull_request:
5
+ push:
6
+ branches:
7
+ - main
8
+ - rc
9
+
10
+ env:
11
+ FORCE_COLOR: 1
12
+ PRE_COMMIT_COLOR: "always" # https://github.com/pre-commit/pre-commit/issues/2918
13
+
14
+ jobs:
15
+ generate-jobs:
16
+ name: Generate Session Jobs
17
+ runs-on: ubuntu-latest
18
+ outputs:
19
+ session: ${{ steps.set-matrix.outputs.session }}
20
+ steps:
21
+ - uses: actions/checkout@v4
22
+ - uses: wntrblm/nox@main
23
+ - id: set-matrix
24
+ shell: bash
25
+ run: echo session=$(nox --json -l | jq -c '[.[].session]') | tee --append $GITHUB_OUTPUT
26
+ sessions:
27
+ name: Session ${{ matrix.session }}
28
+ needs: [generate-jobs]
29
+ runs-on: ubuntu-latest
30
+ strategy:
31
+ fail-fast: false
32
+ matrix:
33
+ session: ${{ fromJson(needs.generate-jobs.outputs.session) }}
34
+ steps:
35
+ - uses: actions/checkout@v4
36
+ - uses: astral-sh/setup-uv@v5
37
+ with:
38
+ enable-cache: true
39
+ - uses: wntrblm/nox@main
40
+ - run: nox -s "${{ matrix.session }}"
@@ -0,0 +1,43 @@
1
+ name: Codecov
2
+
3
+ on:
4
+ pull_request:
5
+ push:
6
+ branches:
7
+ - main
8
+ - rc
9
+
10
+ jobs:
11
+ run:
12
+ runs-on: ubuntu-latest
13
+
14
+ permissions:
15
+ id-token: write
16
+ contents: read
17
+
18
+ steps:
19
+ - uses: actions/checkout@v4
20
+
21
+ - name: Install uv
22
+ uses: astral-sh/setup-uv@v5
23
+ with:
24
+ enable-cache: true
25
+
26
+ - name: Set up Python
27
+ uses: actions/setup-python@v5
28
+ with:
29
+ python-version-file: ".python-version"
30
+
31
+ - name: Install project
32
+ run: uv sync --all-extras --no-default-groups --group tests
33
+
34
+ - name: Generate coverage report
35
+ run: |
36
+ uv run pytest --cov --cov-report=xml
37
+
38
+ - name: Upload coverage to Codecov
39
+ uses: codecov/codecov-action@v5
40
+ with:
41
+ use_oidc: true
42
+ files: ./coverage.xml
43
+ flags: unittests
@@ -0,0 +1,42 @@
1
+ name: Semantic Release
2
+
3
+ on:
4
+ push:
5
+ branches:
6
+ - main
7
+ - rc
8
+
9
+ jobs:
10
+ Release:
11
+ runs-on: ubuntu-latest
12
+ concurrency: release
13
+
14
+ permissions:
15
+ id-token: write
16
+ contents: write
17
+
18
+ steps:
19
+ - uses: actions/checkout@v4
20
+ with:
21
+ fetch-depth: 0
22
+ ref: ${{ github.sha }}
23
+
24
+ - run: |
25
+ git checkout -B ${{ github.ref_name }} ${{ github.sha }}
26
+
27
+ - name: Python Semantic Release
28
+ id: release
29
+ uses: python-semantic-release/python-semantic-release@v9.19.1
30
+ with:
31
+ github_token: ${{ secrets.GITHUB_TOKEN }}
32
+
33
+ - name: Publish package to GitHub
34
+ uses: python-semantic-release/publish-action@v9.19.1
35
+ if: steps.release.outputs.released == 'true'
36
+ with:
37
+ github_token: ${{ secrets.GITHUB_TOKEN }}
38
+ tag: ${{ steps.release.outputs.tag }}
39
+
40
+ - name: Publish to PyPI
41
+ uses: pypa/gh-action-pypi-publish@release/v1
42
+ if: steps.release.outputs.released == 'true'
@@ -0,0 +1,165 @@
1
+ repeaterbook.db
2
+
3
+ # Byte-compiled / optimized / DLL files
4
+ __pycache__/
5
+ *.py[cod]
6
+ *$py.class
7
+
8
+ # C extensions
9
+ *.so
10
+
11
+ # Distribution / packaging
12
+ .Python
13
+ build/
14
+ develop-eggs/
15
+ dist/
16
+ downloads/
17
+ eggs/
18
+ .eggs/
19
+ lib/
20
+ lib64/
21
+ parts/
22
+ sdist/
23
+ var/
24
+ wheels/
25
+ share/python-wheels/
26
+ *.egg-info/
27
+ .installed.cfg
28
+ *.egg
29
+ MANIFEST
30
+
31
+ # PyInstaller
32
+ # Usually these files are written by a python script from a template
33
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
34
+ *.manifest
35
+ *.spec
36
+
37
+ # Installer logs
38
+ pip-log.txt
39
+ pip-delete-this-directory.txt
40
+
41
+ # Unit test / coverage reports
42
+ htmlcov/
43
+ .tox/
44
+ .nox/
45
+ .coverage
46
+ .coverage.*
47
+ .cache
48
+ nosetests.xml
49
+ coverage.xml
50
+ *.cover
51
+ *.py,cover
52
+ .hypothesis/
53
+ .pytest_cache/
54
+ cover/
55
+
56
+ # Translations
57
+ *.mo
58
+ *.pot
59
+
60
+ # Django stuff:
61
+ *.log
62
+ local_settings.py
63
+ db.sqlite3
64
+ db.sqlite3-journal
65
+
66
+ # Flask stuff:
67
+ instance/
68
+ .webassets-cache
69
+
70
+ # Scrapy stuff:
71
+ .scrapy
72
+
73
+ # Sphinx documentation
74
+ docs/_build/
75
+
76
+ # PyBuilder
77
+ .pybuilder/
78
+ target/
79
+
80
+ # Jupyter Notebook
81
+ .ipynb_checkpoints
82
+
83
+ # IPython
84
+ profile_default/
85
+ ipython_config.py
86
+
87
+ # pyenv
88
+ # For a library or package, you might want to ignore these files since the code is
89
+ # intended to run in multiple environments; otherwise, check them in:
90
+ # .python-version
91
+
92
+ # pipenv
93
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
94
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
95
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
96
+ # install all needed dependencies.
97
+ #Pipfile.lock
98
+
99
+ # poetry
100
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
101
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
102
+ # commonly ignored for libraries.
103
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
104
+ #poetry.lock
105
+
106
+ # pdm
107
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
108
+ #pdm.lock
109
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
110
+ # in version control.
111
+ # https://pdm.fming.dev/#use-with-ide
112
+ .pdm.toml
113
+
114
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
115
+ __pypackages__/
116
+
117
+ # Celery stuff
118
+ celerybeat-schedule
119
+ celerybeat.pid
120
+
121
+ # SageMath parsed files
122
+ *.sage.py
123
+
124
+ # Environments
125
+ .env
126
+ .venv
127
+ env/
128
+ venv/
129
+ ENV/
130
+ env.bak/
131
+ venv.bak/
132
+
133
+ # Spyder project settings
134
+ .spyderproject
135
+ .spyproject
136
+
137
+ # Rope project settings
138
+ .ropeproject
139
+
140
+ # mkdocs documentation
141
+ /site
142
+
143
+ # mypy
144
+ .mypy_cache/
145
+ .dmypy.json
146
+ dmypy.json
147
+
148
+ # Pyre type checker
149
+ .pyre/
150
+
151
+ # pytype static type analyzer
152
+ .pytype/
153
+
154
+ # Cython debug symbols
155
+ cython_debug/
156
+
157
+ # PyCharm
158
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
159
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
160
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
161
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
162
+ #.idea/
163
+
164
+ # Ruff
165
+ .ruff_cache/
@@ -0,0 +1,10 @@
1
+ repos:
2
+ - repo: https://github.com/pre-commit/pre-commit-hooks
3
+ rev: 'v5.0.0'
4
+ hooks:
5
+ - id: check-toml
6
+ - id: check-yaml
7
+ - id: check-json
8
+ - id: end-of-file-fixer
9
+ - id: trailing-whitespace
10
+ - id: requirements-txt-fixer
@@ -0,0 +1 @@
1
+ 3.13
@@ -0,0 +1,4 @@
1
+ 3.10
2
+ 3.11
3
+ 3.12
4
+ 3.13
@@ -0,0 +1,23 @@
1
+ version: 2
2
+
3
+ build:
4
+ os: "ubuntu-lts-latest"
5
+ tools:
6
+ python: "latest"
7
+ jobs:
8
+ # https://docs.readthedocs.com/platform/stable/build-customization.html#install-dependencies-with-uv
9
+ create_environment:
10
+ - asdf plugin add uv
11
+ - asdf install uv latest
12
+ - asdf global uv latest
13
+ - uv venv $READTHEDOCS_VIRTUALENV_PATH
14
+ install:
15
+ - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --all-extras --no-default-groups --group docs
16
+
17
+ # Build from the docs/ directory with Sphinx
18
+ sphinx:
19
+ configuration: docs/conf.py
20
+
21
+ formats:
22
+ - pdf
23
+ - epub
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Micael Jarniac
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.
@@ -0,0 +1,174 @@
1
+ Metadata-Version: 2.4
2
+ Name: repeaterbook
3
+ Version: 0.1.0
4
+ Summary: Python utility to work with data from RepeaterBook.
5
+ Project-URL: homepage, https://github.com/MicaelJarniac/repeaterbook
6
+ Project-URL: source, https://github.com/MicaelJarniac/repeaterbook
7
+ Project-URL: download, https://pypi.org/project/repeaterbook/#files
8
+ Project-URL: changelog, https://github.com/MicaelJarniac/repeaterbook/blob/main/docs/CHANGELOG.md
9
+ Project-URL: documentation, https://repeaterbook.readthedocs.io
10
+ Project-URL: issues, https://github.com/MicaelJarniac/repeaterbook/issues
11
+ Author-email: Micael Jarniac <micael@jarniac.dev>
12
+ License: MIT
13
+ License-File: LICENSE
14
+ Classifier: Development Status :: 1 - Planning
15
+ Classifier: License :: OSI Approved :: MIT License
16
+ Classifier: Natural Language :: English
17
+ Classifier: Operating System :: OS Independent
18
+ Classifier: Programming Language :: Python :: 3
19
+ Classifier: Typing :: Typed
20
+ Requires-Python: >=3.10
21
+ Requires-Dist: aiohttp>=3.11.14
22
+ Requires-Dist: anyio>=4.9.0
23
+ Requires-Dist: attrs>=25.3.0
24
+ Requires-Dist: haversine>=2.9.0
25
+ Requires-Dist: loguru>=0.7.3
26
+ Requires-Dist: pycountry>=24.6.1
27
+ Requires-Dist: sqlmodel>=0.0.24
28
+ Requires-Dist: tqdm>=4.67.1
29
+ Requires-Dist: yarl>=1.18.3
30
+ Description-Content-Type: text/markdown
31
+
32
+ <div align="center">
33
+
34
+ [![Discord][badge-chat]][chat]
35
+ <br>
36
+ <br>
37
+
38
+ | | ![Badges][label-badges] |
39
+ |:-|:-|
40
+ | ![Build][label-build] | [![Nox][badge-actions]][actions] [![semantic-release][badge-semantic-release]][semantic-release] [![PyPI][badge-pypi]][pypi] [![Read the Docs][badge-docs]][docs] |
41
+ | ![Tests][label-tests] | [![coverage][badge-coverage]][coverage] [![pre-commit][badge-pre-commit]][pre-commit] [![asv][badge-asv]][asv] |
42
+ | ![Standards][label-standards] | [![SemVer 2.0.0][badge-semver]][semver] [![Conventional Commits][badge-conventional-commits]][conventional-commits] |
43
+ | ![Code][label-code] | [![uv][badge-uv]][uv] [![Ruff][badge-ruff]][ruff] [![Nox][badge-nox]][nox] [![Checked with mypy][badge-mypy]][mypy] |
44
+ | ![Repo][label-repo] | [![GitHub issues][badge-issues]][issues] [![GitHub stars][badge-stars]][stars] [![GitHub license][badge-license]][license] [![All Contributors][badge-all-contributors]][contributors] [![Contributor Covenant][badge-code-of-conduct]][code-of-conduct] |
45
+ </div>
46
+
47
+ <!-- Badges -->
48
+ [badge-chat]: https://img.shields.io/badge/dynamic/json?color=green&label=chat&query=%24.approximate_presence_count&suffix=%20online&logo=discord&style=flat-square&url=https%3A%2F%2Fdiscord.com%2Fapi%2Fv10%2Finvites%2FYe9yJtZQuN%3Fwith_counts%3Dtrue
49
+ [chat]: https://discord.gg/Ye9yJtZQuN
50
+
51
+ <!-- Labels -->
52
+ [label-badges]: https://img.shields.io/badge/%F0%9F%94%96-badges-purple?style=for-the-badge
53
+ [label-build]: https://img.shields.io/badge/%F0%9F%94%A7-build-darkblue?style=flat-square
54
+ [label-tests]: https://img.shields.io/badge/%F0%9F%A7%AA-tests-darkblue?style=flat-square
55
+ [label-standards]: https://img.shields.io/badge/%F0%9F%93%91-standards-darkblue?style=flat-square
56
+ [label-code]: https://img.shields.io/badge/%F0%9F%92%BB-code-darkblue?style=flat-square
57
+ [label-repo]: https://img.shields.io/badge/%F0%9F%93%81-repo-darkblue?style=flat-square
58
+
59
+ <!-- Build -->
60
+ [badge-actions]: https://img.shields.io/github/actions/workflow/status/MicaelJarniac/repeaterbook/ci.yml?branch=main&style=flat-square
61
+ [actions]: https://github.com/MicaelJarniac/repeaterbook/actions
62
+ [badge-semantic-release]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079?style=flat-square
63
+ [semantic-release]: https://github.com/semantic-release/semantic-release
64
+ [badge-pypi]: https://img.shields.io/pypi/v/repeaterbook?style=flat-square
65
+ [pypi]: https://pypi.org/project/repeaterbook
66
+ [badge-docs]: https://img.shields.io/readthedocs/repeaterbook?style=flat-square
67
+ [docs]: https://repeaterbook.readthedocs.io
68
+
69
+ <!-- Tests -->
70
+ [badge-coverage]: https://img.shields.io/codecov/c/gh/MicaelJarniac/repeaterbook?logo=codecov&style=flat-square
71
+ [coverage]: https://codecov.io/gh/MicaelJarniac/repeaterbook
72
+ [badge-pre-commit]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=flat-square&logo=pre-commit&logoColor=white
73
+ [pre-commit]: https://github.com/pre-commit/pre-commit
74
+ [badge-asv]: https://img.shields.io/badge/benchmarked%20by-asv-blue?style=flat-square
75
+ [asv]: https://github.com/airspeed-velocity/asv
76
+
77
+ <!-- Standards -->
78
+ [badge-semver]: https://img.shields.io/badge/SemVer-2.0.0-blue?style=flat-square&logo=semver
79
+ [semver]: https://semver.org/spec/v2.0.0.html
80
+ [badge-conventional-commits]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow?style=flat-square
81
+ [conventional-commits]: https://conventionalcommits.org
82
+
83
+ <!-- Code -->
84
+ [badge-uv]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json&style=flat-square
85
+ [uv]: https://github.com/astral-sh/uv
86
+ [badge-ruff]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&style=flat-square
87
+ [ruff]: https://github.com/astral-sh/ruff
88
+ [badge-nox]: https://img.shields.io/badge/%F0%9F%A6%8A-Nox-D85E00.svg?style=flat-square
89
+ [nox]: https://github.com/wntrblm/nox
90
+ [badge-mypy]: https://img.shields.io/badge/mypy-checked-2A6DB2?style=flat-square
91
+ [mypy]: http://mypy-lang.org
92
+
93
+ <!-- Repo -->
94
+ [badge-issues]: https://img.shields.io/github/issues/MicaelJarniac/repeaterbook?style=flat-square
95
+ [issues]: https://github.com/MicaelJarniac/repeaterbook/issues
96
+ [badge-stars]: https://img.shields.io/github/stars/MicaelJarniac/repeaterbook?style=flat-square
97
+ [stars]: https://github.com/MicaelJarniac/repeaterbook/stargazers
98
+ [badge-license]: https://img.shields.io/github/license/MicaelJarniac/repeaterbook?style=flat-square
99
+ [license]: https://github.com/MicaelJarniac/repeaterbook/blob/main/LICENSE
100
+ <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
101
+ [badge-all-contributors]: https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square
102
+ <!-- ALL-CONTRIBUTORS-BADGE:END -->
103
+ [contributors]: #Contributors-✨
104
+ [badge-code-of-conduct]: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa?style=flat-square
105
+ [code-of-conduct]: CODE_OF_CONDUCT.md
106
+ <!---->
107
+
108
+ # RepeaterBook
109
+ Python utility to work with data from RepeaterBook.
110
+
111
+ [Read the Docs][docs]
112
+
113
+ Read RepeaterBook's official [API documentation](https://www.repeaterbook.com/wiki/doku.php?id=api) for more information.
114
+
115
+ ## See Also
116
+ - https://github.com/afourney/hamkit/tree/main/packages/repeaterbook
117
+ - https://github.com/desertblade/OpenGD77-Repeaterbook
118
+ - https://github.com/TomHW/OpenGD77
119
+
120
+ ## Installation
121
+
122
+ ### PyPI
123
+ [*repeaterbook*][pypi] is available on PyPI:
124
+
125
+ ```bash
126
+ # With uv
127
+ uv add repeaterbook
128
+ # With pip
129
+ pip install repeaterbook
130
+ # With Poetry
131
+ poetry add repeaterbook
132
+ ```
133
+
134
+ ### GitHub
135
+ You can also install the latest version of the code directly from GitHub:
136
+ ```bash
137
+ # With uv
138
+ uv add git+https://github.com/MicaelJarniac/repeaterbook
139
+ # With pip
140
+ pip install git+git://github.com/MicaelJarniac/repeaterbook
141
+ # With Poetry
142
+ poetry add git+git://github.com/MicaelJarniac/repeaterbook
143
+ ```
144
+
145
+ ## Usage
146
+ For more examples, see the [full documentation][docs].
147
+
148
+ ```python
149
+ from repeaterbook import repeaterbook
150
+ ```
151
+
152
+ ## Contributing
153
+ Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
154
+
155
+ Please make sure to update tests as appropriate.
156
+
157
+ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
158
+
159
+ ## Contributors ✨
160
+ <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
161
+ <!-- prettier-ignore-start -->
162
+ <!-- markdownlint-disable -->
163
+ <table>
164
+ </table>
165
+
166
+ <!-- markdownlint-restore -->
167
+ <!-- prettier-ignore-end -->
168
+
169
+ <!-- ALL-CONTRIBUTORS-LIST:END -->
170
+
171
+ ## License
172
+ [MIT](../LICENSE)
173
+
174
+ This project was created with the [MicaelJarniac/crustypy](https://github.com/MicaelJarniac/crustypy) template.
@@ -0,0 +1,20 @@
1
+ {
2
+ "version": 1,
3
+ "project": "repeaterbook",
4
+ "project_url": "https://github.com/MicaelJarniac/repeaterbook",
5
+ "repo": ".",
6
+ "build_command": [
7
+ "python -m build --wheel -o {build_cache_dir} {build_dir}"
8
+ ],
9
+ "branches": ["main"],
10
+ "environment_type": "virtualenv",
11
+ "show_commit_url": "https://github.com/MicaelJarniac/repeaterbook/commit/",
12
+ "matrix": {
13
+ "req": {
14
+ "build": []
15
+ }
16
+ },
17
+ "env_dir": ".asv/env",
18
+ "results_dir": ".asv/results",
19
+ "html_dir": ".asv/html"
20
+ }
@@ -0,0 +1 @@
1
+ """Benchmarking for repeaterbook."""
@@ -0,0 +1 @@
1
+ """Benchmarking for repeaterbook."""