Python-SDK

LeanCloud Python SDK

Install

pip install leancloud

or

easy_install leancloud

Maybe you need the sudo prefix depends on your OS environment.

Supported Python Versions

Python 2.7 and Python 3.5+.

Generate API document

Install dependencies:

pip install Sphinx
pip install sphinx_rtd_theme

cd apidoc
make html

Run Tests

Configure the following environment variables:

• APP_ID
• APP_KEY
• MASTER_KEY
• USE_REGION

Install dependencies:

pip install -e .'[test]'

Run tests:

python -m nose

Run a single test without swallowing print:

python -m nose -v --nocapture tests/test_engine.py:test_lean_engine_error

Linter and Formatter

Currently, flake8 (linter) and black (formatter) are used. But we are still exploring.

Release a New Version

0. Edit changelog and setup.py (version).
1. Generate api doc and commit updates.
2. Commit them and send a pull request.
3. The maintainer will review and merge the pull request, then create a new release at GitHub web UI.
4. A new version of the package will be published to PyPI automatically (via GitHub Actions).

License

License: GNU LGPL.

Author: asaka ([email protected])