Skip to main content

a framework for interactive, page-based console applications

Project description

almanac logo

a framework for interactive, page-based console applications

pypi python version


Synopsis

This framework aims to serve as an intuitive interface for spinning up interactive page-based console applications.

Installation

You can download the latest packaged version from PyPI:

pip install almanac

Alternatively, you can get the bleeding-edge version from version control:

pip install https://github.com/welchbj/almanac/archive/master.tar.gz

License

The original content of this repository is licensed under the MIT License, as per the LICENSE.txt file.

Some of the parsing logic is borrowed from the python-nubia project and is licensed under that project's BSD License. For more information, please see the comment in almanac/parsing/parsing.py.

Development

Development dependencies can be installed with:

pip install -r deps/dev-requirements.txt

To run the tests, use:

python tasks.py test

To lint and type check the code, use:

flake8 .
mypy .

When it's time to cut a release, use:

python setup.py bdist_wheel sdist
twine check dist/*.whl dist/*.gz
twine upload dist/*.whl dist/*.gz

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

almanac-0.0.1-py3-none-any.whl (52.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page