semvec/pypi-packages huggingface dataset:
dirlisting 0.4.0
Create a directory listing diagram from text file
License: MIT
Requires Python: >=3.9,<4.0

# dirlisting

[![Documentation Status](https://readthedocs.org/projects/dirlisting/badge/?version=latest)](https://dirlisting.readthedocs.io/en/latest/?badge=latest)


Create a directory tree listing from a text file for use in documentation.

There are plenty of good tools out there to produce directory tree listings from an
existing directory structure. This tool handles the situation when you don't have and
don't want to create a directory structure for the sole purpose of producing a directory
tree listing for a document or email.

----

**[Read the documentation on ReadTheDocs!](https://dirlisting.readthedocs.io/en/stable/)**

----

## Installation

```bash
$ pip install dirlisting
```

## Usage

`dirlisting` can be used to create a directory tree listing that looks like those
created with the `tree` command, but from a text file instead of walking an actual
directory tree.

### From code

**Reading a file**

```python
from dirlisting.dirlisting import Dirlisting
with open("input.yaml") as f:
    listing = Dirlisting(f)
listing.print()
```

**From a string**

```
from dirlisting.dirlisting import Dirlisting
input = """
- topdir:
  - subdir1:
    - file1.txt
    - file2.txt
"""
Dirlisting(input).print()
```

### From the command line

Just use `dirlisting <filename>`.

``` none
dirlisting [OPTIONS] FILE

  Create a directory listing given an input FILE.

Options:
  --version              Show the version and exit.
  -s, --sort             Sort the directory entries.
  -d, --dirsfirst        List directories before files.
  -o, --output FILENAME  Output to this file.
  --help                 Show this message and exit.
```

### File format

The input file is a [yaml](https://yaml.org/) file. Each of the entries is treated as
part of a sequence and starts with a `-`. The files are final strings and the file name
comes after the dash (`- filename`). The directories are mappings and the directory name
is followed by a colon (`- dirname:`). A listing would look like the following.

:::::{grid} 2
::::{grid-item-card} YAML File
```yaml
- topdir:
  - emptydir:
  - file1.txt
  - file2.txt
  - subdir:
    - file3.txt
```
::::
::::{grid-item-card} Output
```
topdir
├── emptydir
├── file1.txt
├── file2.txt
└── subdir
    └── file3.txt
```
::::
:::::

When using the output option to save to a file, the file will be saved with "utf-8"
encoding. On a Mac or Linux machine this works seamlessly. There can be problems with
the console on Windows, but most modern editors can open the file with "utf-8" encoding.

## Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this
project is released with a Code of Conduct. By contributing to this project, you agree
to abide by its terms.

## License

`dirlisting` was created by Stephan Poole. It is licensed under the terms of the MIT
license.

## Credits

`dirlisting` was created with
[`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the
`py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).
proto-compile 0.1.7
No description has been added so far.
License: MIT
Requires Python: >=3.6
Keywords: proto-compile

===============================
proto-compile
===============================

.. image:: https://github.com/romnn/proto-compile/workflows/test/badge.svg
        :target: https://github.com/romnn/proto-compile/actions
        :alt: Build Status

.. image:: https://img.shields.io/pypi/v/proto-compile.svg
        :target: https://pypi.python.org/pypi/proto-compile
        :alt: PyPI version

.. image:: https://img.shields.io/github/license/romnn/proto-compile
        :target: https://github.com/romnn/proto-compile
        :alt: License

.. image:: https://codecov.io/gh/romnn/proto-compile/branch/master/graph/badge.svg
        :target: https://codecov.io/gh/romnn/proto-compile
        :alt: Test Coverage

""""""""

Your short description here. 

.. code-block:: console

    $ pip install proto-compile

Usage
-----

.. code-block:: python

    import proto_compile


Development
-----------

For detailed instructions see the `contribution guide <CONTRIBUTING.rst>`_.

Tests
~~~~~~~
You can run tests with

.. code-block:: console

    $ invoke test
    $ invoke type-check                 # Run mypy type checks

Linting and formatting
~~~~~~~~~~~~~~~~~~~~~~~~
Lint and format the code with

.. code-block:: console

    $ invoke format
    $ invoke lint

All of this happens when you run ``invoke pre-commit``.

Note
-----

This project is still in the alpha stage and should not be considered production ready.