Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(system): Added new method to save the system to a given folder. #23

Merged
merged 7 commits into from
Jun 5, 2024

Conversation

pesap
Copy link
Collaborator

@pesap pesap commented May 1, 2024

List of changes:

  • Created a new method .save that saves all the content of the system
    (.json + time series) to a desired folder,
  • Save method can archive the folder to enable easy sharing of the
    system,
  • Added testing to validate that save in fact creates the folder and
    that when we zip it we delete that folder.
  • Added howto section that explains the method.

Closes #10

@pesap pesap added the enhancement New feature or request label May 1, 2024
@pesap pesap self-assigned this May 1, 2024
@pesap pesap requested a review from daniel-thom May 1, 2024 02:54
@codecov-commenter
Copy link

codecov-commenter commented May 1, 2024

Codecov Report

Attention: Patch coverage is 97.43590% with 1 line in your changes missing coverage. Please review.

Project coverage is 96.05%. Comparing base (bd1ab2e) to head (589eaee).

Files Patch % Lines
src/infrasys/system.py 93.33% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #23      +/-   ##
==========================================
+ Coverage   96.02%   96.05%   +0.02%     
==========================================
  Files          25       25              
  Lines        2166     2205      +39     
==========================================
+ Hits         2080     2118      +38     
- Misses         86       87       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

docs/how_tos/save_system.md Outdated Show resolved Hide resolved
docs/how_tos/save_system.md Outdated Show resolved Hide resolved
src/infrasys/system.py Outdated Show resolved Hide resolved
src/infrasys/system.py Show resolved Hide resolved
src/infrasys/system.py Show resolved Hide resolved
pesap added 2 commits June 5, 2024 12:11
List of changes:
- Created a new method `.save` that saves all the content of the system
  (.json + time series) to a desired folder,
- Save method can archive the folder to enable easy sharing of the
  system,
- Added testing to validate that save in fact creates the folder and
  that when we zip it we delete that folder.

Closes #10
@pesap
Copy link
Collaborator Author

pesap commented Jun 5, 2024

@daniel-thom ready for re-review

docs/how_tos/save_system.md Outdated Show resolved Hide resolved
src/infrasys/system.py Outdated Show resolved Hide resolved
src/infrasys/system.py Outdated Show resolved Hide resolved
src/infrasys/system.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@daniel-thom daniel-thom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@pesap pesap merged commit 3570237 into main Jun 5, 2024
6 checks passed
@pesap pesap deleted the ps/save branch June 5, 2024 20:18
github-actions bot pushed a commit that referenced this pull request Jun 5, 2024
…23)

List of changes:
- Created a new method `.save` that saves all the content of the system
  (.json + time series) to a desired folder,
- Save method can archive the folder to enable easy sharing of the
  system,
- Added testing to validate that save in fact creates the folder and
  that when we zip it we delete that folder.
- Closed backup connection from `time_series_metadata`

Closes #10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create save command
3 participants