Skip to content

pynbox

Actions Status Actions Status Coverage Status

pynbox aims to help you with the daily emptying of the inbox by:

  • Prioritizing the elements by their type.
  • Giving insights on the inbox status.
  • Giving feedback on the inbox processing process.
  • Making the insertion of new elements as effortless as possible.

Installing

pip install pynbox

Quick overview

Proposed workflow

When you're on your desktop you can add elements directly with the command line, when you're on the go, use any text editor, such as Markor, and sync the file with Syncthing to your laptop, and then parse the file.

To process the elements, you can daily use pynbox process. If you want to focus on a category, use pynbox process category.

References

As most open sourced programs, pynbox is standing on the shoulders of giants, namely:

Pytest
Testing framework, enhanced by the awesome pytest-cases library that made the parametrization of the tests a lovely experience.
Mypy
Python static type checker.
Flakeheaven
Python linter with lots of checks.
Black
Python formatter to keep a nice style without effort.
Autoimport
Python formatter to automatically fix wrong import statements.
isort
Python formatter to order the import statements.
PDM
Command line tool to manage the dependencies.
Mkdocs
To build this documentation site, with the Material theme.
Safety
To check the installed dependencies for known security vulnerabilities.
Bandit
To finds common security issues in Python code.
Yamlfix
YAML fixer.

Contributing

For guidance on setting up a development environment, and how to make a contribution to pynbox, see Contributing to pynbox.


Last update: 2022-06-09