Welcome to the Numerous SDK documentation!
This is the documentation for the SDK, if you are looking an overview of the Numerous platform, please visit the Numerous platform documentation.
📥 To begin, simply install the SDK into your python environment with:
pip install numerous
🛠 The installation includes two main components; the CLI and the numerous Python package.
Command Line Interface (CLI) - A tool for managing Numerous apps on the platform:
Use the CLI to deploy and manage apps on the Numerous platform:
-
numerous init- Create a new Numerous app -
numerous deploy- Deploy your app to production
The numerous Python package - A Python package for integrating Numerous features in Python-based web apps:
The SDK enables you to interact with Numerous services programmatically in your Python web applications, such as collections for storing data, sessions for managing user interactions, and users for identifying and managing users.
Bagdes:
This section contains information about how to develop the SDK itself for developers interested in contributing to the SDK.
Most common tasks are defined in the Makefile. Use make help to get an
overview.
In order to setup pre-commit hooks, use pre-commit to to setup hooks for linters and tests. This requires pre-commit to be installed of course, and it is included in the python SDK development dependencies.
To install pre-commit and pre-push hooks
pre-commit install
And you can run them on demand
pre-commit run --all
Create a virtual environment and activate it
python -m venv ./venv
./venv/bin/activate
Install the package in editable mode (including development dependencies)
pip install -e ./python[dev]
Run the tests
make sdk-test
And the linters
make sdk-lint
The numerous CLI enables app development.
To build simply run make cli-build, and the executable is stored
as build/numerous
While developing you can run the CLI like below.
# Run the CLI
go run .
# e.g.
go run . init
go run . dev
You can lint with:
make cli-lint
And you can run tests with
make cli-test