You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
$ make dev-install # uses uv if available, falls back to pip
73
73
74
-
# or using conda
75
-
$ conda create -n nipyapi-dev python=3.11 -y
76
-
$ conda activate nipyapi-dev
77
-
$ pip install -e ".[dev]"
74
+
# or using uv (faster)
75
+
$ uv venv .venv && source .venv/bin/activate
76
+
$ make dev-install
77
+
78
+
**Note:** The Makefile automatically detects whether ``uv`` is available and uses it for faster installs. If not available, it falls back to ``pip``. Both work seamlessly.
78
79
79
80
4. Create a branch for local development::
80
81
@@ -163,7 +164,7 @@ NiPyAPI uses Makefile targets as the primary automation interface. Run ``make he
163
164
**Setup & Installation**
164
165
::
165
166
166
-
make dev-install # Install package with dev dependencies (recommended)
167
+
make dev-install # Install with dev dependencies (uses uv if available, pip otherwise)
167
168
make docs-install # Install documentation dependencies
168
169
make clean # Remove build, pyc, and temp artifacts
169
170
make clean-all # Nuclear clean: removes ALL including generated code
@@ -193,10 +194,16 @@ NiPyAPI uses Makefile targets as the primary automation interface. Run ``make he
193
194
make lint # Run flake8 + pylint (excludes generated code)
194
195
make flake8 # Run flake8 only
195
196
make pylint # Run pylint only
196
-
make pre-commit # Run pre-commit hooks on all files
197
+
make pre-commit # Run pre-commit hooks (black, isort, flake8, pylint)
198
+
199
+
Pre-commit hooks are the recommended way to ensure code quality before committing. They automatically run formatting and linting checks.
197
200
198
-
# Formatting (manual)
199
-
black nipyapi/ && isort nipyapi/ # Auto-format code
201
+
**Troubleshooting Lint Issues**
202
+
203
+
* **Import order errors**: Run ``isort nipyapi/`` to auto-fix import ordering
204
+
* **Line length errors**: Break long lines at logical points (operators, commas). Max is 100 chars.
205
+
* **Formatting errors**: Run ``black nipyapi/`` to auto-format, then re-run ``make lint``
206
+
* **Linting generated code**: Always use ``make lint`` which excludes generated code automatically
200
207
201
208
**Docker Operations**
202
209
::
@@ -247,8 +254,12 @@ These files are automatically generated from OpenAPI specifications and should n
247
254
248
255
Focus your contributions on these core modules:
249
256
257
+
* ``nipyapi/bulletins.py`` - Bulletin retrieval, filtering, and clearing
Copy file name to clipboardExpand all lines: docs/nipyapi-docs/nifi_models/models.rst
+37-1Lines changed: 37 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ NiFi Models
3
3
4
4
Complete model class reference for NiFi APIs.
5
5
6
-
This reference documents all **394** model classes used by NiFi APIs. These classes are automatically cross-referenced from API documentation - click any model type in API documentation to jump directly to its definition here.
6
+
This reference documents all **403** model classes used by NiFi APIs. These classes are automatically cross-referenced from API documentation - click any model type in API documentation to jump directly to its definition here.
Copy file name to clipboardExpand all lines: docs/nipyapi-docs/registry_models/models.rst
+9-1Lines changed: 9 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ Registry Models
3
3
4
4
Complete model class reference for Registry APIs.
5
5
6
-
This reference documents all **85** model classes used by Registry APIs. These classes are automatically cross-referenced from API documentation - click any model type in API documentation to jump directly to its definition here.
6
+
This reference documents all **87** model classes used by Registry APIs. These classes are automatically cross-referenced from API documentation - click any model type in API documentation to jump directly to its definition here.
0 commit comments