Format Python code (list of lists) as a fixed width table.
Project description
table_format
Format Python code (list of lists) as a fixed width table.
💪 Getting Started
You've got some tests like this:
def test_the_thing():
assert do_the_thing() == [
["A nice header", "Another", "More"],
[1, 2, 3],
]
Wouldn't it be nice if those columns lined up?
Copy the whole list of lists to the clipboard, then pipe to table-format --guess-indent
. On Linux you could use xsel
or xclip
etc:
Options
Pass the --help
flag to show all subcommands:
$ table-format --help
⬇️ Installation
The most recent code and data can be installed directly from GitHub with:
$ pip install git+https://github.com/spookylukey/table-format.git
To install in development mode, use the following:
$ git clone git+https://github.com/spookylukey/table-format.git
$ cd table-format
$ pip install -e .
⚖️ License
The code in this package is licensed under the MIT License.
🙏 Contributing
Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See CONTRIBUTING.rst for more information on getting involved.
🍪 Cookiecutter Acknowledgement
This package was created with @audreyfeldroy's cookiecutter package using @cthoyt's cookiecutter-python-package template.
🛠️ Development
The final section of the README is for if you want to get involved by making a code contribution.
❓ Testing
After cloning the repository and installing tox
with pip install tox
, the unit tests in the tests/
folder can be
run reproducibly with:
$ tox
Additionally, these tests are automatically re-run with each commit in a GitHub Action.
📦 Making a Release
After installing the package in development mode and installing
tox
with pip install tox
, the commands for making a new release are contained within the finish
environment
in tox.ini
. Run the following from the shell:
$ tox -e finish
This script does the following:
- Uses BumpVersion to switch the version number in the
setup.cfg
andsrc/table-format/version.py
to not have the-dev
suffix - Packages the code in both a tar archive and a wheel
- Uploads to PyPI using
twine
. Be sure to have a.pypirc
file configured to avoid the need for manual input at this step - Push to GitHub. You'll need to make a release going with the commit where the version was bumped.
- Bump the version to the next patch. If you made big changes and want to bump the version by minor, you can
use
tox -e bumpversion minor
after.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for table_format-0.0.1.dev0-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 434f5f1c95479517c60877f9099a85f9ce423fa7907e2026747062cf38f838ab |
|
MD5 | 7da28d19c4c8901553c30c5accb37e70 |
|
BLAKE2b-256 | f6368b11c1359f714b1d59db9afa405acf86129890247b460f0b5b0e181731fd |