Skip to main content

A hybrid language for a modern approach to shell scripting

Project description

Calligraphy


Code style: Black License: MIT CI Coverage Badge

Shell scripting for the modern age

Calligraphy is a hybrid scripting language that allows you to mix Python and Bash code in the same file. This gives you the advantages of bash when working with other processes while also giving you the advantages of a modern language like Python.

It's a free software distributed under the MIT Licence unless otherwise specified.

Development is hosted on GitHub: https://github.com/jfcarter2358/calligraphy/

Pull requests are amazing and most welcome.

Install

Calligraphy can be simply installed by running

pip install calligraphy-scripting

If you want to install from a source distribution, extract the tarball and run the following command (this requires poetry to be installed)

poetry install --no-dev

Documentation

The documentation lives at https://calligraphy.readthedocs.io/.

Testing

We use pytest and pytest-cov for running the test suite. You should be able to install them with

pip install pytest pytest-cov

or you can install calligraphy alongside those packages with

poetry install

To run the test suite, you can do

make test

This will produce an html coverage report under the htmlcov directory.

Roadmap

You can find the Calligraphy roadmap here

License

Calligraphy is under the MIT license.

Contact

If you have any questions or concerns please reach out to me (John Carter) at jfcarter2358@gmail.com

Project details


Download files

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

Source Distribution

calligraphy_scripting-1.1.4.tar.gz (12.4 kB view hashes)

Uploaded Source

Built Distribution

calligraphy_scripting-1.1.4-py3-none-any.whl (14.2 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