https://github.com/aliyun/aliyun-odps-python-sdk
ODPS Python SDK and data analysis framework
https://github.com/aliyun/aliyun-odps-python-sdk
pyodps
Last synced: about 2 months ago
JSON representation
ODPS Python SDK and data analysis framework
- Host: GitHub
- URL: https://github.com/aliyun/aliyun-odps-python-sdk
- Owner: aliyun
- License: apache-2.0
- Created: 2015-10-30T07:07:59.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2025-07-09T07:25:08.000Z (10 months ago)
- Last Synced: 2025-07-09T08:44:18.652Z (10 months ago)
- Topics: pyodps
- Language: Python
- Homepage: http://pyodps.readthedocs.io
- Size: 7.46 MB
- Stars: 437
- Watchers: 50
- Forks: 98
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: License
Awesome Lists containing this project
README
# ODPS Python SDK
-----------------
Elegent way to access ODPS API. [Documentation](http://pyodps.readthedocs.org/)
## Installation
The quick way:
```
pip install pyodps[full]
```
If you don't need to use Jupyter, just type
```
pip install pyodps
```
The dependencies will be installed automatically.
Or from source code (not recommended for production use):
```shell
$ virtualenv pyodps_env
$ source pyodps_env/bin/activate
$ pip install git+https://github.com/aliyun/aliyun-odps-python-sdk.git
```
## Dependencies
* Python (>=2.7), including Python 3+, pypy, Python 3.7 recommended
* setuptools (>=3.0)
## Run Tests
- install pytest
- copy conf/test.conf.template to odps/tests/test.conf, and fill it with your account
- run `pytest odps`
## Usage
```python
>>> import os
>>> from odps import ODPS
>>> # Make sure environment variable CLOUD_ACCESS_KEY_ID already set to Access Key ID of user
>>> # while environment variable CLOUD_ACCESS_KEY_SECRET set to Access Key Secret of user.
>>> # Not recommended to hardcode Access Key ID or Access Key Secret in your code.
>>> o = ODPS(
>>> os.getenv('CLOUD_ACCESS_KEY_ID'),
>>> os.getenv('CLOUD_ACCESS_KEY_SECRET'),
>>> project='**your-project**',
>>> endpoint='**your-endpoint**',
>>> )
>>> dual = o.get_table('dual')
>>> dual.name
'dual'
>>> dual.table_schema
odps.Schema {
c_int_a bigint
c_int_b bigint
c_double_a double
c_double_b double
c_string_a string
c_string_b string
c_bool_a boolean
c_bool_b boolean
c_datetime_a datetime
c_datetime_b datetime
}
>>> dual.creation_time
datetime.datetime(2014, 6, 6, 13, 28, 24)
>>> dual.is_virtual_view
False
>>> dual.size
448
>>> dual.table_schema.columns
[,
,
,
,
,
,
,
,
,
]
```
## Command-line and IPython enhancement
```
In [1]: %load_ext odps
In [2]: %enter
Out[2]:
In [3]: %sql select * from pyodps_iris limit 5
|==========================================| 1 / 1 (100.00%) 2s
Out[3]:
sepallength sepalwidth petallength petalwidth name
0 5.1 3.5 1.4 0.2 Iris-setosa
1 4.9 3.0 1.4 0.2 Iris-setosa
2 4.7 3.2 1.3 0.2 Iris-setosa
3 4.6 3.1 1.5 0.2 Iris-setosa
4 5.0 3.6 1.4 0.2 Iris-setosa
```
## Python UDF Debugging Tool
```python
#file: plus.py
from odps.udf import annotate
@annotate('bigint,bigint->bigint')
class Plus(object):
def evaluate(self, a, b):
return a + b
```
```
$ cat plus.input
1,1
3,2
$ pyou plus.Plus < plus.input
2
5
```
## Contributing
For a development install, clone the repository and then install from source:
```
git clone https://github.com/aliyun/aliyun-odps-python-sdk.git
cd pyodps
pip install -r requirements.txt -e .
```
## License
Licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html)