nur 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 (45) hide show
  1. nur-0.1.0/.gitignore +306 -0
  2. nur-0.1.0/LICENSE +21 -0
  3. nur-0.1.0/PKG-INFO +254 -0
  4. nur-0.1.0/README.md +220 -0
  5. nur-0.1.0/pyproject.toml +661 -0
  6. nur-0.1.0/src/nur/__init__.py +5 -0
  7. nur-0.1.0/src/nur/_version.py +24 -0
  8. nur-0.1.0/src/nur/cli.py +112 -0
  9. nur-0.1.0/src/nur/discovery.py +27 -0
  10. nur-0.1.0/src/nur/execution.py +121 -0
  11. nur-0.1.0/src/nur/models.py +38 -0
  12. nur-0.1.0/src/nur/providers/__init__.py +30 -0
  13. nur-0.1.0/src/nur/providers/just.py +58 -0
  14. nur-0.1.0/src/nur/providers/make.py +92 -0
  15. nur-0.1.0/src/nur/providers/npm.py +64 -0
  16. nur-0.1.0/src/nur/providers/pdm.py +65 -0
  17. nur-0.1.0/src/nur/providers/poe.py +61 -0
  18. nur-0.1.0/src/nur/providers/task.py +70 -0
  19. nur-0.1.0/src/nur/py.typed +0 -0
  20. nur-0.1.0/src/nur/registry.py +61 -0
  21. nur-0.1.0/src/nur/tui/__init__.py +0 -0
  22. nur-0.1.0/src/nur/tui/app.py +211 -0
  23. nur-0.1.0/src/nur/tui/app.tcss +6 -0
  24. nur-0.1.0/tests/e2e/__init__.py +0 -0
  25. nur-0.1.0/tests/e2e/test_end_to_end.py +52 -0
  26. nur-0.1.0/tests/integration/__init__.py +0 -0
  27. nur-0.1.0/tests/integration/test_cli.py +118 -0
  28. nur-0.1.0/tests/integration/test_discovery.py +45 -0
  29. nur-0.1.0/tests/integration/tui/__init__.py +0 -0
  30. nur-0.1.0/tests/integration/tui/test_app_execution.py +87 -0
  31. nur-0.1.0/tests/smoke/__init__.py +0 -0
  32. nur-0.1.0/tests/smoke/test_version.py +6 -0
  33. nur-0.1.0/tests/unit/__init__.py +0 -0
  34. nur-0.1.0/tests/unit/providers/__init__.py +0 -0
  35. nur-0.1.0/tests/unit/providers/test_just.py +70 -0
  36. nur-0.1.0/tests/unit/providers/test_make.py +86 -0
  37. nur-0.1.0/tests/unit/providers/test_npm.py +72 -0
  38. nur-0.1.0/tests/unit/providers/test_pdm.py +60 -0
  39. nur-0.1.0/tests/unit/providers/test_poe.py +57 -0
  40. nur-0.1.0/tests/unit/providers/test_task.py +95 -0
  41. nur-0.1.0/tests/unit/test_execution.py +90 -0
  42. nur-0.1.0/tests/unit/test_models.py +29 -0
  43. nur-0.1.0/tests/unit/test_registry.py +76 -0
  44. nur-0.1.0/tests/unit/tui/__init__.py +0 -0
  45. nur-0.1.0/tests/unit/tui/test_app_navigation.py +98 -0
