├── README.md ├── run.sh ├── LICENSE ├── main.py └── .gitignore /README.md: -------------------------------------------------------------------------------- 1 | # DatasetLoader -------------------------------------------------------------------------------- /run.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | set -e 4 | 5 | if [ ! -d .venv ]; then 6 | uv venv 7 | fi 8 | 9 | . .venv/bin/activate 10 | 11 | uv pip install --upgrade syftbox 12 | 13 | echo "Running 'fl_aggregator' with $(python3 --version) at '$(which python3)'" 14 | python3 main.py 15 | 16 | deactivate 17 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2024 OpenMined 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | import os 2 | import json 3 | import time 4 | from syftbox.lib import Client, SyftPermission 5 | from pathlib import Path 6 | 7 | 8 | def gather_file_information(directory_path): 9 | """ 10 | Gathers information about files in a given directory. 11 | 12 | Parameters: 13 | directory_path (str): The path of the directory to inspect. 14 | 15 | Returns: 16 | dict: A dictionary where each key is a filename and each value is 17 | a dictionary containing the file's size and creation time. 18 | """ 19 | files_info = {} 20 | 21 | files = [str(file) for file in Path(directory_path).rglob('*') if file.is_file()] 22 | 23 | # Iterate over all items in the given directory 24 | for item_path in files: 25 | # Check if the item is a file 26 | if os.path.isfile(item_path) and "syftperm" not in item_path: 27 | # Gather file information 28 | file_size = os.path.getsize(item_path) 29 | creation_time = os.path.getctime(item_path) 30 | 31 | # Convert timestamp to a human-readable format 32 | # If you prefer the raw timestamp, you can skip this step. 33 | creation_date_str = time.strftime( 34 | "%Y-%m-%d %H:%M:%S", time.localtime(creation_time) 35 | ) 36 | 37 | file_size = round(file_size / 1024, 2) 38 | item_name = item_path.split("/")[-1] 39 | # Add the file info to the dictionary 40 | files_info[item_name] = {"size": file_size, "created": creation_date_str} 41 | 42 | print(files_info) 43 | return files_info 44 | 45 | 46 | def save_to_json(data, output_path): 47 | """ 48 | Saves the given data as a JSON file to the specified path. 49 | 50 | Parameters: 51 | data (dict): The data to be saved as JSON. 52 | output_path (str): The path where the JSON file will be saved. 53 | """ 54 | # Ensure the output directory exists 55 | os.makedirs(os.path.dirname(output_path), exist_ok=True) 56 | 57 | with open(output_path, "w", encoding="utf-8") as f: 58 | json.dump(data, f, indent=4, ensure_ascii=False) 59 | 60 | 61 | def get_app_private_data(client: Client) -> Path: 62 | """ 63 | Returns the private data directory of the app 64 | """ 65 | return client.workspace.data_dir / "private" 66 | 67 | 68 | def main(): 69 | client = Client.load() 70 | 71 | # Create the data loader private folder 72 | dataset_private_folder = get_app_private_data(client) 73 | os.makedirs(dataset_private_folder, exist_ok=True) 74 | 75 | data_loader = client.api_data("data_loader") 76 | 77 | if not data_loader.exists(): 78 | os.makedirs(data_loader, exist_ok=True) 79 | 80 | # Set permissions for the api_data/data_loader to be visible to everyone 81 | permissions = SyftPermission.datasite_default(email=client.email) 82 | permissions.read.append("GLOBAL") 83 | permissions.save(data_loader) 84 | 85 | output_path = data_loader / "datasets.json" 86 | 87 | file_data = gather_file_information(dataset_private_folder) 88 | final_data = {"datasets": file_data, "owner": client.email} 89 | save_to_json(final_data, output_path) 90 | print(f"File information has been saved to {output_path}") 91 | 92 | 93 | if __name__ == "__main__": 94 | main() 95 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/latest/usage/project/#working-with-version-control 110 | .pdm.toml 111 | .pdm-python 112 | .pdm-build/ 113 | 114 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 115 | __pypackages__/ 116 | 117 | # Celery stuff 118 | celerybeat-schedule 119 | celerybeat.pid 120 | 121 | # SageMath parsed files 122 | *.sage.py 123 | 124 | # Environments 125 | .env 126 | .venv 127 | env/ 128 | venv/ 129 | ENV/ 130 | env.bak/ 131 | venv.bak/ 132 | 133 | # Spyder project settings 134 | .spyderproject 135 | .spyproject 136 | 137 | # Rope project settings 138 | .ropeproject 139 | 140 | # mkdocs documentation 141 | /site 142 | 143 | # mypy 144 | .mypy_cache/ 145 | .dmypy.json 146 | dmypy.json 147 | 148 | # Pyre type checker 149 | .pyre/ 150 | 151 | # pytype static type analyzer 152 | .pytype/ 153 | 154 | # Cython debug symbols 155 | cython_debug/ 156 | 157 | # PyCharm 158 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 159 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 160 | # and can be added to the global gitignore or merged into this file. For a more nuclear 161 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 162 | #.idea/ 163 | --------------------------------------------------------------------------------