Skip to content

support downloading project archive; suppress console window#145

Merged
franknli merged 15 commits intomainfrom
fli/archive_and_download
Oct 23, 2024
Merged

support downloading project archive; suppress console window#145
franknli merged 15 commits intomainfrom
fli/archive_and_download

Conversation

@franknli
Copy link
Copy Markdown
Collaborator

No description provided.

@franknli franknli requested review from a team and PipKat as code owners October 21, 2024 21:01
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 21, 2024
@franknli franknli requested a review from asawas October 22, 2024 23:29
@Revathyvenugopal162 Revathyvenugopal162 changed the title support downloading project archive; supress console window support downloading project archive; suppress console window Oct 23, 2024
self._wmi_connection = None
self._process_id = -1

if not version:
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

why not to keep the default argument value?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

It is one of the requirements from ACE to use None as default, to be consistent with other PyAnsys products.

Comment thread doc/source/user-guide.rst Outdated
client.upload_file_from_example_repo("pymechanical-integration/agdb/two_pipes.agdb")

There is a convenience function to save the current Workbench project on the server, archive
the project, then download the project archive to the client.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
the project, then download the project archive to the client.
the project, and then download the project archive to the client.

Parameters
----------
archive_name : str
The name of the project archive to use, without the file extension.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
The name of the project archive to use, without the file extension.
Name of the project archive to use, without the file extension.

Ansys style is to omit the leading article in the brief description so that it always starts with an important word.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

That makes sense. Updated.

Whether to show a progress bar during the download.
"""
if not re.match(r"^\w+$", archive_name):
logging.error("archive name contains illegal character")
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I suggest showing a clear message of what is the acceptable file name.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Updated the message.

@franknli franknli merged commit 6f476b7 into main Oct 23, 2024
@franknli franknli deleted the fli/archive_and_download branch October 23, 2024 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants