This guide introduces you to the
landingai development process and provides information on writing, testing, and building the
Read this guide if you need to perform any of the following tasks:
- Install the
- Contribute to the
landingai Library Locally
Prerequisite: Install Poetry
Poetryfor packaging and dependency management. If you want to build it from source, you have to install Poetry first. To see all possible options, refer to the Poetry documentation.
For Linux, macOS, Windows (WSL):
Note: You can switch to use a different Python version by specifying the python version:
Or run the following command after installing Poetry:
Install All Dependencies
Activate the virtualenv
Test and Lint
The CI and CD pipelines are defined in the
Every git commit will trigger a release to
PyPi at https://pypi.org/project/landingai/
When we release a new library version, we version it using Semantic Versioning 2.0.0(
MAJOR.MINOR.PATCH). The version number is defined in the
pyproject.toml file in the
As a general rule of thumb, given a version number
MAJOR.MINOR.PATCH, increment the:
MAJORversion when you make incompatible API changes.
MINORversion when you add functionality in a backward-compatible manner, such as adding a new feature.
PATCHversion when you make backward-compatible bug fixes and minor changes.
Note: The CD pipeline will automatically increment the
PATCH version for every git commit.
MAJOR version change, you need to manually update
pyproject.toml to bump the version number.