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

Design a FTP ingestion protocol #71

Open
Tian-Tan opened this issue Jul 11, 2024 · 3 comments
Open

Design a FTP ingestion protocol #71

Tian-Tan opened this issue Jul 11, 2024 · 3 comments
Assignees
Labels
enhancement New feature or request image

Comments

@Tian-Tan
Copy link
Collaborator

There are 2 ways to approach designing a FTP ingestion protocol:

  1. Architect a new ingestion method that takes images directly from a directory and imports them into the system. This approach will take a long time as symbiota's ingestion code is long and distributed among many classes and files. It might be hard to understand the whole structure and build a new ingestion method in a short period of time.
  2. Package the images into a dwc-Archive and use that DWCA file for ingestion. This method is preferred, as the images -> DWCA file pipeline can be built separately from the existing symbiota architecture, removing the need to build along the currently complicated ingestion code. The workflow can look like this:
  • User FTPs a batch of images into a directory
  • A script is run by a command like python3 script.py /directory -o outputFileName
  • The output file is a DWCA, which can be used with symbiota's DWCA import function

While the basic workflow will look like above, some enhancements such as

  • Adding a UI for the images -> DWCA conversion
  • Integrating the images -> DWCA pipeline into the symbiota DWCA ingestion as an option

are also possible.

@Tian-Tan Tian-Tan self-assigned this Jul 11, 2024
@Tian-Tan Tian-Tan added enhancement New feature or request image labels Jul 11, 2024
@Tian-Tan
Copy link
Collaborator Author

Tian-Tan commented Oct 7, 2024

This issue has not been updated in a while, but the 2nd option is chosen and is currently in progress.

@Tian-Tan
Copy link
Collaborator Author

Tian-Tan commented Oct 7, 2024

https://www.tdwg.org/standards/dwc/#maintenance-group%22%3E

More info on dwca is here.

@Tian-Tan
Copy link
Collaborator Author

Tian-Tan commented Oct 9, 2024

It is unclear what the user wants to do with the images after creating a DWCA with them. For now, we can try to create file links or FTP links to the local user's machine when filling the images metadata for the DWCA.

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

No branches or pull requests

1 participant