Metadata-Version: 2.1
Name: sfkit
Version: 0.0.96
Summary: Some CLI Tools For The Secure Multi-party Genomic Analysis Website
Project-URL: Website, https://secure-gwas-website-bhj5a4wkqa-uc.a.run.app/
Project-URL: Github, https://github.com/simonjmendelsohn/secure-gwas-keys-and-encryption
Author-email: Simon Mendelsohn <smendels@broadinstitute.org>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9.2
Requires-Dist: black
Requires-Dist: checksumdir
Requires-Dist: google-auth
Requires-Dist: ipaddr
Requires-Dist: pynacl
Requires-Dist: requests
Requires-Dist: toml
Requires-Dist: tqdm
Description-Content-Type: text/markdown

## sfkit

`sfkit` is a collection of CLI tools to help run certain types of secure multi-party computation on genomic data. It is a companion to the website [here](https://secure-gwas-website-bhj5a4wkqa-uc.a.run.app/).

## Documentation

You can read the full documentation [here](https://sfkit.readthedocs.io/en/latest/).

## Prerequisites

[python3](https://www.python.org/downloads/)

## Installation

`pip install sfkit`

## Usage

Usage: sfkit <auth | setup_networking | generate_personal_keys | register_data | run_protocol>

- auth: Authenticate with the CLI.
- set_study (deprecated): Set the study you are using.
- setup_networking: Setup the networking, including your IP address and any relevant ports.
- generate_personal_keys: Generate your public and private cryptographic keys for use in encrypting the data.
- register_data: Register and validate your data.
- run_protocol: Run the protocol. As this command may be long-running, it is recommended that you run it using nohup. This will prevent it from terminating if you close this window/terminal. For example, `nohup sfkit run_protocol & tail -f nohup.out`. You can also use a tool like screen or tmux.

### Questions

If you have questions or concerns, you can reach me at [smendels@broadinstitute.org](mailto:smendels@broadinstitute.org).
