README.md

Omni SDK

Unofficial SDK for Omni Analytics

Getting Started

For installation, configuration and usage view the docs here

Bug Reports

Submit any issues you may encounter as a GitHub issue. Please search for similar issues before submitting a new one.

Questions, Concerns, Ideas, Support, Feature Requests

All non-bug-related discussions such as support or feature requests should be submitted as a GitHub Discussion.

License

MIT licensed. See the LICENSE file for more details.

Contributing

This project follows the all-contributors specification. Contributions of any kind welcome!

Development Environment

The development environment is simple and straightforward. Dependencies are managed by Poetry and tests are run with pytest. If you would like to test any changes against a live server you can use any apps in the /examples directory.

Prerequisites:

• Python >= 3.9
• Poetry

Install dependencies.

poetry install

Run tests.

poetry run pytest

Preview documentation.

poetry run mkdocs serve

Code Style

• Code is formatted using black.
• Typing is enforced with mypy.

How should I write my commits?

This project uses release please and conventional commits for versioning releases.

Per release-please-action:

The most important prefixes you should have in mind are:

• `fix``: which represents bug fixes, and correlates to a SemVer patch.
• `feat``: which represents a new feature, and correlates to a SemVer minor.
• `feat!``:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.

Any PR with fix, feat, docs, or a conventional commit with an ! will trigger a release PR when merged.

Other conventional commits such as chore, ci, test, refactor, etc will not trigger a release but are encouraged to form a standard around conventional commits in the commit history.

Contributors

Danny Tiesling 💻

Chris Sprehe 📖 💻