Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eventonehq/apkup
🚀 Publish APKs to Google Play directly from the terminal
https://github.com/eventonehq/apkup
android apk google google-play hacktoberfest mobile play upload
Last synced: 2 months ago
JSON representation
🚀 Publish APKs to Google Play directly from the terminal
- Host: GitHub
- URL: https://github.com/eventonehq/apkup
- Owner: eventOneHQ
- License: mit
- Created: 2018-12-15T17:30:53.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-30T01:58:04.000Z (over 1 year ago)
- Last Synced: 2024-11-11T07:45:08.244Z (2 months ago)
- Topics: android, apk, google, google-play, hacktoberfest, mobile, play, upload
- Language: TypeScript
- Homepage: https://oss.eventone.page/apkup
- Size: 1.05 MB
- Stars: 36
- Watchers: 5
- Forks: 12
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Apkup
[](https://www.npmjs.com/package/apkup)
[](https://travis-ci.com/eventOneHQ/apkup)
[](https://github.com/eventOneHQ/apkup/issues)
[](https://github.com/eventOneHQ/apkup/pulls)
[](https://github.com/semantic-release/semantic-release)
---
Publish APKs to Google Play directly from the terminal
This package offers a streamlined way to publish packages in the Google Play Store.
A fork of [playup](https://github.com/jeduan/playup).
## 📝 Table of Contents
- [Getting Started](#getting_started)
- [Usage](#usage)
- [Authentication](#authentication)
- [Contributing](CONTRIBUTING.md)
- [Authors](#authors)
- [Acknowledgments](#acknowledgement)
Getting started with `apkup` is pretty easy and straight forward.
Install the `apkup` package globally or locally:
```bash
npm i -g apkup
apkup --help
# or if you just want to use the CLI locally
npx apkup --help
# or install the library into your project
npm i -D apkup
```
### CLI
Then use the CLI:
```bash
apkup \
--key api.json \
--apk /path/to/Package.apk \
--deobfuscation /path/to/mapping.txt \ # optional
--release-notes "en-US=lorem ipsum dolor" \
--obbs /path/to/Expansion.obb \ # optional
--obbs /path/to/Expansion2.obb # optional
```
You can also specify each parameter via environment variables prefixed with `APKUP_` (e.g. `APKUP_KEY` or `APKUP_APK`).
### Library
Or use the JavaScript library!
```javascript
// typescript / modulejs
import { Apkup } = from 'apkup';
// or commonjs
const { Apkup } = require('apkup');
const apkup = new Apkup({
client_email: '',
private_key: ''
});
apkup
.upload('/path/to/apk', {
obbs: [
// optional expansion files (max 2)
'/path/to/somefile.obb'
],
releaseNotes: [
{
language: 'en-US',
text: 'Minor bug fixes...'
}
]
})
.then(data => {
console.log(` > ${data.packageName} version ${data.versionCode} is up!`);
});
```
First you have to create a Google Play API Access. To do that go to the
[Google Play Developer Console](https://play.google.com/apps/publish) and then
with the account owner go to Settings -> API access and create a Google Play
Android Developer project.
After that follow the instructions to create a Service Account.
When you click Create Client ID, choose Service Account. You will get a JSON file
with a public key and the service email.
The created Service Account needs the following role:
- Release manager
See the full docs [here](https://oss.eventone.page/apkup/classes/index.apkup).
- [@nprail](https://github.com/nprail) - Maintainer
See also the list of [contributors](https://github.com/eventOneHQ/apkup/contributors) who participated in this project.
- The original project, [playup](https://github.com/jeduan/playup)!
- Hat tip to anyone whose code was used