===
pss
===
.. image:: https://github.com/eliben/pss/workflows/pss-tests/badge.svg
:align: center
:target: https://github.com/eliben/pss/actions
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/eliben/pss",
"name": "pss",
"maintainer": "Eli Bendersky",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Eli Bendersky",
"author_email": "eliben@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/de/f0/8f4e99ea94537d6755d739fb42272cf9e8280c80ec73ed070c57b67027e0/pss-1.45.tar.gz",
"platform": "Cross Platform",
"description": "\n===\npss\n===\n\n.. image:: https://github.com/eliben/pss/workflows/pss-tests/badge.svg\n :align: center\n :target: https://github.com/eliben/pss/actions\n\nIntroduction: what is pss?\n--------------------------\n\n**pss** is a power-tool for searching inside source code files. **pss**\nsearches recursively within a directory tree, knows which extensions and\nfile names to search and which to ignore, automatically skips directories\nyou wouldn't want to search in (for example ``.git`` or ``.svn``), colors\nits output in a helpful way, and does much more.\n\nIf you're familiar with the **ack** tool, then you will find **pss** very\nsimilar (see https://github.com/eliben/pss/wiki/pss-and-ack).\n\nPre-requisites\n--------------\n\n**pss** needs only Python to run. It's being tested with several of the latest\nPython 3.x versions on Linux, Mac OS and Windows. Earlier versions of Python 3.x\nmay work as well, but this isn't guaranteed. Python 2 is no longer supported\n(but you may download pss version 1.43 or older if you need it to work with\nPython 2).\n\nInstalling\n----------\n\n**pss** can be installed from PyPI (Python Package Index)::\n\n > pip install pss\n\nAlternatively, you can download the source distribution either from PyPI or\nfrom the main Github project page. When you unzip the source distribution, run::\n\n > python setup.py install\n\nRunning without installing\n--------------------------\n\n**pss** supports direct invocation even without installing it. This may\nbe useful if you're on a machine without administrator rights, or want to\nexperiment with a source distribution of **pss**.\n\nJust unzip the **pss** distribution into some directory. Let's assume its full\npath is ``/path/to/pss``. You can now run::\n\n > /path/to/python /path/to/pss\n\nAnd this will invoke **pss** as expected. This command can also be tied to an\nalias or placed in a shell (or batch) script for convenience.\n\nHow to use it?\n--------------\n\n**pss** is meant to be executed from the command line. Running it with no\narguments or with ``-h`` will print a detailed usage message.\n\nFor some detailed usage examples, check out the\nUsage wiki page - https://github.com/eliben/pss/wiki/Usage-samples\n\nLicense\n-------\n\n**pss** is open-source software. Its code is in the public domain. See the\n``LICENSE`` file for more details.\n\n\n",
"bugtrack_url": null,
"license": "Public domain",
"summary": "Tool for grepping through source code",
"version": "1.45",
"project_urls": {
"Homepage": "https://github.com/eliben/pss"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "def08f4e99ea94537d6755d739fb42272cf9e8280c80ec73ed070c57b67027e0",
"md5": "d751504ad5869b4ca50e8e4a36beb9c2",
"sha256": "13b81a4a7a33a7d6c4de85b908911c48849050fbaab596aeeceac78eaf067149"
},
"downloads": -1,
"filename": "pss-1.45.tar.gz",
"has_sig": false,
"md5_digest": "d751504ad5869b4ca50e8e4a36beb9c2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27740,
"upload_time": "2023-11-22T16:25:27",
"upload_time_iso_8601": "2023-11-22T16:25:27.683387Z",
"url": "https://files.pythonhosted.org/packages/de/f0/8f4e99ea94537d6755d739fb42272cf9e8280c80ec73ed070c57b67027e0/pss-1.45.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-22 16:25:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "eliben",
"github_project": "pss",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pss"
}
JSON
