| Latest Version | Downloads | Tests |
|---|---|---|
 |
 |
Python Project Creator Script -> PPCS -> PythonPieCeS -> ppieces
ppieces is a command-line utility designed to streamline the setup of new Python projects.
It automates various tasks such as creating project directories, initializing git repositories, setting up virtual environments, handling requirements (with or without pip-tools) and installing pre-commit hooks.
I tend to always have a python project or two on the go, usually for my own benefit, little scripts to make my day to day easier/faster/automated or just learning new things or experimenting with ideas.
Because of that I found myself repeating the same steps over and over again when setting up new Python projects. Same song & dance.
I wanted a way to automate the setup for new projects, so I created ppieces.
# Install via pipx, recommended since you will most likely want to use this tool globally.
pipx install ppieces
# Install via pip, if you prefer to use a virtual environment.
pip install ppiecesClone the repository:
git clone https://github.com/patillacode/ppieces.git
cd ppiecesInstall the dependencies and the package:
make install
# or manually:
python -m venv venv
source venv/bin/activate
pip install -e .Before using ppieces, ensure you have the following installed:
- Python >=
3.10
Optional:
pre-commit(can be installed viapipxorHomebrew- see here for more details)autoenv(optional for auto-activation of virtual environments - see here for more details)
ppieces can be used in an interactive mode (by default) or with command-line options for scripting:
Interactive mode will ask you a series of questions to configure your new project.
$ ppiecesppieces-interactive-demo.mov
For scripting, use the following options:
$ ppieces --help
Usage: ppieces [OPTIONS]
Options:
-ni, --non-interactive Run the script in non-interactive mode.
-f, --project-folder PATH The path to your projects folder.
-n, --project-name TEXT The name of the new project.
-v, --virtual-env Create a virtual environment.
-g, --git Initialize a git repository (with .gitignore and README files)
-c, --pre-commit Add pre-commit configuration.
-r, --ruff Add a ruff configuration file.
-a, --autoenv Set up autoenv.
-m, --makefile Add a default Makefile.
-p, --pip-tools Add a default pip-tools setups.
-u, --username TEXT GitHub username to use in README (default: $USER)
--version Show the version of ppieces.
--help Show this message and exit.Example usage:
ppieces -ni -p /home/user/projects -n my_new_project -u my_github_username -mcragvp- Project Directory Creation: Automatically creates a new directory for your project.
- Git Repository Initialization: Initializes a new git repository in the project directory.
- Virtual Environment: Sets up a Python virtual environment within the project.
- autoenv Setup: Configures autoenv to automatically activate the virtual environment when entering the project directory.
- ruff Configuration: Adds a default
.ruff.tomlconfiguration file for the Ruff static analysis tool. - Makefile: Adds a default
Makefilefor common tasks like installing or running the project. - pip-Tools: Adds a default
requirementsfolder with all the.indefault requirements files and generatesrequirements.txtfile for managing project dependencies with pip-tools. - pre-commit Hooks: Installs pre-commit hooks to ensure code quality and standards are maintained.
- Template Files: Provides template files like
.gitignore,requirements.txt, and.pre-commit-config.yamlto get started quickly.
This project makes use of several open-source packages including, but not limited to:
A big thank you to the maintainers of all these projects and the python and open-source communities in general.
Contributions are welcome!
If you have a feature request, bug report, or a pull request, please open an issue or submit a PR.
ppieces is released under the MIT License. See the LICENSE file for more details.