Skip to main content

ctbl_tools: miscelaneous daily tasks helpers

A package with miscelaneous classes meant to help at coding console helpers. Currently there are three classes:

  1. config: it implements a config file that saves itself. It is a specialization of configparser.
  2. process: it runs external processes, it saves the return code, and it helps (a little bit) to parse the standard output (or the standard error).
  3. git: a simple interface for git commands.

config: a self-preserving config file

It implements a config file that saves itself.

The idea is: we want to use a config file for an application, which is a simple text file that contains pairs of values, in a similar fashion to an INI file. If the file exists, it is used; if it doesn't, it is created. We use configparser for this.

An example:

from ctbl_tools.config import config

cfg = config(initpath = '~/somewhere/blabla.ini')
cfg.create_section('my_configuration')
cfg.set('my_configuration', 'x', 1)
cfg.set('my_configuration', 'y', '2')

When the program above ends, it will save all created configuration to the file ~/somewhere/blabla.ini.

process: a helper to run external programs

It runs an external program, and it stores the return code and both the standard output and standard error.

You first create an object of this type:

p = process()

Then run a command:

p.run("whoami")

Immediately after you gain access to the return code, stdout and stderr:

print(p.returncode)
for line in p.stdout:
  print(line)

You may check if return code was 0 (i.e., all good) by checking p.is_ok() to be true. You may also check whether there is any stdout or any stderr with p.is_there_stdout() and with p.is_there_stderr(), respectively.

Finally you may extract information out of stdout by using extract(). This method receives a regular expression and a boolean that is true by default (meaning that you want to inspect stdout; if false it will inspect stderr instead). The method will look for all matches in each line of stdout and store them in a list. The list stores as many elements as lines stdout has, and each element is a list of all matches within the corresponding line.

git: a simple git interface

It provides a simple programmatical interface to git.

First, you create a git object by providing a local path to a repo:

from ctbl_tools.git import git

x = git("~/Dev/my_repo")

The previous will fail if provided path is not a git repo.

Then you may either get the remote urls with x.get_remote(), or a get the status of the working tree by invoking x.get_status().

You may also do a commit with a list of files with x.commit(list-of-files), or do a push (x.git_push('my-commit-message')) or a pull (x.git_pull()).

This package also includes two auxiliary functions:

  • git_clone(url:str, path:str): It clones url into path.
  • is_git_url(url:str): It checks whether url is a valid git url.

Metadata

Release files for ctbl 0.1.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ctbl 0.1.11
File Size Uploaded Provenance Actions
ctbl-0.1.11.tar.gz 15.3 kB Without provenance Details for ctbl-0.1.11.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ctbl 0.1.11
File Interpreter ABI Platform Actions
ctbl-0.1.11-py3-none-any.whl Python 3 none any Details for ctbl-0.1.11-py3-none-any.whl

Total release size: 30.7 kB

Release files / ctbl-0.1.11.tar.gz

Download URL ctbl-0.1.11.tar.gz
Size 15.3 kB
Tags Source
SHA-256 checksum
How to use checksums
6c1a470ab6e88cd4416be93942fdb955c05b21b64ca63f66c9b611c486ca70f7
BLAKE2b-256 checksum
How to use checksums
fefcc2970e70ecd6919be1bde37f269fff3a2ee001308cc2a42b35d1be093b7a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release files / ctbl-0.1.11-py3-none-any.whl

Download URL ctbl-0.1.11-py3-none-any.whl
Size 15.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
916836d4d1066d936e42d5804e1ee218682544658a1ba5c87e93eb7e121b4c98
BLAKE2b-256 checksum
How to use checksums
32cb8e9764423155e7faa6bd7f4bdb5a03a280dbee8e739e3eb059a156c823c1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Security for ctbl 0.1.11

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.11 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page