pyodps · Python Simple Repository Browser

Project Links

Meta

Author: Wu Wei

Maintainer: Wenjun Si

Classifiers

Operating System

OS Independent

Programming Language

Python
Python :: 2
Python :: 2.7
Python :: 3
Python :: 3.4
Python :: 3.5
Python :: 3.6
Python :: 3.7
Python :: 3.8
Python :: 3.9
Python :: 3.10
Python :: 3.11
Python :: Implementation :: CPython
Python :: Implementation :: PyPy

Topic

Software Development :: Libraries

Elegent way to access ODPS API. Documentation

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):

$ 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

>>> 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
[<column c_int_a, type bigint>,
 <column c_int_b, type bigint>,
 <column c_double_a, type double>,
 <column c_double_b, type double>,
 <column c_string_a, type string>,
 <column c_string_b, type string>,
 <column c_bool_a, type boolean>,
 <column c_bool_b, type boolean>,
 <column c_datetime_a, type datetime>,
 <column c_datetime_b, type datetime>]

Command-line and IPython enhancement

In [1]: %load_ext odps

In [2]: %enter
Out[2]: <odps.inter.Room at 0x10fe0e450>

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

#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

0.12.5 Sep 17, 2025

0.12.4.1 Jul 30, 2025

0.12.4 Jul 03, 2025

0.12.3 May 09, 2025

0.12.2.2 Apr 18, 2025

0.12.2.1 Mar 20, 2025

0.12.2 Jan 03, 2025

0.12.1.1 Dec 05, 2024

0.12.1 Nov 22, 2024

0.12.0 Oct 03, 2024

0.11.6.5 Aug 26, 2024

0.11.6.4 Aug 16, 2024

0.11.6.3 Jul 31, 2024

0.11.6.2 Jul 24, 2024

0.11.6.1 May 13, 2024

0.11.6 Apr 17, 2024

0.11.5.post0 Jan 08, 2024

0.11.5 Jan 05, 2024

0.11.5b2 Nov 20, 2023

0.11.5b1 Nov 10, 2023

0.11.4.1 Jun 29, 2023

0.11.4.post0 May 19, 2023

0.11.4 May 18, 2023

0.11.3.1 Mar 30, 2023

0.11.3 Mar 10, 2023

0.11.3b1 Jan 17, 2023

0.11.2.4 Feb 03, 2023

0.11.2.3 Dec 23, 2022

0.11.2.2 Sep 15, 2022

0.11.2.1 Aug 22, 2022

0.11.2 Aug 17, 2022

0.11.1 Jul 05, 2022

0.11.0 Mar 17, 2022

0.10.7.1 Dec 13, 2021

0.10.1.1 Jun 03, 2024

0.7.20.1 Nov 12, 2018

0.7.12.1 Nov 16, 2017

Wheel compatibility matrix

Platform	CPython 2.7	CPython 3.5	CPython 3.6	CPython 3.7	CPython 3.8	CPython 3.9	CPython 3.10	CPython 3.11	CPython 3.12	CPython (wide) 2.7
macosx_10_9_universal2
macosx_10_9_x86_64
manylinux1_x86_64
manylinux2014_aarch64
manylinux2014_x86_64
manylinux_2_17_aarch64
manylinux_2_17_x86_64
win32
win_amd64