Skip to main content

Tool for grepping through source code

Project description

https://github.com/eliben/pss/workflows/pss-tests/badge.svg

Introduction: what is pss?

pss is a power-tool for searching inside source code files. pss searches recursively within a directory tree, knows which extensions and file names to search and which to ignore, automatically skips directories you wouldn’t want to search in (for example .git or .svn), colors its output in a helpful way, and does much more.

If you’re familiar with the ack tool, then you will find pss very similar (see https://github.com/eliben/pss/wiki/pss-and-ack).

Pre-requisites

pss needs only Python to run. It’s being tested with several of the latest Python 3.x versions on Linux, Mac OS and Windows. Earlier versions of Python 3.x may work as well, but this isn’t guaranteed. Python 2 is no longer supported (but you may download pss version 1.43 or older if you need it to work with Python 2).

Installing

pss can be installed from PyPI (Python Package Index):

> pip install pss

Alternatively, you can download the source distribution either from PyPI or from the main Github project page. When you unzip the source distribution, run:

> python setup.py install

Running without installing

pss supports direct invocation even without installing it. This may be useful if you’re on a machine without administrator rights, or want to experiment with a source distribution of pss.

Just unzip the pss distribution into some directory. Let’s assume its full path is /path/to/pss. You can now run:

> /path/to/python /path/to/pss

And this will invoke pss as expected. This command can also be tied to an alias or placed in a shell (or batch) script for convenience.

How to use it?

pss is meant to be executed from the command line. Running it with no arguments or with -h will print a detailed usage message.

For some detailed usage examples, check out the Usage wiki page - https://github.com/eliben/pss/wiki/Usage-samples

License

pss is open-source software. Its code is in the public domain. See the LICENSE file for more details.

Project details


Download files

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

Source Distribution

pss-1.45.tar.gz (27.7 kB view details)

Uploaded Source

File details

Details for the file pss-1.45.tar.gz.

File metadata

  • Download URL: pss-1.45.tar.gz
  • Upload date:
  • Size: 27.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for pss-1.45.tar.gz
Algorithm Hash digest
SHA256 13b81a4a7a33a7d6c4de85b908911c48849050fbaab596aeeceac78eaf067149
MD5 d751504ad5869b4ca50e8e4a36beb9c2
BLAKE2b-256 def08f4e99ea94537d6755d739fb42272cf9e8280c80ec73ed070c57b67027e0

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