Warning
Work in Progress. 🚧
Hit the 👁 Watch
button to know when this project is ready to be tried out!
Set up projects for development quickly.
pj clone [URL]
→ clone and install a Python projectpj install
→ install a Python projectpj env
→ display info on the installed environmentpj config [OPTION] [del|set [VAL]]
→ configurepyproject.toml
pj test
→ run the detected test suitepj lint
→ run the detected linting suitepj 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
Note
If you use Windows, it is highly recommended to complete the installation in the way presented below through WSL2.
-
Fork the pj repository on GitHub.
-
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
-
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.