# frontmatter-cli
This is a very early WIP project. My goal is to make working with Frontmatter a little nicer from the command line. The API is going to change, and I plan on adding some other features to make editing Frontmatter easier too.
## Install
```shell
$ python -m pip install frontmatter-cli
```
## Usage
```shell
$ frontmatter-cli --help
Usage: frontmatter-cli [OPTIONS] [EXTRA_CONTEXT]... [INPUT] [OUTPUT]
Options:
--version Show the version and exit.
--help Show this message and exit.
Commands:
main*
## Echo'ing text as Frontmatter
$ echo "Hello World!" | frontmatter-cli --title="My New Blog Post" - -
---
title: My New Blog Post
---
Hello World!
```
## Contributing
PRs are welcome at <https://github.com/jefftriplett/frontmatter-cli>.
Linting should be verified by running `just lint`. There are currently no tests, so `just test` is expected to fail.
In addition to the development supporting packages that will be installed by `just`, you may need to install the following:
- [just](https://github.com/casey/just#installation)
- [pre-commit](https://pre-commit.com/) `pip install pre-commit`
## Contact / Social Media
Here are a few ways to keep up with me online. If you have a question about this project, please consider opening a GitHub Issue.
[](https://github.com/jefftriplett)
[](https://jefftriplett.com/)
[](https://twitter.com/webology)
[](https://hub.docker.com/u/jefftriplett/)
Raw data
{
"_id": null,
"home_page": "",
"name": "frontmatter-cli",
"maintainer": "",
"docs_url": null,
"requires_python": ">3.7",
"maintainer_email": "",
"keywords": "frontmatter,frontmatter-cli",
"author": "",
"author_email": "Jeff Triplett <jeff.triplett@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a3/05/5fe0573b46c59a2848f37152e26f59df848e2d343142dee469b100900d23/frontmatter-cli-2023.7.7.tar.gz",
"platform": null,
"description": "# frontmatter-cli\n\nThis is a very early WIP project. My goal is to make working with Frontmatter a little nicer from the command line. The API is going to change, and I plan on adding some other features to make editing Frontmatter easier too.\n\n## Install\n\n```shell\n$ python -m pip install frontmatter-cli\n```\n\n## Usage\n\n```shell\n$ frontmatter-cli --help\nUsage: frontmatter-cli [OPTIONS] [EXTRA_CONTEXT]... [INPUT] [OUTPUT]\n\nOptions:\n --version Show the version and exit.\n --help Show this message and exit.\n\nCommands:\n main*\n\n## Echo'ing text as Frontmatter\n$ echo \"Hello World!\" | frontmatter-cli --title=\"My New Blog Post\" - -\n---\ntitle: My New Blog Post\n---\n\nHello World!\n```\n\n## Contributing\n\nPRs are welcome at <https://github.com/jefftriplett/frontmatter-cli>.\n\nLinting should be verified by running `just lint`. There are currently no tests, so `just test` is expected to fail.\n\nIn addition to the development supporting packages that will be installed by `just`, you may need to install the following:\n\n- [just](https://github.com/casey/just#installation)\n- [pre-commit](https://pre-commit.com/) `pip install pre-commit`\n\n## Contact / Social Media\n\nHere are a few ways to keep up with me online. If you have a question about this project, please consider opening a GitHub Issue.\n\n[](https://github.com/jefftriplett)\n[](https://jefftriplett.com/)\n[](https://twitter.com/webology)\n[](https://hub.docker.com/u/jefftriplett/)\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Frontmatter CLI tool to make working with frontmatter easier.",
"version": "2023.7.7",
"project_urls": {
"Homepage": "https://github.com/jefftriplett/frontmatter-cli",
"Issues": "https://github.com/jefftriplett/frontmatter-cli/issues",
"Source": "https://github.com/jefftriplett/frontmatter-cli"
},
"split_keywords": [
"frontmatter",
"frontmatter-cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4ea52ee15d9f9cec26ac74c97eca54455d99fa1448fa299d9c7979672cc0b271",
"md5": "24657811826979099e8a9f2edbafde65",
"sha256": "1dda682885f894ada8ed0d941a6e483842167886591d6f98ddd4aa25ea3832b6"
},
"downloads": -1,
"filename": "frontmatter_cli-2023.7.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "24657811826979099e8a9f2edbafde65",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">3.7",
"size": 4725,
"upload_time": "2023-07-10T14:17:12",
"upload_time_iso_8601": "2023-07-10T14:17:12.158050Z",
"url": "https://files.pythonhosted.org/packages/4e/a5/2ee15d9f9cec26ac74c97eca54455d99fa1448fa299d9c7979672cc0b271/frontmatter_cli-2023.7.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a3055fe0573b46c59a2848f37152e26f59df848e2d343142dee469b100900d23",
"md5": "4384621aa9aba2365266a078d4a9c576",
"sha256": "75d5e401bb682fee2329519250763aacbc4f5118644eef280bf9d3c495149f1f"
},
"downloads": -1,
"filename": "frontmatter-cli-2023.7.7.tar.gz",
"has_sig": false,
"md5_digest": "4384621aa9aba2365266a078d4a9c576",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">3.7",
"size": 4913,
"upload_time": "2023-07-10T14:17:13",
"upload_time_iso_8601": "2023-07-10T14:17:13.382536Z",
"url": "https://files.pythonhosted.org/packages/a3/05/5fe0573b46c59a2848f37152e26f59df848e2d343142dee469b100900d23/frontmatter-cli-2023.7.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-10 14:17:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jefftriplett",
"github_project": "frontmatter-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "click",
"specs": [
[
"==",
"8.1.4"
]
]
},
{
"name": "click-default-group",
"specs": [
[
"==",
"1.2.2"
]
]
},
{
"name": "pydash",
"specs": [
[
"==",
"7.0.5"
]
]
},
{
"name": "python-frontmatter",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "pyyaml",
"specs": [
[
"==",
"6.0"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
"==",
"4.7.1"
]
]
}
],
"lcname": "frontmatter-cli"
}
JSON
