# Calligraphy
---
[](https://github.com/ambv/black)
[](https://opensource.org/licenses/MIT)
[](https://github.com/jfcarter2358/calligraphy/actions/workflows/makefile.yml)
**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](https://jfcarter2358.notion.site/5081d4214297401db15a43e47a974521?v=9858c59c7ecd4eefa09bf75158c47448)
## License
Calligraphy is under the [MIT license](https://opensource.org/licenses/MIT).
## Contact
If you have any questions or concerns please reach out to me (John Carter) at [jfcarter2358@gmail.com](mailto:jfcarter2358@gmail.com)
Raw data
{
"_id": null,
"home_page": "https://github.com/jfcarter2358/calligraphy",
"name": "calligraphy-scripting",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "scripting,calligraphy",
"author": "John Carter",
"author_email": "jfcarter2358@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/72/7d/c781927f92d85ba83ef25b94db6bd5e6e5fce59c67a7a88a5a9663b581c0/calligraphy_scripting-1.1.4.tar.gz",
"platform": null,
"description": "# Calligraphy\n---\n[](https://github.com/ambv/black)\n[](https://opensource.org/licenses/MIT)\n[](https://github.com/jfcarter2358/calligraphy/actions/workflows/makefile.yml)\n\n\n**Shell scripting for the modern age**\n\nCalligraphy is a hybrid scripting language that allows you to mix Python and Bash code\nin the same file. This gives you the advantages of bash when working with other\nprocesses while also giving you the advantages of a modern language like Python.\n\nIt's a free software distributed under the MIT Licence unless\notherwise specified.\n\nDevelopment is hosted on GitHub: https://github.com/jfcarter2358/calligraphy/\n\nPull requests are amazing and most welcome.\n\n## Install\n\nCalligraphy can be simply installed by running\n\n```\npip install calligraphy-scripting\n```\n\nIf you want to install from a source distribution, extract the tarball and run\nthe following command (this requires poetry to be installed)\n\n```\npoetry install --no-dev\n```\n\n## Documentation\n\nThe documentation lives at https://calligraphy.readthedocs.io/.\n\n## Testing\n\nWe use `pytest` and `pytest-cov` for running the test suite. You should be able to install them with\n\n```\npip install pytest pytest-cov\n```\n\nor you can install calligraphy alongside those packages with\n\n```\npoetry install\n```\n\nTo run the test suite, you can do\n\n```\nmake test\n```\n\nThis will produce an html coverage report under the `htmlcov` directory.\n\n## Roadmap\n\nYou can find the Calligraphy roadmap [here](https://jfcarter2358.notion.site/5081d4214297401db15a43e47a974521?v=9858c59c7ecd4eefa09bf75158c47448)\n\n## License\n\nCalligraphy is under the [MIT license](https://opensource.org/licenses/MIT).\n\n## Contact\n\nIf you have any questions or concerns please reach out to me (John Carter) at [jfcarter2358@gmail.com](mailto:jfcarter2358@gmail.com)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A hybrid language for a modern approach to shell scripting",
"version": "1.1.4",
"project_urls": {
"Homepage": "https://github.com/jfcarter2358/calligraphy",
"Repository": "https://github.com/jfcarter2358/calligraphy"
},
"split_keywords": [
"scripting",
"calligraphy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fb78a420b315566d9407579765a0a69bd21546008444c08bd3d9ac429424cefb",
"md5": "e81072aba2ab970ea6dd7bdfd46cffe8",
"sha256": "834c01712d6d5cfdb63afa5d8ee510a43abf3957b6d36599ed44343729621d49"
},
"downloads": -1,
"filename": "calligraphy_scripting-1.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e81072aba2ab970ea6dd7bdfd46cffe8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 14170,
"upload_time": "2023-05-26T17:00:52",
"upload_time_iso_8601": "2023-05-26T17:00:52.065284Z",
"url": "https://files.pythonhosted.org/packages/fb/78/a420b315566d9407579765a0a69bd21546008444c08bd3d9ac429424cefb/calligraphy_scripting-1.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "727dc781927f92d85ba83ef25b94db6bd5e6e5fce59c67a7a88a5a9663b581c0",
"md5": "c274334a553b2f7508886d08b1ca47c8",
"sha256": "1d7d419334260e7399c9c692207a46c8b35fbafa8a538e6c476a5e027efdef42"
},
"downloads": -1,
"filename": "calligraphy_scripting-1.1.4.tar.gz",
"has_sig": false,
"md5_digest": "c274334a553b2f7508886d08b1ca47c8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 12415,
"upload_time": "2023-05-26T17:00:53",
"upload_time_iso_8601": "2023-05-26T17:00:53.724303Z",
"url": "https://files.pythonhosted.org/packages/72/7d/c781927f92d85ba83ef25b94db6bd5e6e5fce59c67a7a88a5a9663b581c0/calligraphy_scripting-1.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-26 17:00:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jfcarter2358",
"github_project": "calligraphy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "calligraphy-scripting"
}
JSON
