dirstat

Name	dirstat JSON
Version	0.1.2 JSON
	download
home_page	None
Summary	A single-file no-dependency Python program (also usable as a library module) to efficiently gather directory statistics.
upload_time	2025-08-02 01:56:13
maintainer	None
docs_url	None
author	None
requires_python	>=3.7
license	None
keywords	single directory statistics dirstat windirstat
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            PyDirStat
=========

A single-file no-dependency Python program (also usable as a library module) to efficiently gather directory statistics.


## Installation

Install from [the Python Package Index](https://pypi.org/project/dirstat/):

```sh
pip install dirstat
```

Install from [source repository](https://gitlab.com/ipamo/dirstat) (example on Linux):

```sh
sudo wget https://gitlab.com/ipamo/dirstat/-/raw/main/dirstat.py -O /opt/dirstat.py
sudo chmod +x /opt/dirstat.py
sudo ln -s /opt/dirstat.py /usr/local/bin/dirstat
```


## Usage

Run as an application:

```sh
dirstat MYDIR
```

Use as a library:

```py
from dirstat import DirStatOperation

with DirStatOperation(MYDIR) as op:
    op.run()
```

Run the following command to display available options:

```sh
dirstat --help
```


## Contributing

Pull requests are welcome.

See [contributing guidelines](https://gitlab.com/ipamo/dirstat/-/blob/main/CONTRIBUTING.md) and [roadmap](https://gitlab.com/ipamo/dirstat/-/blob/main/docs/ROADMAP.md).


## Legal and credits

This project is licensed under the terms of the [MIT license](https://gitlab.com/ipamo/dirstat/-/raw/main/LICENSE.txt).

It is inspired from the following projects:
- [WinDirStat](https://windirstat.net/) : Windows only.
- [QDirStat](https://github.com/shundhammer/qdirstat) : Linux only.
- Gaël Girodon's [DirStat](https://github.com/GaelGirodon/dirstat) : written in Go.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "dirstat",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "single, directory, statistics, dirstat, windirstat",
    "author": null,
    "author_email": "S\u00e9bastien Hocquet <seb@ipamo.net>",
    "download_url": null,
    "platform": null,
    "description": "PyDirStat\n=========\n\nA single-file no-dependency Python program (also usable as a library module) to efficiently gather directory statistics.\n\n\n## Installation\n\nInstall from [the Python Package Index](https://pypi.org/project/dirstat/):\n\n```sh\npip install dirstat\n```\n\nInstall from [source repository](https://gitlab.com/ipamo/dirstat) (example on Linux):\n\n```sh\nsudo wget https://gitlab.com/ipamo/dirstat/-/raw/main/dirstat.py -O /opt/dirstat.py\nsudo chmod +x /opt/dirstat.py\nsudo ln -s /opt/dirstat.py /usr/local/bin/dirstat\n```\n\n\n## Usage\n\nRun as an application:\n\n```sh\ndirstat MYDIR\n```\n\nUse as a library:\n\n```py\nfrom dirstat import DirStatOperation\n\nwith DirStatOperation(MYDIR) as op:\n    op.run()\n```\n\nRun the following command to display available options:\n\n```sh\ndirstat --help\n```\n\n\n## Contributing\n\nPull requests are welcome.\n\nSee [contributing guidelines](https://gitlab.com/ipamo/dirstat/-/blob/main/CONTRIBUTING.md) and [roadmap](https://gitlab.com/ipamo/dirstat/-/blob/main/docs/ROADMAP.md).\n\n\n## Legal and credits\n\nThis project is licensed under the terms of the [MIT license](https://gitlab.com/ipamo/dirstat/-/raw/main/LICENSE.txt).\n\nIt is inspired from the following projects:\n- [WinDirStat](https://windirstat.net/) : Windows only.\n- [QDirStat](https://github.com/shundhammer/qdirstat) : Linux only.\n- Ga\u00ebl Girodon's [DirStat](https://github.com/GaelGirodon/dirstat) : written in Go.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A single-file no-dependency Python program (also usable as a library module) to efficiently gather directory statistics.",
    "version": "0.1.2",
    "project_urls": {
        "Bug Tracker": "https://gitlab.com/ipamo/dirstat/issues",
        "Homepage": "https://gitlab.com/ipamo/dirstat"
    },
    "split_keywords": [
        "single",
        " directory",
        " statistics",
        " dirstat",
        " windirstat"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "aadf99aa1e7f67f1664bf04605445e8629b423c04c73bcfb93bd740aef968898",
                "md5": "7332d9859d5d147aade52fe541b7662c",
                "sha256": "b10d22b958a2a71a689fc42b41fd0a769b60c9db1c1401a0dbde794303cd7f72"
            },
            "downloads": -1,
            "filename": "dirstat-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7332d9859d5d147aade52fe541b7662c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 12016,
            "upload_time": "2025-08-02T01:56:13",
            "upload_time_iso_8601": "2025-08-02T01:56:13.682844Z",
            "url": "https://files.pythonhosted.org/packages/aa/df/99aa1e7f67f1664bf04605445e8629b423c04c73bcfb93bd740aef968898/dirstat-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-02 01:56:13",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "ipamo",
    "gitlab_project": "dirstat",
    "lcname": "dirstat"
}