Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.04 KB

README.md

File metadata and controls

46 lines (30 loc) · 1.04 KB

Compy

Compy is a tool for initializing and managing Python projects.

Installation

To install Compy, run the following command:

sh -c "$(curl -sSL https://raw.githubusercontent.com/Etto48/compy/main/install.sh)"

To uninstall Compy, run the following command:

sh -c "$(curl -sSL https://raw.githubusercontent.com/Etto48/compy/main/install.sh)" -- --uninstall

Usage

To initialize a new Python project, run the following command:

compy init .

This will create a new Python project in the current directory.

For a list of available commands, run the following command:

compy --help

Configuration

Compy can be configured by placing a file in ~/.config/compy/compy.toml or ~/.config/compy.toml.

The following settings are available:

  • name: The author name.
  • email: The author email.
  • license: The license to use. One of MIT or GPL3.
  • version: The project version.
  • description: The project description.
  • python_executable: The Python executable to use. Defaults to python3.