Skip to main content

A CLI tool to create empty Python projects

Project description

Quick Python Project

Description

Quick Python Project is a tool designed to streamline the creation and deployment of Python projects on PyPI. Originally conceived as a personal learning project, it aims to simplify the process of creating Python projects that can be quickly tested and run from the command line. The tool facilitates the creation of projects that utilize setuptools and a pyproject.toml file by default. Your feedback and suggestions for improvement are highly appreciated as I continue to enhance its functionality.

Installation

pip install quick_python_project

Usage

To create a new project using Quick Python Project, use the following command:

qpp create_project <project_name> <command_name> <project_path>

Replace <project_name> with the desired name of your project, <command_name> with the command that will be used to run your project, and optionally the path to the new project. The default path will be /home/code

Example:

qpp create_project my_project my_command /path/to/project

Once your project is created, you can navigate to its directory and run the specified command to execute it.

Command Line Arguments

  • project_name: The name of the new project.
  • command_name (optional, default: 'cmd'): The name of the command to launch the program.
  • project_path (optional, default: 'home/code'): The path to create the new project in.

Example:

qpp create_project my_project my_command my_path

Note

After creating your project, navigate to the project directory and follow these steps:

  1. Set up a virtual environment:
python3 -m venv .venv
  1. Activate the virtual environment:
source .venv/bin/activate
  1. Perform an editable install of the project:
pip install -e .
  1. Run the specified command:
my_command

This will execute your project, displaying any output to the console.

Contributions

Contributions and feedback are welcome! If you have any suggestions or encounter any issues, please feel free to open an issue or submit a pull request on GitHub.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quick_python_project-1.0.2.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

quick_python_project-1.0.2-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file quick_python_project-1.0.2.tar.gz.

File metadata

  • Download URL: quick_python_project-1.0.2.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for quick_python_project-1.0.2.tar.gz
Algorithm Hash digest
SHA256 47139c27ea2a40d923fda99ba65083acc56187df0e8bc9129617c21137b6fec0
MD5 85f038eb6a4635a69c4f5ac2ad938f51
BLAKE2b-256 7e0e1bc7f2bb492383220ea783fab3ce052ecb9f5789ec95479d8be1e9613f4e

See more details on using hashes here.

File details

Details for the file quick_python_project-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for quick_python_project-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6e5cab2d29a076bd80cddce5ef16587e716221af69289d0b944ff7142c8753c6
MD5 d8e41e0b87b1e56455447c13e0da508b
BLAKE2b-256 4ba439585bae5a0aa68a442ea6fcb853eeee294504c0ed806b0fb81276088157

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page