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.2.1.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

calligraphy_scripting-1.2.1-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file calligraphy_scripting-1.2.1.tar.gz.

File metadata

  • Download URL: calligraphy_scripting-1.2.1.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.11.1 Linux/6.6.87.2-microsoft-standard-WSL2

File hashes

Hashes for calligraphy_scripting-1.2.1.tar.gz
Algorithm Hash digest
SHA256 c1d8346e5ce73e27cd2f1a1fdb8203a13970e35bf7e9c25a6fd4a8bd77f97f52
MD5 ad98fec6a00f9f23f0bf4cb2bf01df37
BLAKE2b-256 2413b4eeefffddeb1bf9dea25e76461b7e89793d4b6c587493fca73249366912

See more details on using hashes here.

File details

Details for the file calligraphy_scripting-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: calligraphy_scripting-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 14.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.11.1 Linux/6.6.87.2-microsoft-standard-WSL2

File hashes

Hashes for calligraphy_scripting-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7fdf609c6a3de1740ea6240dc86d34e3ddfb5b9c5d792de00ed82990a3891147
MD5 cde4286110819fa5a1942483f5478938
BLAKE2b-256 e51426ae333d4e1b77794865801ac0fec953a9d57ed353f6f252f30c3f02c741

See more details on using hashes here.

Supported by

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