Skip to content

Commit d87999a

Browse files
authored
Cleanup for release 1.0.3 (#110)
* Preparation for release 1.0.3 * Drop unsupported classifier * Clean docs, add warning for CLI * Typo diff
1 parent 528be9f commit d87999a

File tree

4 files changed

+32
-6
lines changed

4 files changed

+32
-6
lines changed

README.md

+28-3
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,15 @@ Package documentation:
1313

1414
REST API documentation: [hadoop.apache.org](http://hadoop.apache.org/docs/stable/hadoop-yarn/hadoop-yarn-site/WebServicesIntro.html)
1515

16+
**Warning**: CLI is outdated & broken. Please don't use CLI. This will be resolved in future releases.
17+
1618
---
17-
## Compatibility
18-
Library is compatible with Apache Hadoop __**3.2.1**__.
19+
## Compatibility Matrix
20+
21+
| yarn-api-client-python | Hadoop |
22+
| ------------- | ------------- |
23+
| 1.0.2 | 3.2.1 |
24+
| 1.0.3 | 3.3.0, 3.3.1 |
1925

2026
If u have version other than mentioned (or vendored variant like Hortonworks), certain APIs might be not working or have differences in
2127
implementation. If u plan to use certain API long-term, you might want to make sure its not in Alpha stage in documentation.
@@ -37,6 +43,16 @@ From source code
3743
pip install git+https://github.com/CODAIT/hadoop-yarn-api-python-client.git
3844
```
3945

46+
## Enabling support for SimpleAuth
47+
48+
See example below:
49+
```
50+
from yarn_api_client.auth import SimpleAuth
51+
from yarn_api_client.history_server import HistoryServer
52+
auth = SimpleAuth('impersonated_account_name')
53+
history_server = HistoryServer('https://127.0.0.2:5678', auth=auth)
54+
```
55+
4056
## Enabling support for Kerberos/SPNEGO Security
4157
1. First option - using `requests_kerberos` package
4258

@@ -53,7 +69,7 @@ from requests_kerberos import HTTPKerberosAuth
5369
history_server = HistoryServer('https://127.0.0.2:5678', auth=HTTPKerberosAuth())
5470
```
5571

56-
PS: You __**need**__ to get valid kerberos ticket in systemwide kerberos cache before running your code, otherwise calls to kerberized environment won't go through (run kinit before proceeding to run code)
72+
PS: You **need** to get valid kerberos ticket in systemwide kerberos cache before running your code, otherwise calls to kerberized environment won't go through (run kinit before proceeding to run code)
5773

5874
2. Second option - using `gssapi` package
5975

@@ -63,6 +79,8 @@ If you want to avoid using terminal calls, you have to perform SPNEGO handshake
6379

6480
### CLI interface
6581

82+
**Warning**: CLI is outdated & broken. Please don't use CLI. This will be resolved in future releases.
83+
6684
1. First way
6785
```
6886
bin/yarn_client --help
@@ -83,6 +101,13 @@ app_information = am.application_information('application_id')
83101

84102
### Changelog
85103

104+
1.0.3 Release
105+
- Drop support of Python 2.7 (if you still need it for extreme emergency, look into reverting ab4f71582f8c69e908db93905485ba4d00562dfd)
106+
- Update of supported hadoop version to 3.3.1
107+
- Add support for YARN_CONF_DIR and HADOOP_CONF_DIR
108+
- Add class for native SimpleAuth (#106)
109+
- Add constructor argument for proxies (#109)
110+
86111
1.0.2 Release
87112
- Add support for Python 3.8.x
88113
- Fix HTTPS url parsing

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,11 @@ def find_version(*file_paths):
5050
'Intended Audience :: Developers',
5151
'License :: OSI Approved :: BSD License',
5252
'Operating System :: OS Independent',
53-
'Programming Language :: Python :: 3.5',
5453
'Programming Language :: Python :: 3.6',
5554
'Programming Language :: Python :: 3.7',
5655
'Programming Language :: Python :: 3.8',
5756
'Programming Language :: Python :: 3.9',
57+
'Programming Language :: Python :: 3.10',
5858
'Topic :: System :: Distributed Computing',
5959
],
6060
)

tox.ini

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11

22
[tox]
3-
envlist = py36, py37, py38, py39
3+
envlist = py36, py37, py38, py39, py310
44

55
[gh-actions]
66
python =
77
3.6: py36
88
3.7: py37
99
3.8: py38
1010
3.9: py39
11+
3.10: py310
1112

1213
[testenv]
1314
deps =

yarn_api_client/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# -*- coding: utf-8 -*-
2-
__version__ = '2.0.0.dev0'
2+
__version__ = '1.0.3'
33
__all__ = ['ApplicationMaster', 'HistoryServer', 'NodeManager', 'ResourceManager']
44

55
from .application_master import ApplicationMaster

0 commit comments

Comments
 (0)