pytoil 0.13.1

CLI to automate the development workflow.

pytoil is a small, helpful CLI to help developers manage their local and remote projects with ease!

• Source Code: https://github.com/FollowTheProcess/pytoil

• Documentation: https://FollowTheProcess.github.io/pytoil/

:warning: pytoil is still in Alpha and as such, the API may change without deprecation notices.

What is it?

pytoil is a handy tool that helps you stay on top of all your projects, remote or local. It's primarily aimed at python developers but you could easily use it to manage any project!

pytoil is:

• Easy to use :white_check_mark:
• Easy to configure :white_check_mark:
• Safe (it won't edit your repos at all) :white_check_mark:
• Useful! (I hope :smiley:)

Say goodbye to janky bash scripts :wave:

Installation

As pytoil is a CLI, I recommend pipx

pipx install pytoil

Or just pip (but must be globally available)

pip install pytoil

Quickstart

pytoil is super easy to get started with.

After installation just run

$ pytoil config

No config file yet!
Making you a default one...

This will create a default config file which can be found at ~/.pytoil.yml. See the docs for what information you need to put in here.

Don't worry though, there's only a few options to configure! :sleeping:

After that you're good to go! You can do things like:

See your local and remote projects

pytoil show all

See which ones you have on GitHub, but not on your computer

pytoil show diff

Easily grab a project, regardless of where it is

pytoil checkout my_project

Create a new project and virtual environment in one go

pytoil new my_project --venv venv

And even do this from a cookiecutter template

pytoil new my_project --venv venv --cookie https://github.com/some/cookie.git

Check out the docs for more :boom:

Contributing

pytoil is an open source project and, as such, welcomes contributions of all kinds :smiley:

Your best bet is to check out the contributing guide in the docs!

Credits

This package was created with cookiecutter and the FollowTheProcess/poetry_pypackage project template.

pytoil has been built on top of these fantastic projects:

• Typer
• cookiecutter
• wasabi
• httpx
• pydantic