Skip to content

marcorossi5/pyprec

Repository files navigation

PyPReC: Python Package Repository Creator

DOI

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

Documentation

The documentation for pyprec can be consulted in the readthedocs page: pyprec.readthedocs.io.

Installation

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

pip install pyprec

Or manually:

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 --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.

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

⚠️ 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.