Metadata-Version: 2.1
Name: pyprec
Version: 1.0.0
Summary: Python Package Repository Creator
Home-page: https://github.com/marcorossi5/pyprec.git
Author: M. Rossi
Author-email: marco.rossi@cern.ch
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Provides-Extra: docs
License-File: LICENSE

# PyPReC: Python Package Repository Creator

[![DOI](https://zenodo.org/badge/501281838.svg)](https://zenodo.org/badge/latestdoi/501281838)

This package automates the process of repository creation for Python packages.

## Installation

The package can be installed with Python's pip package manager.

```bash
pip install pyprec
```

Or manually:

```bash
git clone https://github.com/marcorossi5/pyprec.git
cd pyprec
pip install .
```

The last command installs the `pyprec` program into the environment python path.

## Running the code

Package help message:

```bash
$ bash --help
usage: pyprec [-h] [-r RUNCARD] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}]

optional arguments:
  -h, --help            show this help message and exit
  -r RUNCARD, --runcard RUNCARD
                        The settings runcard file.
  -l {DEBUG,INFO,WARNING,ERROR,CRITICAL}
                        set logging level
```

If a runcard is specified, settings are loaded from it. Please, find a default
runcard [here](./cards/default_runcard.yaml).

If no runcard is given by the user, the interactive mode is triggered: answer
the prompted questions to proceed.

:warning: **Note:**  
Both modes require that the `prefix_folder` does not contain any `src` folder
inside. This is needed to ensure a clean workspace and avoid unintentional file
deletion.
