hopeit.engine
Docs: https://hopeitengine.readthedocs.io/en/latest/
Engine development README
Install locally for apps or plugins development:
- Install uv
- Run from hopeit.engine project root
make dev
- Now everything you need is installed in .venv/
- Then you can create your apps or plugins and run the server
Install from Python Package Index
Install core hopeit.engine lib:
pip install "hopeit.engine"
Configure
- Create server configuration json file
- Create apps configuration and python files
- See apps examples
- Optionally you can develop plugins, similar to apps but can be shared
- See available plugins
Start http server
- Example starting a single app/microservice
python -m hopeit.server.web --config-files=server-config.json,app-folder/config/app-config.json
- Additional options:
--config-files: comma-separated file of config files to load, starting with server config, then plugins, then apps
--api-file: path to openapi complaint json specification
--host: server host address or name, default is --host=0.0.0.0
--port: indicates to listen on another port number, default is --port=8020
--path: indicates to listen in a unix socket path, default is disabled
--start-streams: indicates to automatically start events of type STREAM when starting server
- Example starting a single app that depends on plugins:
python engine/server/web.py --config-files=server-config.json,plugin-folder/config/plugin-config.json,app-folder/config/app-config.json
Tools for Engine Development
- To install development dependencies, from engine folder run:
make dev
- To run tests
make test
- To fromat code
make format
- To run static code checks (types, style)
make lint
- To create distribution library (hopeit.engine)
make dist
1 maintainer
Metadata
1 maintainer
Release files for hopeit.engine 0.30.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| hopeit_engine-0.30.1.tar.gz | 77.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hopeit_engine-0.30.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 168.5 kB
Release files / hopeit_engine-0.30.1.tar.gz
| Download URL | hopeit_engine-0.30.1.tar.gz |
|---|---|
| Size | 77.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
08fe262107fba26ea0c9527f9fb63ff04774449d41a18a090c2dd8066c438c8b
|
|
BLAKE2b-256 checksum How to use checksums |
3949e19228d1aeef84327939bb7ef861194623a0f8fb6a20b7a2f531d2134f37
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / hopeit_engine-0.30.1-py3-none-any.whl
| Download URL | hopeit_engine-0.30.1-py3-none-any.whl |
|---|---|
| Size | 91.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
28d71bba213869403dbbc6730bafccd6363a88e3b47853d834c507524aacc5bb
|
|
BLAKE2b-256 checksum How to use checksums |
d4c8a944b6f6ffbfa42bb89917369cf3f36abc01e4dd17320285db6847119e39
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
