https://github.com/numerous-com/numerous-sdk
Numerous SDK and CLI. Use the SDK for integrating your Python apps with Numerous so you can share them with users and use the features of the Numerous platform.
https://github.com/numerous-com/numerous-sdk
apps cloud-computing paas python saas saas-api sdk sdk-python
Last synced: about 2 months ago
JSON representation
Numerous SDK and CLI. Use the SDK for integrating your Python apps with Numerous so you can share them with users and use the features of the Numerous platform.
- Host: GitHub
- URL: https://github.com/numerous-com/numerous-sdk
- Owner: numerous-com
- Created: 2024-04-12T11:55:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T09:51:44.000Z (7 months ago)
- Last Synced: 2024-10-29T09:53:28.496Z (7 months ago)
- Topics: apps, cloud-computing, paas, python, saas, saas-api, sdk, sdk-python
- Language: Go
- Homepage: https://www.numerous.com
- Size: 3.05 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: docs/README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Numerous Software Development Kit
[](https://pypi.python.org/pypi/numerous)
[](https://github.com/numerous-com/numerous-sdk/actions/workflows/validate.yml)
[](https://github.com/numerous-com/numerous-sdk/actions/workflows/release.yml)
Welcome to the Numerous Developer Documentation page!
This is the documentation for the Numerous SDK. If you are looking an overview of the
Numerous platform, please visit the
[Numerous platform documentation](https://numerous.com/docs).
📥 To begin, 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 your apps
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
## Python SDK package: Integrate Numerous features into Python-based web apps
The SDK enables you to interact with Numerous services programmatically in
your Python web applications.
- Store and organize data (JSON documents, and files) with collections.
- Access information about users and manage user interaction with sessions.
# SDK Development
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.
To setup pre-commit hooks, use [pre-commit](https://pre-commit.com/)
to setup hooks for linters and tests. This requires pre-commit to be installed 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
## Development of Python SDK 🐍
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
## Development of Go CLI 🐹
To build, run `make cli-build`. 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