Client library for easy scripting against Modelon Impact
For installation instructions and requirements, please refer to the documentation.
If you are developing with VS Code you can use the devcontainer which gives gives you a ready to use environment for development. Just click the "Reopen in Container" button after opening the project in VS Code.
It is possible to run the 'make' commands listed bellow using the devcontainer. It will detect being in a container and bypass Docker parts of the commands.
You can open a project with the dev-container directly without having to open and then re-load. Standing in the project directory you can run:
devcontainer open .
Note that this requires the devcontainer-cli.
You can add your own extensions to devcontainers. These extensions will be added for all devcontainers. First open your 'settings' as JSON. Then, to add for example the "GitLens" extension, put the following at the bottom of the settings:
...
"remote.containers.defaultExtensions": ["eamodio.gitlens"]
}
VS Code also have a 'Install Local Extensions in 'Remote'
command, but it must be repeated for each devcontainer and everytime a devcontainer is re-built.
Modelon-impact-client is developed using a Docker container for all build tools. You can get a shell into said container by running:
make shell
Dependencies are managed by poetry. Add dependencies by running
poetry add <package>
or poetry add <package> --dev
inside the shell
Tests are executed by running make test
. You can also run make test-watch
to get a watcher
that continuously re-runs the tests.
make lint
Building modelon-impact-client is done by running
make wheel
The modelon-impact-client build process is a fully automated using Semantic-release
.
Automation is enabled for:
- Bumping version
- Generate changelog
This is done based on git commit semantics as described here: https://semantic-release.gitbook.io/semantic-release/
To make a new release simply run:
make publish
This command will detect what branch you are on and your git history and make a appropriate release.
Current configuration can be found in .releaserc
and specifies that commits to branch master
should be released and
commits to branch beta
should be released as a pre-release
.
This workflow make sure that no administrative time needs to be put into managing the release workflow.