calligraphy-scripting 0.1.0

A hybrid language for a modern approach to shell scripting

Calligraphy

---

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

v1.0.0

• Add indentation to explain output
  • When using the explain flag the resulting annotated code isn't indented. This can make it hard to read considering that indentation matters in Python and Calligraphy, so we should include that in our output.
• Reference environment variables from Bash lines with env.NAME pattern instead of ${NAME}
  • Right now we get/set env variables from the Python side of things in one way and access them in a different way from Bash. This isn't ideal as it can cause confusion with two ways of doing things, so we should standardize.
• Enable sourcing of other calligraphy scripts
  • In order to make Calligraphy more useful, we need to end the limitation of only one source file. A source directive should be introduced which allows other Calligraphy scripts to be imported.
• Token output flag
  • It's useful to be able to see the token representaion of a source file when debugging, therefore we should add a flag which outputs said representation.
• Use $N where N is an integer greater than 0 for arguments
  • Right now we need to use sys.argv[N] in order to access arguments. This isn't much of an issue, but it's slightly clunky. We'd like to be able to denote program arguments in the same way Bash does.

v1.1.0

• Windows shell support
  • Currently when a shell command is run it adds printenv at the end in order to capture environment changes. We need to detect which OS is being run on and use set in its place on Windows.

License

Calligraphy is under the MIT license.

Contact

If you have any questions or concerns please reach out to me (John Carter) at [e-mail]