Skip to main content

An Android automation framework.

Project description

Cerium

Platform PyPI version Wheel Python version License Documentation status

Cerium is an umbrella project encapsulating a variety of tools and libraries enabling android automation.

Cerium's source code is made available under the Apache 2.0 license.

Welcome to Read the Docs for Cerium!

Introduction

Cerium: A Toy for Android Automation

Cerium is an Android automation framework for Python, safe for human consumption.

Behold, the power of Cerium:

>>> from cerium import AndroidDriver
>>> driver = AndroidDriver()
>>> driver.unlock(1997)   # unlock your device by password
>>> driver.auto_connect()   # connect to your device via TCP/IP automatically
Now you can unplug the USB cable, and control your device via WLAN.
>>> driver.view_packgets_list(keyword='tencent')
['com.tencent.mm', 'com.tencent.android.qqdownloader', 'com.tencent.tim']
>>> driver.make_a_call(18268237856)   # call me

Cerium allows you to send organic, grass-fed commands, without the the need for manual labor.

Android Debug Bridge (adb) is a versatile command line tool that lets you communicate with an emulator instance or connected Android-powered device. This project is based on it.

Supported Python Versions

  • Python 3.6+

Supported Platforms

  • Windows 10 (Other platforms have not been tested and are not intended to be supported for the time being officially)

Installation

If you have pip on your system, you can simply install or upgrade cerium:

pip install -U cerium

Alternately, you can download the source distribution from PyPI, unarchive it, and run:

python setup.py install

Or by github.com:

git clone git@github.com:fjwCode/cerium.git
cd cerium
python setup.py install

Note: You may want to consider using virtualenv to create isolated Python environments.

Android Debug Bridge

Cerium requires Android Debug Bridge Tool to with the chosen android device. And Cerium contains Android Debug Bridge by default. You don't need to set the environment variable by yourself.

Quickstart

  • List connected android devices or simulator.
  • Show the version of Android Debug Bridge.
from cerium import AndroidDriver

driver = AndroidDriver()

print(driver.devices())
print(driver.devices_l())  # show devices and models

print(driver.version())
  • Copy local files/directories to device.
  • Copy files/directories from device.
  • Taking a screenshot of a device display, then copy it to your computer.
from cerium import AndroidDriver

driver = AndroidDriver()

driver.push(local='README.md', remote='/sdcard/README.md')
driver.pull(remote='/sdcard/README.md', local='README.md')

driver.pull_screencap(local='screencap.png')
  • Simulate finger click.
  • Simulate finger slide.
  • Input text.
from cerium import AndroidDriver

driver = AndroidDriver()

driver.click(100, 100)
driver.swipe(100, 200, 100, 100, duration=100)
driver.send_keys("I'm White Turing.")

Author

Cerium is written and maintained by White Turing (fujiawei@stu.hznu.edu.cn).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cerium-1.2.4.tar.gz (851.8 kB view details)

Uploaded Source

Built Distribution

cerium-1.2.4-py3-none-any.whl (854.5 kB view details)

Uploaded Python 3

File details

Details for the file cerium-1.2.4.tar.gz.

File metadata

  • Download URL: cerium-1.2.4.tar.gz
  • Upload date:
  • Size: 851.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for cerium-1.2.4.tar.gz
Algorithm Hash digest
SHA256 e81ddbe86a11686c49abfedc895c3ae52e995f092672bc7388325162a118f2aa
MD5 7164b10b02277e70df790c8cd3bfcf3f
BLAKE2b-256 ce407f7427749214f5cac1975f1115a12bdb65684e1328c84d0fb6269cfd86d2

See more details on using hashes here.

File details

Details for the file cerium-1.2.4-py3-none-any.whl.

File metadata

File hashes

Hashes for cerium-1.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e38842a9e38e0c48f1c5b8007c9e1f84f352f277d101fc78f4e0500b55663fdc
MD5 9990290f53f168bc3a37f375eeaaa004
BLAKE2b-256 0a88981b6610c2257e02ccf595d3c358a570fd24e8bda3656710cf8df31dca74

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page