Skip to content

Commit f2ccf64

Browse files
committed
set min version for ruamel.yaml for safety
update devnotes with py2 manual testing deprecate removed models from nifi client docs
1 parent 18214fd commit f2ccf64

File tree

3 files changed

+10
-84
lines changed

3 files changed

+10
-84
lines changed

docs/devnotes.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,16 @@ Instructions::
4848
I recommend you install PyEnv to manage Python versions `sudo curl https://pyenv.run | bash`
4949
Follow the instructions to set up your .bashrc
5050
To build various versions of Python for testing you may also need `sudo dnf install bzip2-devel openssl-devel libffi-devel zlib-devel readline-devel sqlite-devel -y`
51-
Install the latest supported version of Python for your main dev environment `pyenv install 3.9 2.7`
52-
Set these versions as global in pyenv so tox can see them. Use the actual versions with the command `pyenv global 3.9.16 2.7.62`
51+
Install the latest supported version of Python for your main dev environment `pyenv install 3.9 2.7 3.12`
52+
Set these versions as global in pyenv so tox can see them. Use the actual versions with the command `pyenv global 3.9.16 2.7.18 3.12.2`
5353
You'll want to stand up the two sets of NiFi containers for testing. resources/docker/tox-full for default and regression tests, and resources/docker/secure for tests under auth.
5454
You can switch between the tests by changing flags in tests/conftest.py around line 17.
55+
Python3 can be tested automatically using Tox.
56+
Python2 can be tested using the following steps within a Python2 virtualenv:
57+
1. Install requirements: pip install -r requirements.txt
58+
2. Install dev requirements: `pip install -r requirements_dev.txt`
59+
3. Install package in editable mode with test support: `pip install -e .[test]`
60+
4. Run tests: `pytest -v -s tests --tb=long -W ignore::urllib3.exceptions.InsecureRequestWarning`
5561

5662
Setup Code Signing
5763
------------------
@@ -194,7 +200,6 @@ This assumes you have virtualenvwrapper, git, and appropriate python versions in
194200
# Run appropriate tests, such as usage tests etc.
195201
deactivate
196202
Push changes to Github
197-
Check build on TravisCI
198203
Check dockerhub automated build
199204
# You may have to reactivate your original virtualenv
200205
twine upload dist/*

docs/nipyapi-docs/nipyapi.nifi.models.rst

Lines changed: 0 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -188,38 +188,6 @@ nipyapi.nifi.models.batch\_size module
188188
:undoc-members:
189189
:show-inheritance:
190190

191-
nipyapi.nifi.models.bucket module
192-
---------------------------------
193-
194-
.. automodule:: nipyapi.nifi.models.bucket
195-
:members:
196-
:undoc-members:
197-
:show-inheritance:
198-
199-
nipyapi.nifi.models.bucket\_dto module
200-
--------------------------------------
201-
202-
.. automodule:: nipyapi.nifi.models.bucket_dto
203-
:members:
204-
:undoc-members:
205-
:show-inheritance:
206-
207-
nipyapi.nifi.models.bucket\_entity module
208-
-----------------------------------------
209-
210-
.. automodule:: nipyapi.nifi.models.bucket_entity
211-
:members:
212-
:undoc-members:
213-
:show-inheritance:
214-
215-
nipyapi.nifi.models.buckets\_entity module
216-
------------------------------------------
217-
218-
.. automodule:: nipyapi.nifi.models.buckets_entity
219-
:members:
220-
:undoc-members:
221-
:show-inheritance:
222-
223191
nipyapi.nifi.models.bulletin\_board\_dto module
224192
-----------------------------------------------
225193

@@ -1036,14 +1004,6 @@ nipyapi.nifi.models.peers\_entity module
10361004
:undoc-members:
10371005
:show-inheritance:
10381006

1039-
nipyapi.nifi.models.permissions module
1040-
--------------------------------------
1041-
1042-
.. automodule:: nipyapi.nifi.models.permissions
1043-
:members:
1044-
:undoc-members:
1045-
:show-inheritance:
1046-
10471007
nipyapi.nifi.models.permissions\_dto module
10481008
-------------------------------------------
10491009

@@ -1388,30 +1348,6 @@ nipyapi.nifi.models.queue\_size\_dto module
13881348
:undoc-members:
13891349
:show-inheritance:
13901350

1391-
nipyapi.nifi.models.registry\_client\_entity module
1392-
---------------------------------------------------
1393-
1394-
.. automodule:: nipyapi.nifi.models.registry_client_entity
1395-
:members:
1396-
:undoc-members:
1397-
:show-inheritance:
1398-
1399-
nipyapi.nifi.models.registry\_clients\_entity module
1400-
----------------------------------------------------
1401-
1402-
.. automodule:: nipyapi.nifi.models.registry_clients_entity
1403-
:members:
1404-
:undoc-members:
1405-
:show-inheritance:
1406-
1407-
nipyapi.nifi.models.registry\_dto module
1408-
----------------------------------------
1409-
1410-
.. automodule:: nipyapi.nifi.models.registry_dto
1411-
:members:
1412-
:undoc-members:
1413-
:show-inheritance:
1414-
14151351
nipyapi.nifi.models.relationship\_dto module
14161352
--------------------------------------------
14171353

@@ -1916,14 +1852,6 @@ nipyapi.nifi.models.versioned\_controller\_service module
19161852
:undoc-members:
19171853
:show-inheritance:
19181854

1919-
nipyapi.nifi.models.versioned\_flow module
1920-
------------------------------------------
1921-
1922-
.. automodule:: nipyapi.nifi.models.versioned_flow
1923-
:members:
1924-
:undoc-members:
1925-
:show-inheritance:
1926-
19271855
nipyapi.nifi.models.versioned\_flow\_coordinates module
19281856
-------------------------------------------------------
19291857

@@ -1948,13 +1876,6 @@ nipyapi.nifi.models.versioned\_flow\_entity module
19481876
:undoc-members:
19491877
:show-inheritance:
19501878

1951-
nipyapi.nifi.models.versioned\_flow\_snapshot module
1952-
----------------------------------------------------
1953-
1954-
.. automodule:: nipyapi.nifi.models.versioned_flow_snapshot
1955-
:members:
1956-
:undoc-members:
1957-
:show-inheritance:
19581879

19591880
nipyapi.nifi.models.versioned\_flow\_snapshot\_entity module
19601881
------------------------------------------------------------

requirements.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ requests[security]>=2.18
1919
pysocks>=1.7.1
2020

2121
# Import Export and Utils implementation
22-
ruamel.yaml<0.18; python_version < '3'
23-
ruamel.yaml; python_version >= '3'
22+
ruamel.yaml>=0.16.3,<0.18; python_version < '3'
23+
ruamel.yaml>=0.16.3; python_version >= '3'
2424

2525
# xml to json parsing
2626
xmltodict>=0.12.0

0 commit comments

Comments
 (0)