Metadata-Version: 2.1
Name: scilaunch
Version: 0.1.1
Summary: A tiny program for you, seting up the ground for grand discoveries. (2023)
Author-email: "Simon M. Hofmann" <simon.hofmann@pm.me>
Maintainer-email: "Simon M. Hofmann" <simon.hofmann@pm.me>
License: BSD License
        
        Copyright (c) 2023, Simon M. Hofmann
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without modification,
        are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice, this
          list of conditions and the following disclaimer in the documentation and/or
          other materials provided with the distribution.
        
        * Neither the name of the copyright holder nor the names of its
          contributors may be used to endorse or promote products derived from this
          software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
        IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
        INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
        BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
        DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
        OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
        OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
        OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: GitHub, https://github.com/SHEscher/scilaunch
Keywords: template,BIDS,reproducibilty,standardization
Platform: unix
Platform: linux
Platform: osx
Platform: cygwin
Platform: win32
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: cookiecutter<3.0,>=2.2.0
Requires-Dist: GitPython<4.0,>=3.1
Requires-Dist: python-box<8.0,>=7.0
Provides-Extra: develop
Requires-Dist: black>=23.9; extra == "develop"
Requires-Dist: ruff>=0.0.292; extra == "develop"
Requires-Dist: tox>=4.11; extra == "develop"
Requires-Dist: pytest>=7.2; extra == "develop"
Requires-Dist: pytest-cov; extra == "develop"

# scilaunch

A tiny program for you that lays the foundation for great discoveries.

![scilaunch](scilaunch_logo.png)

![License](https://img.shields.io/badge/license-BSD-blue.svg)
![Python](https://img.shields.io/badge/python->=3.8-blue.svg)
![Environment](https://github.com/SHEscher/scilaunch/actions/workflows/tests.yaml/badge.svg)

`[Last update 2023-10-06 | v.0.1.1]`

## Description

`scilaunch` helps you to set up your research project:

1. create a canonical directory structure tailored for research projects

2. for python users it offers to set up a `conda` environment

3. it prepares your research code as `python` package ready for `import`

4. and `scilaunch` can init your `git` repository

---

The project structure can be populated with other programming languages (`R`, `matlab`, etc.) as well.

`scilaunch` is a wrapper around the great [`cookiecutter`](https://github.com/cookiecutter/cookiecutter) package and is mainly build around this template: [research-project](https://github.com/SHEscher/research-project).

## Getting started

### Install `scilaunch`

Ideally install `scilaunch` into your global/base `python` environment, which should be `python>=3.8`.

Install from PyPI:
```shell
pip install -U scilaunch
```

Alternatively, install from the GitHub repo:
```shell
pip install -U git+https://github.com/SHEscher/scilaunch.git
```

It is also recommended to have [`conda`](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html) installed.

### Run `scilaunch`

Simply run `scilaunch` via the command line:

```shell
scilaunch PARENT/DIR/OF/YOUR/RESEARCH/PROJECT
# OR cd into the parent dir and just run `scilaunch`
```

Then, you will be asked to provide some information relevant to your project.


When running `scilaunch` the first time, you will set some default values, which will ease your life for upcoming launches of research projects.

You can still change these default values in `~/.cookiecutterrc` at a later stage.

## Cookiecutter templates

You can also fork / adopt the underlying `research-project` template for `scilaunch` from here: https://github.com/SHEscher/research-project. This template works also directly with `cookiecutter`.

To build your own templates, check out the `cookiecutter` [docs](https://cookiecutter.readthedocs.io/en/stable/index.html#).

Here you can find also more information on the `~/.cookiecutterrc`

## TODO's

- [ ] allow to pass other `cookiecutter` templates
- [ ] add proper docs
- [ ] add files in `/.github/ISSUE_TEMPLATE/`
- [ ] add `CONTRIBUTING.md`
