https://github.com/osfunapps/os_android_apk_builder-py

This module will create an Android apk/app bundle programmatically (dynamically), from an Android project, faster and without Android Studio
https://github.com/osfunapps/os_android_apk_builder-py

android apk assemble-release automation create gradle osfunapps pre-publish python release

Last synced: 27 days ago
JSON representation

This module will create an Android apk/app bundle programmatically (dynamically), from an Android project, faster and without Android Studio

• Host: GitHub
• URL: https://github.com/osfunapps/os_android_apk_builder-py
• Owner: osfunapps
• License: mit
• Created: 2019-07-12T20:13:10.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-02-14T11:42:35.000Z (almost 4 years ago)
• Last Synced: 2024-04-14T06:11:39.430Z (9 months ago)
• Topics: android, apk, assemble-release, automation, create, gradle, osfunapps, pre-publish, python, release
• Language: Python
• Homepage:
• Size: 65.4 KB
• Stars: 19
• Watchers: 1
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
Introduction

------------

This module will create an Android APK/App Bundle programmatically (dynamically), from an Android project, faster and without Android Studio.

## Installation

Install via pip:

```python 

pip install os-android-apk-builder

```

## Usage       

    

First, define your KeyStore and version properties:

```python

from os_android_apk_builder.objs.KeyStoreProperties import KeyStoreProperties

from os_android_app_version_changer.objs.VersionProperties import VersionProperties

# set your KeyStore properties

key_store_props = KeyStoreProperties(key_store_file_path='/path/to/keystore/file.jks',

                                     store_password='StorePassword123',

                                     key_alias='alias name',

                                     key_password='KeyPassword123',

                                     v1_signing_enabled=True,

                                     v2_signing_enabled=True)

# set the version properties (version code and version name)

version_props = VersionProperties(new_version_code=VersionProperties.RAISE_VERSION_BY_ONE,

new_version_name="1.0.3")

```

NOTICE: each of the version properties can also hold, apart from specific versions, ```VersionProperties.KEEP_OLD_VERSION``` or ```VersionProperties.RAISE_VERSION_BY_ONE```.

Now, generate an apk or app bundle below:

    

# Generate APK

```python

from os_android_apk_builder import apk_builder

apk_builder.build_apk(project_path='/path/to/android/project',

                      apk_dst_dir_path='/path/to/apk/output/directory',

                      key_store_properties=key_store_props,

                      version_properties=version_props)

```

# Generate AppBundle

```python

from os_android_apk_builder import apk_builder

apk_builder.build_app_bundle(project_path='/path/to/android/project',

                             app_bundle_dst_dir_path='/path/to/app/bundle/output/directory',

                             key_store_properties=key_store_props,

                             version_properties=version_props)

```

## Advanced Usage

You can save your Key Store properties in a file, to avoid supplying them again with each binary build.

Todo so, create a json file (or copy this [sign_in_example.json](os_android_apk_builder/examples/properties_example.json) file): 

```json

{

  "storeFile": "path/to/keystore_file.keystore",

  "storePassword": "myCoolKeyStorePass",

  "keyAlias": "myAliasName",

  "keyPassword": "myAliasPassword",

  "v1SigningEnabled": true,

  "v2SigningEnabled": true

}

```

Then build the KeyStoreProperties base on the link to the file: 

```python

key_store_props = KeyStoreProperties.build_from_file(file_path= 'path/to/json/file.xml')

```    

# Alternative Gradle Path

By default, the program will use your project's gradle wrapper.

If, for some reason, the gradle wrapper isn't good enough, you can set a custom path to an alternative gradle. Just supply its path when creating the apk/app bundle with the argument: 

```python

gradle_path='path/to/gradle'

```

If you want to use your system's gradle, set:

```python

gradle_path='gradle'

```

(you can write just 'gradle' if it's already recognized by your environment variables).

## Links

If you all about automation, why use Android Studio?:  

* [os-play-console-automation](https://github.com/osfunapps/os-android-play-console-automation-py) Will publish your apk/app bundle to the store in a jiffy

* More Android and iOS automation tools can be found in [my profile](https://github.com/osfunapps)

## Licence

MIT