Set up projects for development quickly.

• pj clone [URL] → clone and install a Python project
• pj install → install a Python project
• pj env → display info on the installed environment
• pj config [OPTION] [del|set [VAL]] → configure pyproject.toml
• pj test → run the detected test suite
• pj lint → run the detected linting suite
• pj ci → pj lint; pj test

To use this globally as a CLI tool only, simply install it with pipx:

pipx install pj

But you might also simply install it with pip to access the library API:

pip install pj

If you use Poetry, then you might want to run:

poetry add pj

1. Fork the pj repository on GitHub.

2. Install Poetry.
   Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them. You might use pipx to install it globally (recommended):

   pipx install poetry

   _{If you encounter any problems, refer to the official documentation for the most up-to-date installation instructions.}

   Be sure to have Python 3.8 installed—if you use pyenv, simply run:

   pyenv install 3.8

3. Clone your fork locally and install dependencies.

   git clone https://github.com/your-username/pj path/to/pj
   cd path/to/pj
   poetry env use $(cat .python-version)
   poetry install

   Next up, simply activate the virtual environment and install pre-commit hooks:

   poetry shell
   pre-commit install

For more information on how to contribute, check out CONTRIBUTING.md.
Always happy to accept contributions! ❤️

© Copyright by Bartosz Sławecki (@bswck).
This software is licensed under the terms of MIT License.