AqueductHub / aqueductcore

Aqueduct Core is responsible for the core functionality of Aqueduct, an experiment management system.
https://aqueducthub.github.io/aqueductcore/
MIT License
24 stars 3 forks source link

feat(docs): Add documentation for Aqueduct CLI with import/export functionality #137

Closed samiralavi closed 3 months ago

samiralavi commented 4 months ago

This PR adds documentation for Aqueduct CLI with import/export functionality. Also, in this PR, I have enabled the github action to provide PR review for the docs using the Azure instance.

github-actions[bot] commented 4 months ago

Coverage

Coverage Report
FileStmtsMissCoverMissing
aqueductcore/backend
   context.py33488%48–52, 59–60
   main.py19479%21–24, 31
   session.py13469%24–28
aqueductcore/backend/models
   orm.py31197%58
   plugin.py1511491%53, 56, 80–81, 88, 94, 96–97, 175, 217, 221, 246, 252, 260
aqueductcore/backend/routers
   files.py88298%165–166
   frontend.py241154%22–33, 37
aqueductcore/backend/routers/graphql
   mutations_schema.py57296%44, 130
   query_schema.py45296%66–68
   router.py11191%15
aqueductcore/backend/routers/graphql/mutations
   experiment_mutations.py24196%30
aqueductcore/backend/routers/graphql/resolvers
   experiment_resolver.py25292%28, 36
   tags_resolver.py25388%14, 44, 46
aqueductcore/backend/services
   experiment.py2203285%82, 111–124, 154, 188, 194, 240, 243, 268, 300, 348, 354, 383, 389, 406, 431, 438, 446, 476–482, 489–493, 505–508
   plugin_executor.py881188%38–39, 45–46, 62, 77, 80, 101, 146–152, 200
   validators.py33294%41, 46
aqueductcore/cli
   commands.py60788%32, 82–85, 94–98, 110–114
   exporter.py49198%71
   importer.py61198%90
TOTAL135010592% 

Tests Skipped Failures Errors Time
101 1 :zzz: 0 :x: 0 :fire: 26.264s :stopwatch:
github-actions[bot] commented 4 months ago

Azure Static Web Apps: Your stage site is ready! Visit it here: https://black-sand-0b0e2a903-137.westeurope.3.azurestaticapps.net

github-actions[bot] commented 3 months ago

Azure Static Web Apps: Your stage site is ready! Visit it here: https://black-sand-0b0e2a903-137.westeurope.3.azurestaticapps.net