Deepak Mallubhotla
12e6916ab2
All checks were successful
gitea-physics/deepdog/pipeline/head This commit looks good
26 lines
1.8 KiB
Markdown
26 lines
1.8 KiB
Markdown
# deepdog
|
|
|
|
[](https://conventionalcommits.org)
|
|
[](https://pypi.org/project/deepdog/)
|
|
[](https://jenkins.deepak.science/job/gitea-physics/job/deepdog/job/master/)
|
|
|
|
|
|
|
|
|
|
The DiPole DiaGnostic tool.
|
|
|
|
## Getting started
|
|
|
|
`poetry install` to start locally
|
|
|
|
Commit using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), and when commits are on master, release with `just release`.
|
|
|
|
In general `just --list` has some of the useful stuff for figuring out what development tools there are.
|
|
|
|
Poetry as an installer is good, even better is using Nix (maybe with direnv to automatically pick up the `devShell` from `flake.nix`).
|
|
In either case `just` should handle actually calling things in a way that's agnostic to poetry as a runner or through nix.
|
|
|
|
### local scripts
|
|
`local_scripts` folder allows for scripts to be run using this code, but that probably isn't the most auditable for actual usage.
|
|
The API is still only something I'm using so there's no guarantees yet that it will be stable; overall semantic versioning should help with API breaks.
|