nur-0.1.0/.gitignore ADDED
@@ -0,0 +1,306 @@
1
+ ### Generated by gibo (https://github.com/simonwhitaker/gibo)
2
+ ### https://raw.github.com/github/gitignore/86922aee426c32ffb6098f9a38c42da75169501e/Global/macOS.gitignore
3
+
4
+ # General
5
+ .DS_Store
6
+ __MACOSX/
7
+ .AppleDouble
8
+ .LSOverride
9
+
10
+ # Thumbnails
11
+ ._*
12
+
13
+ # Files that might appear in the root of a volume
14
+ .DocumentRevisions-V100
15
+ .fseventsd
16
+ .Spotlight-V100
17
+ .TemporaryItems
18
+ .Trashes
19
+ .VolumeIcon.icns
20
+ .com.apple.timemachine.donotpresent
21
+
22
+ # Directories potentially created on remote AFP share
23
+ .AppleDB
24
+ .AppleDesktop
25
+ Network Trash Folder
26
+ Temporary Items
27
+ .apdisk
28
+ ### Generated by gibo (https://github.com/simonwhitaker/gibo)
29
+ ### https://raw.github.com/github/gitignore/86922aee426c32ffb6098f9a38c42da75169501e/Global/Windows.gitignore
30
+
31
+ # Windows thumbnail cache files
32
+ Thumbs.db
33
+ Thumbs.db:encryptable
34
+ ehthumbs.db
35
+ ehthumbs_vista.db
36
+
37
+ # Dump file
38
+ *.stackdump
39
+
40
+ # Folder config file
41
+ [Dd]esktop.ini
42
+
43
+ # Recycle Bin used on file shares
44
+ $RECYCLE.BIN/
45
+
46
+ # Windows Installer files
47
+ *.cab
48
+ *.msi
49
+ *.msix
50
+ *.msm
51
+ *.msp
52
+
53
+ # Windows shortcuts
54
+ *.lnk
55
+ ### Generated by gibo (https://github.com/simonwhitaker/gibo)
56
+ ### https://raw.github.com/github/gitignore/86922aee426c32ffb6098f9a38c42da75169501e/Global/Linux.gitignore
57
+
58
+ *~
59
+
60
+ # temporary files which can be created if a process still has a handle open of a deleted file
61
+ .fuse_hidden*
62
+
63
+ # Metadata left by Dolphin file manager, which comes with KDE Plasma
64
+ .directory
65
+
66
+ # Linux trash folder which might appear on any partition or disk
67
+ .Trash-*
68
+
69
+ # .nfs files are created when an open file is removed but is still being accessed
70
+ .nfs*
71
+
72
+ # Log files created by default by the nohup command
73
+ nohup.out
74
+ ### Generated by gibo (https://github.com/simonwhitaker/gibo)
75
+ ### https://raw.github.com/github/gitignore/86922aee426c32ffb6098f9a38c42da75169501e/Global/VisualStudioCode.gitignore
76
+
77
+ .vscode/*
78
+ !.vscode/settings.json
79
+ !.vscode/tasks.json
80
+ !.vscode/launch.json
81
+ !.vscode/extensions.json
82
+ !.vscode/*.code-snippets
83
+ !*.code-workspace
84
+
85
+ # Built Visual Studio Code Extensions
86
+ *.vsix
87
+ ### Generated by gibo (https://github.com/simonwhitaker/gibo)
88
+ ### https://raw.github.com/github/gitignore/86922aee426c32ffb6098f9a38c42da75169501e/Python.gitignore
89
+
90
+ # Byte-compiled / optimized / DLL files
91
+ __pycache__/
92
+ *.py[codz]
93
+ *$py.class
94
+
95
+ # C extensions
96
+ *.so
97
+
98
+ # Distribution / packaging
99
+ .Python
100
+ build/
101
+ develop-eggs/
102
+ dist/
103
+ downloads/
104
+ eggs/
105
+ .eggs/
106
+ lib/
107
+ lib64/
108
+ parts/
109
+ sdist/
110
+ var/
111
+ wheels/
112
+ share/python-wheels/
113
+ *.egg-info/
114
+ .installed.cfg
115
+ *.egg
116
+ MANIFEST
117
+
118
+ # PyInstaller
119
+ # Usually these files are written by a python script from a template
120
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
121
+ *.manifest
122
+ *.spec
123
+
124
+ # Installer logs
125
+ pip-log.txt
126
+ pip-delete-this-directory.txt
127
+
128
+ # Unit test / coverage reports
129
+ htmlcov/
130
+ .tox/
131
+ .nox/
132
+ .coverage
133
+ .coverage.*
134
+ .cache
135
+ nosetests.xml
136
+ coverage.xml
137
+ *.cover
138
+ *.py.cover
139
+ .hypothesis/
140
+ .pytest_cache/
141
+ cover/
142
+
143
+ # Translations
144
+ *.mo
145
+ *.pot
146
+
147
+ # Django stuff:
148
+ *.log
149
+ local_settings.py
150
+ db.sqlite3
151
+ db.sqlite3-journal
152
+
153
+ # Flask stuff:
154
+ instance/
155
+ .webassets-cache
156
+
157
+ # Scrapy stuff:
158
+ .scrapy
159
+
160
+ # Sphinx documentation
161
+ docs/_build/
162
+
163
+ # PyBuilder
164
+ .pybuilder/
165
+ target/
166
+
167
+ # Jupyter Notebook
168
+ .ipynb_checkpoints
169
+
170
+ # IPython
171
+ profile_default/
172
+ ipython_config.py
173
+
174
+ # pyenv
175
+ # For a library or package, you might want to ignore these files since the code is
176
+ # intended to run in multiple environments; otherwise, check them in:
177
+ # .python-version
178
+
179
+ # pipenv
180
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
181
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
182
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
183
+ # install all needed dependencies.
184
+ # Pipfile.lock
185
+
186
+ # UV
187
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
188
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
189
+ # commonly ignored for libraries.
190
+ # uv.lock
191
+
192
+ # poetry
193
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
194
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
195
+ # commonly ignored for libraries.
196
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
197
+ # poetry.lock
198
+ # poetry.toml
199
+
200
+ # pdm
201
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
202
+ # pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
203
+ # https://pdm-project.org/en/latest/usage/project/#working-with-version-control
204
+ # pdm.lock
205
+ # pdm.toml
206
+ .pdm-python
207
+ .pdm-build/
208
+
209
+ # pixi
210
+ # Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
211
+ # pixi.lock
212
+ # Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
213
+ # in the .venv directory. It is recommended not to include this directory in version control.
214
+ .pixi
215
+
216
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
217
+ __pypackages__/
218
+
219
+ # Celery stuff
220
+ celerybeat-schedule
221
+ celerybeat.pid
222
+
223
+ # Redis
224
+ *.rdb
225
+ *.aof
226
+ *.pid
227
+
228
+ # RabbitMQ
229
+ mnesia/
230
+ rabbitmq/
231
+ rabbitmq-data/
232
+
233
+ # ActiveMQ
234
+ activemq-data/
235
+
236
+ # SageMath parsed files
237
+ *.sage.py
238
+
239
+ # Environments
240
+ .env
241
+ .envrc
242
+ .venv
243
+ env/
244
+ venv/
245
+ ENV/
246
+ env.bak/
247
+ venv.bak/
248
+
249
+ # Spyder project settings
250
+ .spyderproject
251
+ .spyproject
252
+
253
+ # Rope project settings
254
+ .ropeproject
255
+
256
+ # mypy
257
+ .mypy_cache/
258
+ .dmypy.json
259
+ dmypy.json
260
+
261
+ # Pyre type checker
262
+ .pyre/
263
+
264
+ # pytype static type analyzer
265
+ .pytype/
266
+
267
+ # Cython debug symbols
268
+ cython_debug/
269
+
270
+
271
+ # PyCharm
272
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
273
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
274
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
275
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
276
+ # .idea/
277
+
278
+ # Abstra
279
+ # Abstra is an AI-powered process automation framework.
280
+ # Ignore directories containing user credentials, local state, and settings.
281
+ # Learn more at https://abstra.io/docs
282
+ .abstra/
283
+
284
+ # Visual Studio Code
285
+ # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
286
+ # that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
287
+ # and can be added to the global gitignore or merged into this file. However, if you prefer,
288
+ # you could uncomment the following to ignore the entire vscode folder
289
+ # .vscode/
290
+
291
+ # Ruff stuff:
292
+ .ruff_cache/
293
+
294
+ # PyPI configuration file
295
+ .pypirc
296
+
297
+ # Marimo
298
+ marimo/_static/
299
+ marimo/_lsp/
300
+ __marimo__/
301
+
302
+ # Streamlit
303
+ .streamlit/secrets.toml
304
+ ### Generated by the author
305
+ src/**/_version.py
306
+ mise.local.toml
nur-0.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Hasan Sezer Taşan
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.
nur-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,254 @@
1
+ Metadata-Version: 2.4
2
+ Name: nur
3
+ Version: 0.1.0
4
+ Summary: A script discovery and execution engine for your project's tasks.
5
+ Project-URL: changelog, https://github.com/hasansezertasan/nur/blob/main/CHANGELOG.md
6
+ Project-URL: documentation, https://hasansezertasan.github.io/nur
7
+ Project-URL: homepage, https://github.com/hasansezertasan/nur
8
+ Project-URL: issues, https://github.com/hasansezertasan/nur/issues
9
+ Project-URL: releasenotes, https://github.com/hasansezertasan/nur/releases
10
+ Project-URL: source, https://github.com/hasansezertasan/nur.git
11
+ Author-email: Hasan Sezer Taşan <hasansezertasan@gmail.com>
12
+ Maintainer-email: Hasan Sezer Taşan <hasansezertasan@gmail.com>
13
+ License-Expression: MIT
14
+ License-File: LICENSE
15
+ Keywords: cli,developer-tools,just,make,npm,pdm,poe,task-runner,taskfile,tui
16
+ Classifier: Development Status :: 4 - Beta
17
+ Classifier: Environment :: Console
18
+ Classifier: Intended Audience :: Developers
19
+ Classifier: License :: OSI Approved :: MIT License
20
+ Classifier: Operating System :: POSIX
21
+ Classifier: Programming Language :: Python :: 3
22
+ Classifier: Programming Language :: Python :: 3 :: Only
23
+ Classifier: Programming Language :: Python :: 3.14
24
+ Classifier: Topic :: Software Development
25
+ Classifier: Topic :: Software Development :: Build Tools
26
+ Classifier: Topic :: Utilities
27
+ Classifier: Typing :: Typed
28
+ Requires-Python: >=3.14
29
+ Requires-Dist: pyyaml>=6.0
30
+ Requires-Dist: textual>=3.0.0
31
+ Requires-Dist: typer>=0.20.0
32
+ Provides-Extra: all
33
+ Description-Content-Type: text/markdown
34
+
35
+ # nur
36
+
37
+ [![CI](https://github.com/hasansezertasan/nur/actions/workflows/ci.yml/badge.svg)](https://github.com/hasansezertasan/nur/actions/workflows/ci.yml)
38
+ [![Coverage](https://img.shields.io/codecov/c/github/hasansezertasan/nur)](https://codecov.io/gh/hasansezertasan/nur)
39
+ [![Documentation Status](https://img.shields.io/github/deployments/hasansezertasan/nur/github-pages?label=docs)](https://hasansezertasan.github.io/nur)
40
+ [![PyPI - Version](https://img.shields.io/pypi/v/nur.svg)](https://pypi.org/project/nur)
41
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/nur.svg)](https://pypi.org/project/nur)
42
+ [![License - MIT](https://img.shields.io/github/license/hasansezertasan/nur.svg)](https://opensource.org/licenses/MIT)
43
+ [![GitHub Stars](https://img.shields.io/github/stars/hasansezertasan/nur?style=social)](https://github.com/hasansezertasan/nur/stargazers)
44
+ [![Latest Commit](https://img.shields.io/github/last-commit/hasansezertasan/nur)](https://github.com/hasansezertasan/nur)
45
+
46
+ [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
47
+ [![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
48
+ [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/hasansezertasan/nur/badge)](https://scorecard.dev/viewer/?uri=github.com/hasansezertasan/nur)
49
+ [![GitHub Tag](https://img.shields.io/github/tag/hasansezertasan/nur?include_prereleases=&sort=semver&color=black)](https://github.com/hasansezertasan/nur/releases/)
50
+
51
+ [![Downloads](https://pepy.tech/badge/nur)](https://pepy.tech/project/nur)
52
+ [![Downloads/Month](https://pepy.tech/badge/nur/month)](https://pepy.tech/project/nur)
53
+ [![Downloads/Week](https://pepy.tech/badge/nur/week)](https://pepy.tech/project/nur)
54
+
55
+ > A script discovery and execution engine for your project's tasks.
56
+
57
+ -----
58
+
59
+ Run `nur` in a project and it discovers tasks across npm (`package.json`),
60
+ `Makefile`, PDM/poe (`pyproject.toml`), `justfile`, and `Taskfile.yml`, then
61
+ lets you run them from a TUI picker or directly from the command line.
62
+ Discovery is limited to the current directory.
63
+
64
+ ## Table of Contents
65
+
66
+ - [Installation](#installation)
67
+ - [Usage](#usage)
68
+ - [Support](#support-heart)
69
+ - [Motivation](#motivation)
70
+ - [Features](#features)
71
+ - [Author](#author-person_with_crown)
72
+ - [Analysis](#analysis)
73
+ - [Contributing](#contributing-heart)
74
+ - [Development](#development-toolbox)
75
+ - [Releasing](#releasing)
76
+ - [Credits](#credits)
77
+ - [License](#license-scroll)
78
+ - [Changelog](#changelog-memo)
79
+
80
+ ## Installation
81
+
82
+ nur is not on PyPI yet. Install the latest from source:
83
+
84
+ ```console
85
+ uv tool install git+https://github.com/hasansezertasan/nur
86
+ ```
87
+
88
+ Or, from a clone:
89
+
90
+ ```console
91
+ uv tool install .
92
+ ```
93
+
94
+ Once published, `nur` will also be installable from PyPI (`pip install nur` /
95
+ `uv tool install nur`), Homebrew, and Scoop.
96
+
97
+ ## Usage
98
+
99
+ Run `nur` from the root of a project that contains any supported task file.
100
+
101
+ ### TUI
102
+
103
+ Run with no arguments to open the interactive picker:
104
+
105
+ ```bash
106
+ nur
107
+ ```
108
+
109
+ Browse and run the discovered tasks in a three-pane Textual UI. Press `q` to
110
+ exit.
111
+
112
+ ### CLI
113
+
114
+ ```bash
115
+ nur test # run a task by name (if unambiguous)
116
+ nur make:test # run a task by its qualified name
117
+ nur test -- --watch # pass extra args through to the underlying runner
118
+ nur list # print all discovered tasks
119
+ nur --version
120
+ ```
121
+
122
+ ### Debugging
123
+
124
+ Debug nur in VS Code using the provided launch configurations:
125
+
126
+ - **Current File**: Debug the currently open Python file.
127
+ - **Tests**: Debug pytest runs.
128
+ - **Attach**: Attach to a running process (with debugpy).
129
+ - **CLI / TUI**: Debug the `nur` command-line and terminal-UI entry points.
130
+
131
+ Select a configuration from the Run and Debug panel in VS Code.
132
+
133
+ ## Support :heart:
134
+
135
+ If you have any questions or need help, feel free to open an issue on the [GitHub repository][nur].
136
+
137
+ ## Motivation
138
+
139
+ Every project speaks a different task dialect — `make test`, `npm run test`,
140
+ `just test`, `task test`, `pdm run test`, `poe test`. nur gives you one command
141
+ that discovers whatever a project already uses and runs it, with no config and
142
+ no need to remember which runner lives where. Discovery is pure text/JSON/TOML
143
+ parsing, so listing tasks never executes anything (no `make -pRrq` side effects).
144
+
145
+ ## Features
146
+
147
+ - **Zero-config discovery** across six providers: `make`, `npm`, `just`,
148
+ `task` (Taskfile), `pdm`, and `poe`.
149
+ - **CLI Application**: run any discovered task by name or qualified `prefix:name`, with `--` passthrough to the underlying runner.
150
+ - **TUI Application**: interactive three-pane task picker built with Textual.
151
+ - **Safe by default**: discovery parses files; it never shells out to a runner just to list tasks.
152
+ - **Type Safety**: full type hints checked by mypy, basedpyright, ty, pyrefly, and zuban.
153
+ - **Code Quality**: comprehensive linting and formatting with ruff.
154
+ - **Testing**: pytest with coverage reporting and parallel execution.
155
+ - **Documentation**: Sphinx documentation with the Shibuya theme, GitHub Pages deployment, and live per-PR documentation previews.
156
+ - **CI/CD**: automated testing, building, and publishing across multiple platforms.
157
+ - **Security**: CodeQL, OpenSSF Scorecard, dependency review, secret scanning (gitleaks), dependency auditing (pip-audit), GitHub Actions static analysis (zizmor), hardened least-privilege workflows, and a CycloneDX SBOM attached to every release.
158
+ - **Modern Python**: uv for dependency management, hatch for building.
159
+
160
+ ## Author :person_with_crown:
161
+
162
+ This project is maintained by [Hasan Sezer Taşan][author], It's me :wave:
163
+
164
+ ## Analysis
165
+
166
+ - [Snyk Python Package Health Analysis](https://snyk.io/advisor/python/nur)
167
+ - [Libraries.io - PyPI](https://libraries.io/pypi/nur)
168
+ - [Safety DB](https://data.safetycli.com/packages/pypi/nur)
169
+ - [PePy Download Stats](https://www.pepy.tech/projects/nur)
170
+ - [PyPI Download Stats](https://pypistats.org/packages/nur)
171
+ - [Pip Trends Download Stats](https://piptrends.com/package/nur)
172
+ - [PyPI Map Dependency Graph](https://pypimap.com/package/nur)
173
+
174
+ ## Contributing :heart:
175
+
176
+ Any contributions are welcome! Please follow the [Contributing Guidelines](./.github/CONTRIBUTING.md) to contribute to this project.
177
+
178
+ <!-- xc-heading -->
179
+ ## Development :toolbox:
180
+
181
+ Clone the repository and cd into the project directory:
182
+
183
+ ```sh
184
+ git clone https://github.com/hasansezertasan/nur
185
+ cd nur
186
+ ```
187
+
188
+ ### `install`
189
+
190
+ Install the dependencies:
191
+
192
+ ```sh
193
+ uv sync
194
+ ```
195
+
196
+ ### `style`
197
+
198
+ Run the style checks:
199
+
200
+ ```sh
201
+ uv run --locked tox run -e style
202
+ ```
203
+
204
+ ### `ci`
205
+
206
+ Run the CI pipeline:
207
+
208
+ ```sh
209
+ uv run --locked tox run
210
+ ```
211
+
212
+ ### `docs-build`
213
+
214
+ Build the documentation site:
215
+
216
+ ```sh
217
+ uv run --locked tox run -e docs-build
218
+ ```
219
+
220
+ ### `docs-server`
221
+
222
+ Start the live-reloading docs server:
223
+
224
+ ```sh
225
+ uv run --locked tox run -e docs-server
226
+ ```
227
+
228
+ ### `docs-linkcheck`
229
+
230
+ Check the documentation for broken links (also runs weekly in CI):
231
+
232
+ ```sh
233
+ uv run --locked tox run -e docs-linkcheck
234
+ ```
235
+
236
+ ## Releasing
237
+
238
+ Versioning and releases are automated with [release-please](https://github.com/googleapis/release-please), driven by [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) PR titles squash-merged into `main`. release-please maintains a release PR that bumps the version and `CHANGELOG.md`; merging it tags the release and publishes to PyPI. See the [Contributing Guidelines](./.github/CONTRIBUTING.md#releasing) for the commit conventions and the one-time [Repository setup](./.github/CONTRIBUTING.md#repository-setup-one-time) (squash-merge settings, Actions permissions, release immutability, and PyPI trusted publishing).
239
+
240
+ ## Credits
241
+
242
+ This package was created with [Copier](https://github.com/copier-org/copier) and the [hasansezertasan/copier-pyproject](https://github.com/hasansezertasan/copier-pyproject) project template.
243
+
244
+ ## License :scroll:
245
+
246
+ This project is licensed under the [MIT License](https://spdx.org/licenses/MIT.html).
247
+
248
+ ## Changelog :memo:
249
+
250
+ For a detailed list of changes, see the [GitHub Releases](https://github.com/hasansezertasan/nur/releases). A `CHANGELOG.md` is generated automatically by release-please on each release.
251
+
252
+ <!-- Refs -->
253
+ [author]: https://github.com/hasansezertasan
254
+ [nur]: https://github.com/hasansezertasan/nur