Convenience methods for file/process operations

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for zsimic from gravatar.com zsimic

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Project description

Convenience methods for file/process operations

Version on pypi Travis CI codecov Python versions tested (link to github project)

Overview

runez is a small convenience library for common operations I found myself rewriting multiple times.

It comes in handy for programs that need to run other programs, or copy/move files etc.

The name was initially meant as “run ez” (“run easy”), the fact that it sounds like “runes” gives it a bit of a mystery/magic side that’s also relatively appropriate (it does indeed concentrate a bit of invocation magic, as you can save quite a few lines of repetitive code by using it)

Features

  • Support for dryrun mode (show what would be done, but don’t do it)

  • Perform most typical logging setups in one call to runez.log.setup()

  • Log operations systematically (at debug level mostly), examples:

    Running: foo ...
Copy foo -> bar
Would move foo -> bar    (for dryrun)

  • CaptureOutput context manager -> grab output/logging from any code section

  • Take care of most edge cases, with nice errors

  • Functions can be called without checking for return code etc (abort by default, with nice error)

  • They can also be called with fatal=False, in which case the return value will indicate whether call succeeded or not

  • 100% test coverage

Example

Run a program:

import runez

# Aborts if "foo" doesn't exist
output = runez.run("ls", "foo")

# Output can also be ignored
runez.run("ls", "foo")

# Don't capture output, just run the command and let output "pass through"
runez.run("ls", "foo", stdout=None, stderr=None)

# Don't abort, return False on failure (or actual output when successful)
output = runez.run("ls", "foo", fatal=False)

File operations:

import runez

runez.touch("foo")
runez.copy("foo", "bar")
runez.move("foo", "baz")
runez.delete("foo")

runez.write("foo", "bar\nbaz\n")
first = runez.first_line("foo")
lines = runez.get_lines("foo")

full_path = runez.resolved_path("foo/bar")
folder = runez.parent_folder(full_path)
runez.ensure_folder(folder)
with runez.Anchored(folder):
    assert runez.short(full_path) == "bar"

Installation

As usual, available on pypi: pip install runez

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for zsimic from gravatar.com zsimic

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

5.2.1

5.2.0

5.1.1

5.1.0

5.0.7

5.0.6

5.0.5

5.0.4

5.0.3

5.0.2

5.0.1

5.0.0

4.0.4

4.0.3

4.0.2

4.0.1

4.0.0

3.7.1

3.7.0

3.6.8

3.6.7

3.6.6

3.6.5

3.6.4

3.6.3

3.6.2

3.6.1

3.6.0

3.5.6

3.5.5

3.5.4

3.5.3

3.5.2

3.5.1

3.5.0

3.4.9

3.4.8

3.4.7

3.4.6

3.4.5

3.4.4

3.4.3

3.4.2

3.4.1

3.4.0

3.3.7

3.3.6

3.3.5

3.3.4

3.3.3

3.3.2

3.3.1

3.3.0

3.2.4

3.2.3

3.2.2

3.2.1

3.2.0

3.1.9

3.1.8

3.1.7

3.1.6

3.1.5

3.1.4

3.1.3

3.1.2

3.1.1

3.1.0

3.0.8

3.0.7

3.0.6

3.0.5

3.0.4

3.0.3

3.0.2

3.0.1

3.0.0

2.7.17

2.7.16

2.7.15

2.7.14

2.7.13

2.7.12

2.7.11

2.7.10

2.7.9

2.7.8

2.7.7

2.7.6

2.7.5

2.7.4

2.7.3

2.7.2

2.7.1

2.7.0

2.6.17

2.6.16

2.6.15

2.6.14

2.6.13

2.6.12

2.6.11

2.6.10

2.6.9

2.6.8

2.6.7

2.6.6

2.6.5

2.6.4

2.6.3

2.6.2

2.6.0

2.5.9

2.5.8

2.5.7

2.5.6

2.5.5

2.5.4

2.5.3

2.5.2

2.5.1

2.5.0

2.4.11

2.4.10

2.4.9

2.4.8

2.4.7

2.4.6

2.4.5

2.4.4

2.4.3

2.4.2

2.4.1

2.4.0

2.3.9

2.3.8

2.3.7

2.3.6

2.3.5

2.3.4

2.3.3

2.3.2

2.3.1

2.3.0

2.2.5

2.2.4

2.2.3

2.2.2

2.2.1

2.2.0

2.1.8

2.1.7

2.1.6

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.1.0

2.0.19

2.0.18

2.0.17

2.0.9

2.0.6

1.12.2

1.11.5

1.10.31

This version

1.10.17

1.9.41

1.9.8

1.9.6

1.8.8

1.6.12

1.5.5

1.4.4

1.3.6

1.2.8

Download files

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

Source Distribution

runez-1.10.17.tar.gz (52.7 kB view details)

Uploaded Source

Built Distribution

runez-1.10.17-py2.py3-none-any.whl (61.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file runez-1.10.17.tar.gz.

File metadata

  • Download URL: runez-1.10.17.tar.gz
  • Upload date:
  • Size: 52.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.1

File hashes

Hashes for runez-1.10.17.tar.gz
Algorithm Hash digest
SHA256 aee9efdb9e34cbb23975d1b056cd6df24743f8b122f12bfb553af8e31172e49f
MD5 e9d6332bcbac298173ccd3dcaaa34fa9
BLAKE2b-256 fa2c2a1b0e368399436bec45e9a47872307196e92ac4afef1607aacb7c2a22f9

See more details on using hashes here.

Provenance

File details

Details for the file runez-1.10.17-py2.py3-none-any.whl.

File metadata

  • Download URL: runez-1.10.17-py2.py3-none-any.whl
  • Upload date:
  • Size: 61.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.1

File hashes

Hashes for runez-1.10.17-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f921d1238ada922aac7c9e3a125b7e7b22afa78abbf127287ae037e29f820d55
MD5 d61b685435ba0e9414bf8dbc74988fb0
BLAKE2b-256 e3bd0a57a481665208ed6439713281167647229313c6774ff40f08adf4317970

See more details on using hashes here.

Provenance

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