Build native mobile apps in python
Project description
# enaml-native-cli
Cli for [enaml-native](https://github.com/codelv/enaml-native). This is for the new build system
which allows more modular app builds.
This is used to:
1. create new apps
2. install and remove app packages and dependencies
3. build and run your apps
Includes customized versions of python-for-android and python-for-ios (kivy-ios).
### Installation
Install via pip:
```bash
pip install enaml-native-cli
```
### Usage
Start a new enaml-native project
```bash
enaml-native init <AppName> <bundle.id> <dest/folder>
```
Once done, cd to the app folder and activate the app's virtual environment.
```bash
cd apps/MyApp
source venv/bin/activate
```
Now install any app requirements (or use `pip install` and `enaml-native link`)
```bash
enaml-native install <package>
```
List apps requirements (or use pip list)
```bash
enaml-native list
```
Build and run your app
```bash
enaml-native build-python
enaml-native build-android
enaml-native build-python # Yes you must do it twice
enaml-native run-android
```
### Creating an Enaml Package
The `enaml-native-cli` was designed to be as configurable as
possible without over complicating the code. A package is simply a regular
python package that typically includes android and ios resources as `data_files`.
Enaml packages are customizable using setuptool's `entry_points`. The following
entry points are supported:
1. `p4a_recipe` - Entry point that installs a python-for-android recipe. See the p4a docs for examples.
2. `enaml_native_post_install` - Entry point that defines a function that is called when a user runs `enaml-native install <your-package>`
3. `enaml_native_linker` - Entry point that defines a function that is called to link your package to the user's android and ios projects.
4. `enaml_native_unlinker` - Entry point that defines a function that is called to unlink your package from the user's android and ios projects.
5. `enaml_native_pre_uninstall` - Entry point that defines a function that is called when a user runs `enaml-native uninstall <your-package>`
All of these are optional. Search the `enaml-native` script commands for where exactly they are called.
### Adding commands to the CLI
Commands can be added by using the `enaml_native_command` entry point.
The entry point must return a subclass (NOT an instance) of the `Command` class.
This command will be added to the cli and can be accessed from the context (via `ctx.cmds['cmd-name']`)
whenever your package is installed.
Cli for [enaml-native](https://github.com/codelv/enaml-native). This is for the new build system
which allows more modular app builds.
This is used to:
1. create new apps
2. install and remove app packages and dependencies
3. build and run your apps
Includes customized versions of python-for-android and python-for-ios (kivy-ios).
### Installation
Install via pip:
```bash
pip install enaml-native-cli
```
### Usage
Start a new enaml-native project
```bash
enaml-native init <AppName> <bundle.id> <dest/folder>
```
Once done, cd to the app folder and activate the app's virtual environment.
```bash
cd apps/MyApp
source venv/bin/activate
```
Now install any app requirements (or use `pip install` and `enaml-native link`)
```bash
enaml-native install <package>
```
List apps requirements (or use pip list)
```bash
enaml-native list
```
Build and run your app
```bash
enaml-native build-python
enaml-native build-android
enaml-native build-python # Yes you must do it twice
enaml-native run-android
```
### Creating an Enaml Package
The `enaml-native-cli` was designed to be as configurable as
possible without over complicating the code. A package is simply a regular
python package that typically includes android and ios resources as `data_files`.
Enaml packages are customizable using setuptool's `entry_points`. The following
entry points are supported:
1. `p4a_recipe` - Entry point that installs a python-for-android recipe. See the p4a docs for examples.
2. `enaml_native_post_install` - Entry point that defines a function that is called when a user runs `enaml-native install <your-package>`
3. `enaml_native_linker` - Entry point that defines a function that is called to link your package to the user's android and ios projects.
4. `enaml_native_unlinker` - Entry point that defines a function that is called to unlink your package from the user's android and ios projects.
5. `enaml_native_pre_uninstall` - Entry point that defines a function that is called when a user runs `enaml-native uninstall <your-package>`
All of these are optional. Search the `enaml-native` script commands for where exactly they are called.
### Adding commands to the CLI
Commands can be added by using the `enaml_native_command` entry point.
The entry point must return a subclass (NOT an instance) of the `Command` class.
This command will be added to the cli and can be accessed from the context (via `ctx.cmds['cmd-name']`)
whenever your package is installed.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
enaml_native_cli-1.0-py2-none-any.whl
(881.9 kB
view hashes)
Close
Hashes for enaml_native_cli-1.0-py2-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f9ce21c6778f878d010ff864f11ffc8a238320e2635ae87b3dc2e812d73f579e |
|
| MD5 | f867f9dde4aaadeedf13e8d602b10c65 |
|
| BLAKE2b-256 | 139389be2e8444de83a83454814d1b663b892f5c4e2ebc7baac589558a9a8944 |
