Skip to main content

CLI to automate the development workflow.

Project description

logo

License PyPI GitHub Code Style CI Coverage

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

: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:

Credits

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

pytoil has been built on top of these fantastic projects:

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

pytoil-0.8.0.tar.gz (36.1 kB view details)

Uploaded Source

Built Distribution

pytoil-0.8.0-py3-none-any.whl (51.5 kB view details)

Uploaded Python 3

File details

Details for the file pytoil-0.8.0.tar.gz.

File metadata

  • Download URL: pytoil-0.8.0.tar.gz
  • Upload date:
  • Size: 36.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for pytoil-0.8.0.tar.gz
Algorithm Hash digest
SHA256 f720e443633c99e93870fd741b702b6519124d8b2cf9252f164c9f09acbd87f4
MD5 68f5cc9f02f7c0354b5c8d4dfc3ec550
BLAKE2b-256 0fa1a77f6964169c918161692c8afd4feb3bddf4a2942778f08afdeb9ac63134

See more details on using hashes here.

File details

Details for the file pytoil-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: pytoil-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 51.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for pytoil-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 06378fb7dd3693a6adcfc673c8916cd12845f3d0289a1befd0a44835b5d923be
MD5 b7ca9a5f9080e0faa34871c85dbb87fe
BLAKE2b-256 33df146b08eef279592cae2e2bc760e21edf2236160443a8151581454f3e40b6

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