https://github.com/Sage-Bionetworks/synapseformation

Client for using Synapse Formation templates.
https://github.com/Sage-Bionetworks/synapseformation

Last synced: about 1 month ago
JSON representation

Client for using Synapse Formation templates.

• Host: GitHub
• URL: https://github.com/Sage-Bionetworks/synapseformation
• Owner: Sage-Bionetworks
• License: apache-2.0
• Created: 2020-02-15T00:16:28.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-10-03T03:52:57.000Z (over 1 year ago)
• Last Synced: 2024-05-13T10:21:49.352Z (about 1 year ago)
• Language: Python
• Size: 268 KB
• Stars: 5
• Watchers: 5
• Forks: 4
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-synapse - synapseformation - Client for using [Synapse Formation templates](https://github.com/Sage-Bionetworks/synapse-formation-templates). (Python / Shiny)

README

        
# synapseformation

[![Get synapseformation from PyPI](https://img.shields.io/pypi/v/synapseformation.svg?style=for-the-badge&logo=pypi)](https://pypi.python.org/pypi/synapseformation) [![GitHub CI](https://img.shields.io/github/workflow/status/Sage-Bionetworks/synapseformation/build.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/Sage-Bionetworks/synapseformation)

[![Coverage Status](https://img.shields.io/coveralls/github/Sage-Bionetworks/synapseformation.svg?&style=for-the-badge&label=coverage&logo=Coveralls)](https://coveralls.io/github/Sage-Bionetworks/synapseformation)

Client for using [Synapse Formation Templates](templates). Given one of these templates, `synapseformation` will be able to create all the components required in a Synapse Project.  Currently the implementation does one of these two scenarios.

* Only creates new entities, will fail if entity already exists.

* Create entities that don't exist and gets the entity if it already exists, but does not update an entity.

## Usage

### Command Line

`synapseformation` has a command line client that will create resources given a `yaml` or `json` template.

```bash

synapseformation create --help

Usage: synapseformation create [OPTIONS]

  Creates Synapse Resources

Options:

  --template_path PATH  Template path

  --help                Show this message and exit.

```

### Python

These are some of the lower level functions that exist in the package.

```

import synapseclient

from synapseformation import create

syn = synapseclient.login()

# Only create entities

CreateCls = create.SynapseCreation(syn)

# Only retrieve entities (don't update)

RetrieveCls = create.SynapseCreation(syn, only_get=True)

```

## Contributing

Please view our [contributing guide](CONTRIBUTING.md)