Git Product home page Git Product logo

termux-api's Introduction

termux-api

Build Status

termux-api is here, made with โค๏ธ

What is termux-api?

termux-api is a python module to access the termux-api This provides a way to get native access in Python to Android device functionality as API.

Most of the termux-api implementations are directly available. The API.generic() method gives direct access to any other method that has not yet been implemented.

Special thanks

Thanks to termux and termux-api for making all this possible. This module is heavily inspired by https://github.com/azwyane/pimux, though the code has been almost completely re-written and now is much more comprehensive. Also, special thanks for recent contribution from Young-Lord This project is originally located at termux-api

Table of Contents

Requirements

  • Termux app
  • Termux-api (both app and package)
  • Python installed in termux ($ pkg install python)

Installation

๐Ÿš€ย  Android install through termux:

Method-1

Install by pip The stable version is available in the Pypi, which you can download by:

$ python3 -m pip install termux-api

Method-2

You can always get the latest version of termux-api maintained here in the github.

  • Clone this repo to your local machine(termux) using https://github.com/shajul/termux-api.git

Goto to your terminal and type:

$ git clone https://github.com/shajul/termux-api.git
$ python3 -m pip install wheel
$ python3 -m pip install dist/termux_api*.whl

Or you can add this to site packages by first building it first:

$ python3 setup.py sdist bdist_wheel
$ python3 -m pip install -e <path to termux_api*.whl>

Finally, you have it installed.

Run the project

Now to run the termux-api type in your terminal:

$ python
>>> import termux
>>> termux.API.vibrate()

>>> help(termux.API) #for available methods

Avaliable modules are API, Camera, Clipboard, Media, Microphone, Notification, Scheduler, Sensors, Share, Telephony, TTS, UI, Wifi

OR

$ python
>>> from termux import <Module>
>>> API.vibrate()

>>> help(API) # for details of available methods

Contributing

Step 1

  • Option 1

    • ๐Ÿด Fork this repo!
  • Option 2

    • ๐Ÿ‘ฏ Clone this repo to your local machine using https://github.com/shajul/termux-api.git

Step 2

  • HACK AWAY!

Step 3


Found a bug? Missing a specific feature?

You can file an issue. If you already found a solution to your problem, I would love to review your pull request!

termux-api's People

Contributors

drshajul avatar haakooto avatar martyx98 avatar nenadilic84 avatar young-lord avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.