https://github.com/aanastasiou/yapltemp

YASARA Plugin cookiecutter template.
https://github.com/aanastasiou/yapltemp

bioinformatics cookiecutter-datascience cookiecutter-python cookiecutter-template plugin python3

Last synced: 16 days ago
JSON representation

YASARA Plugin cookiecutter template.

• Host: GitHub
• URL: https://github.com/aanastasiou/yapltemp
• Owner: aanastasiou
• License: apache-2.0
• Created: 2021-12-11T15:34:38.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-15T12:33:12.000Z (about 3 years ago)
• Last Synced: 2024-12-11T01:34:32.648Z (23 days ago)
• Topics: bioinformatics, cookiecutter-datascience, cookiecutter-python, cookiecutter-template, plugin, python3
• Language: Batchfile
• Homepage:
• Size: 154 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# YASARA Plugin cookiecutter

A cookiecutter template to kickstart [YASARA](http://www.yasara.org/) plugin development.

![frontpage](https://raw.githubusercontent.com/aanastasiou/yapltemp/main/image_frontpage.png)

It creates the basic structure of a YASARA Python plugin, complete with:

* Install / uninstall scripts for Linux and Windows 

* A basic documentation layout for your plugin using Sphinx.

The code generated by this cookiecutter template is **installable** to YASARA out of the box and 

completely functional, enabling you to focus on writing the business logic of the plugin itself.

For an example of the facilities that this template offers, please see the 

[YASARA Python Console Plugin](https://github.com/aanastasiou/yapycon).

## Requirements

To use this template, make sure that you have a Python environment with cookiecutter installed.

```

    > pip install cookiecutter

```

For more details about cookiecutter please see [here](https://github.com/cookiecutter/cookiecutter).

## Usage

To create the plugin scaffold, simply run cookiecutter, grabbing the latest release from this repository:

```

    > cookiecutter https://github.com/aanastasiou/yapltemp/releases/latest/download/yapltemp.zip

```

Or, similarly, if you have git installed:

```

    > cookiecutter https://github.com/aanastasiou/yapltemp.git

```

Cookiecutter will then ask you a number of questions to customise your plugin template and generate 

the initial scaffold.