Data

Tools

Indexes

Applications

Experiments

Open Source Science

remoter

MRE for remote execution of workflows.

https://github.com/valerius21/remoter

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.2%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

MRE for remote execution of workflows.

Basic Info
  • Host: GitHub
  • Owner: valerius21
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 6.84 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created 10 months ago · Last pushed 10 months ago
Metadata Files
Readme Citation

README.md

remoter

MRE for remote execution of workflows.

Installation

  1. Clone the repository: bash git clone https://github.com/valerius21/remoter.git cd remoter
  2. (Optional) Create and activate a virtual environment: bash python3 -m venv .venv source .venv/bin/activate
  3. Install dependencies: bash pip install -r requirements.txt

Usage

Run with a custom config file:

bash python -m app.main --config path/to/your_config.yml

If you omit --config, it defaults to config.yml in the project root.

Configuration

The configuration file is a YAML file specifying remotes and workflows. See config.example.yml for a template:

```yaml remotes: - host: 127.0.0.1 user: youruser password: ${YOURPASSWORDENV_VAR}

workflows: - name: echo steps: - name: echo test command: | echo "test" ```

You can use environment variables in the config by referencing them as ${VARNAME}. Set them in your shell or in a .env file.

Example Workflow

Suppose you want to run a workflow that creates and reads a file on a remote host:

yaml workflows: - name: read file steps: - name: read file command: | export FILE_NAME="test-$(date +%Y-%m-%d-%H-%M-%S).txt" echo "test" > /tmp/$FILE_NAME cat /tmp/$FILE_NAME

License

This project is licensed under the MIT License. See the LICENSE file for details.

Structure

remoter/ app/ __init__.py lib.py main.py tests/ __init__.py test_lib.py test_main.py requirements.txt README.md CITATION.cff config.example.yaml

  • app/: Main application code
  • tests/: Unit tests
  • requirements.txt: Project dependencies
  • README.md: Project documentation
  • config.example.yaml: Example configuration file

Citation

If you use this software, please cite it as below.

bibtex @software{remoter, author = {Valerius Mattfeld}, title = {remoter}, version = {0.1.0}, date = {2025-05-21}, url = {https://github.com/valerius21/remoter}, note = {If you use this software, please cite it as below.}, orcid = {https://orcid.org/0000-0003-0263-0332} }

Owner

  • Name: Valerius Mattfeld
  • Login: valerius21
  • Kind: user
  • Location: Göttingen, Germany
  • Company: @elegal-ev @ksb-intax

full-stack developer / computer science and law graduate

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Mattfeld"
  given-names: "Valerius"
  orcid: "https://orcid.org/0000-0003-0263-0332"
title: "remoter"
version: 0.1.0
date-released: 2025-05-21
url: "https://github.com/valerius21/remoter"

GitHub Events

Total
  • Push event: 2
  • Create event: 3
Last Year
  • Push event: 2
  • Create event: 3

Dependencies

requirements.txt pypi
  • PyYAML *
  • asyncssh *
  • cffi *
  • cryptography *
  • pycparser *
  • python-dotenv *
  • typing_extensions *